Soldat PolyWorks Manual

From Soldat Community Wiki
Revision as of 18:17, 21 April 2018 by Nosejj (talk | contribs) (Titles un-capitalized)
Jump to: navigation, search

This is the PolyWorks latest Help-file from Soldat PolyWorks GitHub


Controls

  • Scroll - Click and drag with the middle mouse button or hold space + left click.
  • Zoom - [Mouse wheel down/up] or [Ctrl+Plus]/[Ctrl+Minus] or [NUM+] and [NUM-] keys for zooming in and out.
  • Zoom Reset - Press the [NUM*] key to return to 100%. Press [Ctrl+0] to center the view and return to 100% zoom.


Tools

  • Transform - Click and drag to move current selection, or if nothing is selected, click and drag near a vertex to move it. Hold [Shift] for vertical/horizontal movement. Hold [Ctrl] to scale, [Ctrl+Shift] to scale proportionately. Hold [Alt] to rotate, [Alt+Shift] to rotate in 15° increments.
  • Create - Click to create polys using the current color. [Right click] to select the type of the poly to be created and to turn quad mode on or off. Hold [Shift] to constrain the angle to 15° increments relative to the last vertex placed. Hold [alt] for vertex selection. Hold [Ctrl] to move the current selection.
  • Vertex Selection - Click and drag to select vertices, or click on a poly near the vertex to select that vertex. Hold [Shift] to select additional vertices and [Alt] to deselect vertices. Hold [Ctrl] to move the current selection.
  • Poly Selection - Click in a poly or scenery to select it. Hold [Shift] to select additional polys or scenery and alt to deselect them. Hold [Ctrl] to move the current selection.
  • Vertex Color - Click and drag to color vertices. If there are vertices selected only those will be affected. Hold alt to get a color from a vertex or scenery. Hold [Ctrl] to move the current selection.
  • Poly Color - Click in a poly or scenery to color it. If there are vertices selected all of them will be affected. Hold alt to get a color from a vertex or scenery. Hold [Ctrl] to move the current selection.
  • Texture - Click and drag to change the texture coordinates of vertices. If there are vertices selected only those will be affected. Hold alt for vertex selection. Hold [Ctrl] to move the current selection.
  • Scenery - Click to place scenery. Hold shift to constrain the angle to 15° increments or scale proportionately. Right click to show the scenery lists. Hold alt for vertex selection. Hold [Ctrl] to move the current selection.
  • WayPoints - Click to place WayPoints. Hold shift and click to connect WayPoints. Right click to select the movement type of the WayPoints to be placed. Hold alt for vertex selection. Hold [Ctrl] to move the current selection.
  • Objects - Click to place spawn points or colliders. Right click to select the type of object to be placed. Hold alt for vertex selection. Hold [Ctrl] to move the current selection.
  • Color Picker - Click to get a color from a vertex or scenery. Hold shift to get a color directly from the screen. Hold alt to get a lit vertex color. Hold [Ctrl] to move the current selection.
  • Sketch - Click and drag to sketch. Hold shift to place lines. Hold alt to erase the sketch lines. Hold [Ctrl] to move the sketch lines.
  • Lights - Click to place a light source. Hold alt for vertex selection. Hold [Ctrl] to move the current selection.
  • Depth Map - Click and drag to edit the depth map (Z-coordinates). If there are vertices selected only those will be affected. Hold alt to get a depth color from a vertex. Hold [Ctrl] to move the current selection.


File Menu

  • New [Ctrl+N] - Creates a new map.
  • Open [Ctrl+O] - Opens a saved map.
  • Open Compiled [Ctrl+Shift+O] - Opens a compiled map.
  • Open Recent - Opens a recent file.
  • Save [Ctrl+S] - Saves the map to the saved maps directory.
  • SAVE AS [Ctrl+Shift+S] - Saves the map to the saved maps directory using a new file name.
  • COMPILE TO PMS - Compiles and saves the map to the Soldat maps directory.
  • COMPILE TO PMS AS [F9] - Compiles and saves the map to the Soldat maps directory using a new file name.
  • EXPORT - Saves the selected part of the map to a prefab file.
  • IMPORT - Loads a prefab file into the map.
  • RUN SOLDAT [F8] Starts Soldat with the last compiled map.
  • EXIT [Alt+F4] Exits the program.


Edit Menu

  • UNDO [Ctrl+z] Undoes the last operation performed.
  • REDO [Ctrl+y] Redoes the last undone operation.
  • DUPLICATE [Ctrl+d] Duplicates the current selection and offsets by 32 pixels.
  • COPY [Ctrl+c]Copies the current selection.
  • PASTE [Ctrl+v]Pastes the most recently copied selection.
  • CLEAR [delete] - Deletes everything in the current selection.
  • SELECT ALL [Ctrl+a] - Selects all polys, scenery, spawn points, colliders, WayPoints, and lights.
  • INVERT SELECTION [Ctrl+i] - Selects everything currently not selected.
  • DESELECT [escape] - Deselects current selection.
  • SELECT BY Color [Ctrl+b] - Selects all vertices of the current color.
  • ARRANGE
    • BRING TO FRONT [home] - Brings selected polys and scenery in front of the rest.
    • BRING FORWARD [page up] - Brings selected polys and scenery forward.
    • SEND BACKWARD [page down] - Sends selected polys and scenery backward.
    • SEND TO BACK [end] - Sends selected polys and scenery behind the rest.
  • SPLIT AT VERTEX [Ctrl+l] - Splits polys in half from the selected vertex to the midpoint of the opposite edge.
  • JOIN VERTICES [Ctrl+J] - Brings all selected vertices to the coordinates of the first vertex selected.
  • CREATE WITH SELECTED [Ctrl+E] - Creates a new poly using the 3 vertices selected.
  • TRANSFORM
    • ROTATE 180° - Rotates all selected vertices and scenery by a half-turn.
    • ROTATE 90° CW - Rotates all selected vertices and scenery clockwise by a half-turn.
    • ROTATE 90° CCW - Rotates all selected vertices and scenery counterclockwise by a half turn.
    • FLIP HORIZONTAL - Flips all selected vertices and scenery horizontally, along the vertical axis.
    • FLIP VERTICAL - Flips all selected vertices and scenery vertically, along the horizontal axis.
  • SEVER CONNECTIONS [Backspace] - Severs connections between selected WayPoints.
  • CLEAR SKETCH - Removes all lines made by the sketch tool.
  • MAP SETTINGS [Ctrl+M] - Shows the Map Settings window.
  • PREFERENCES [Ctrl+P] - Shows the Preferences window.


Texture Menu

  • FIX TEXTURE [Ctrl+F] - Sets the texture coordinates of all selected vertices depending on the position of each vertex.
  • UNTEXTURE [Ctrl+U] - Sets the texture coordinates of all selected vertices to the same value.
  • TRANSFORM TEXTURE
    • ROTATE 180° - Rotates the selected vertices' texture by a half-turn.
    • ROTATE 90° CW - Rotates the selected vertices' texture clockwise by a half-turn.
    • ROTATE 90° CCW - Rotates the selected vertices' texture counterclockwise by a half turn.
    • FLIP HORIZONTAL - Flips the selected vertices' texture horizontally, along the vertical axis.
    • FLIP VERTICAL - Flips the selected vertices' texture vertically, along the horizontal axis.
  • AVERAGE VERTEX COLORS [Ctrl+G] - Averages the colors of vertices that have the same position.
  • APPLY LIGHT TO VERTICES - Applies lights to vertex colors and hides the light sources.
  • FIXED TEXTURE - Turns fixed texture on and off. When fixed texture is on vertices do not keep their texture coordinates when moved.
  • USER DEFINED X - For use with quad function. Quads are created/manipulated with the horizontal texture coordinates specified in the Texture panel in the Properties window.
  • USER DEFINED Y - For use with quad function. Quads are created/manipulated with the vertical texture coordinates specified in the Texture panel in the Properties window.


View Menu

  • ZOOM IN [Ctrl+plus, num+] - Zooms in to twice the current zoom level.
  • ZOOM OUT [Ctrl+minus, num-] - Zooms out to half the current zoom level.
  • FIT ON SCREEN - Changes the zoom level and offset so that the entire map is visible in the PolyWorks window.
  • ACTUAL SIZE - Changes the zoom level to show the same screen area that would be visible in Soldat, depending on the width of the PolyWorks window.
  • RESET VIEW - Resets the zoom level and screen coordinates to the starting point.
  • SHOW GRID [Ctrl+'] - Turns the grid on and off.
  • SNAP TO GRID - Turns snapping to grid on and off. When snap to grid is on, vertices and scenery snap to the grid when created or moved.
  • SNAP TO VERTICES - Turns snapping to vertices on and off. When snap to vertices is on vertices snap to nearby vertices when created or moved.
  • BLEND WIREFRAME - Turns wireframe blending on and off.
  • BLEND POLYS - Turns poly blending on and off.
  • SHOW SCENERY LAYERS
    • BACK - Show sceneries in the back layer.
    • MIDDLE - Show sceneries in the middle layer.
    • FRONT - Show sceneries in the front layer..
  • REFRESH [F5] - Resizes the background to fit the map.


Palette Window

  • CURRENT COLOR - Click the color box to show the Color Picker window, or input the RGB components.
  • VERTEX COLOR MODE
    • PRECISION - Only color once vertex at a time.
    • NORMAL - Click and drag to color vertices.
    • DYNAMIC - The effect is applied as the mouse moves.
  • RADIUS - Controls the radius of the vertex color tool and collider size.
  • OPACITY - Controls the opacity of the vertex color tool and scenery alpha.
  • BLEND MODE
    • NORMAL - The current colour is applied.
    • MULTIPLY - Multiplies the vertex colour with the current colour. The darker the colour is, the more effect it has. Blending with white produces no change.
    • SCREEN - The opposite of Multiply. The lighter the colour is, the more effect is has. Blending with black produces no change.
    • DARKEN - Affects vertices that are lighter than the current colour, and darkens them.
    • LIGHTEN - Affects vertices that are darker than the current colour, and lightens them.
    • DIFFERENCE - Takes the difference between the vertex colour and the current colour. Blending with white inverts the base color values, blending with black produces no change.
  • PALETTE - Contains 72 colors. Right click to add a color to the palette.
  • PALETTE MENU
    • LOAD PALETTE - Loads palette colors from a file.
    • SAVE PALETTE - Saves the current palette colors in a file.
    • CLEAR - Sets all palette colors to black.


Scenery Window

  • LEVEL
    • BACK - Sceneries are placed behind everything.
    • MIDDLE - Sceneries are placed behind polys, in front of the player.
    • FRONT - Sceneries are placed in front of everything.
  • ROTATE - Rotate scenery when creating.
  • SCALE - Scale scenery when creating.
  • SCENERY MENU
    • CLEAR UNUSED - Deletes unused scenery textures and removes them from the current scenery list.
    • RELOAD SCENERY LIST - Reloads the Master List.
    • REFRESH SCENERY - Reloads the texture for the scenery in the scenery list.


Properties Window

  • POLYGON PROPERTIES - Sets the poly type or texture coordinates of all selected vertices.
  • SCENERY PROPERTIES - Sets the scaling, level, opacity or rotation of all selected scenery.
  • TRANSFORM - Scales or rotates the current selection by the value input.
  • TEXTURE SETTINGS - Sets texture dimensions used when fixed texture is applied. Define the horizontal and vertical coordinates used by the quad function.
  • LIGHT PROPERTIES - Sets the colour and z-coordinate of all selected lights.
  • MAP INFO - Shows the current number of polys, scenery, spawn points, colliders, WayPoints, and WayPoint connections.


WayPoints Window

  • LEFT/RIGHT/UP/DOWN/FLY - Sets the type of movement that the bot has to do to get to this WayPoint, for all selected WayPoints.
  • SPECIAL - Sets a special WayPoint function used in places where bots must stop and defend the base, for all selected WayPoints.
  • PATH 1/PATH 2 - Sets the path number of all selected WayPoints.
  • SHOW - Shows WayPoints and connections for both paths or a single path.