diff --git a/docs/README.xml b/docs/README.xml index eeef570a..afbb998c 100644 --- a/docs/README.xml +++ b/docs/README.xml @@ -81,11 +81,14 @@
AssaultCube offers 7 different multi-player game modes, 3 single-player game modes and 1 mode for co-operative map editing. - Information about co-operative editing can be found in map editing. + Information about co-operative editing can be found in Map editing: Beginners.
diff --git a/docs/mapeditingbegin.xml b/docs/mapeditingbegin.xml new file mode 100644 index 00000000..1e300c4d --- /dev/null +++ b/docs/mapeditingbegin.xml @@ -0,0 +1,28 @@ + + + + + +
+ Co-operative map editing lets you build and modify maps with others easily. This mode allows you to edit maps online with other players + who could help speed up repetitive or boring tasks, bring in fresh ideas or spot errors you may have missed. +
++ To start co-operative map editing, when in a server, type: /mode 1 and then type: /map and then your mapnames name and press ENTER. + You will have to of made a "newmap" previous to entering the server to be able to co-op edit it. +
++ You will then need to send the map. You can do this by typing: /sendmap and then your mapnames name and press ENTER. Note: Custom + materials can't be sent, they will have to be downloaded another way if you are using them. If you are using a custom "cfg" file, it will automatically + be sent with the map, if there is a cfg file present. +
++ Note: Some useful editing commands can't be used in co-op editing, such as: copy, paste, slope, arch, undo, etc. +
+ + diff --git a/docs/mapeditingintro.xml b/docs/mapeditingintro.xml new file mode 100644 index 00000000..d941e4f8 --- /dev/null +++ b/docs/mapeditingintro.xml @@ -0,0 +1,432 @@ + + + + + ++ To begin map editing, while in AssaultCube, press the letter E which toggles editmode. AssaultCubes map editor is built into the client, + so its easy to learn and you don't need to download any special tools to get started. +
+
+ In editmode, you can fly around in any direction you
+ like and you can even go through walls.
This is to make map-editing easier...
+
![]() |
+
+ The "cube grid" +
+ This will be shown as a white grid of squares drawn where ever you point.
+ |
+
![]() |
+
+ Heightfield cubes +
+ These are the light green cubes in the grid. |
+
![]() |
+
+ Entity sparkles + + These are shown as blue sparkly things. They are known as "entities", which will be explained later here. + + |
+
![]() |
+
+ Cube selector +
+ This appears as a small white box with a red dot in the corner. It will appear in the middle of the screen and you can use it to select
+ geometery, a bit like a crosshair. |
+
![]() |
+
+ "Nearest entity" text + + This is the white writing along the bottom. It will tell you the locaton of the closest entity and its properties, but you don't need + to worry about how to use that just yet. + + |
+
+ To get a feel for editmode, press E and float around. Try clicking and dragging the small white box at your crosshair over + some cubes (you will see a red box over what you are selecting). This is how you select geometery. +
+ ++ Below are the controls that get used in map-editing, you will use most of these controls when creating a map, so it's good to learn them. +
+| + Control + | ++ Function + | +
| + [ + | ++ Moves cubes in the floor downwards. + | +
| + ] + | ++ Moves cubes in the floor upwards. + | +
| + O + | ++ Moves cubes in the ceiling downwards. + | +
| + P + | ++ Moves cubes in the ceiling upwards. + | +
| + F + | ++ Makes selected cubes a solid. + | +
| + G + | ++ Makes selected cubes a space/non-heightfield. + | +
| + K + | ++ Makes selected cubes a corner. + | +
| + C + | ++ Copy selected cubes. + | +
| + V + | +
+ Pastes copied cubes. Note: It pastes from the upper corner of the red dot. + |
+
| + U + | ++ Undoes the last action (only applies to geometery). + | +
| + , + | ++ Equalize the floor. + | +
| + . + | ++ Equalize the ceiling. + | +
| + H + | ++ Makes the floor a heightfield. + | +
| + I + | ++ Makes the ceiling a heightfield. + | +
| + 9 + | ++ Manipulates the corner of a cube where the red dot is positioned upwards. + Works only if the cube is a heightfield. + | +
| + 8 + | ++ Manipulates the corner of a cube where the red dot is positioned downwards. + Works only if the cube is a heightfield. + | +
| + Control + | ++ Function + | +
| + Home + | ++ Browses forward through wall textures. + | +
| + End + | ++ Browses backward through wall textures. + | +
| + 7 (on the keypad) + | ++ Browses forward through upper-wall textures. + | +
| + 4 (on the keypad) + | ++ Browses backward through upper-wall textures. + | +
| + Insert + | ++ Browses forward through floor textures. + | +
| + Delete + | ++ Browses backward through floor textures. + | +
| + PageUp + | ++ Browses forward through ceiling textures. + | +
| + PageDown + | ++ Browses backward through ceiling textures. + | +
| + Control + | ++ Function + | +
| + Left-click + | ++ Allows you to select cubes. + | +
| + Right-click + | ++ Show the editing menu. + | +
| + Scrolling + | ++ Scrolling will move cubes up/down, depending on the direction you look. + | +
| + Hold Q and scroll + | ++ This will manipulate the corner of a cube where the red dot is positioned up/down. + Works only if the cube is a heightfield. + | +
| + Hold Z and scroll + | ++ Scrolls forward/backwards through textures on the floor/ceiling, depending on the direction you look. + | +
| + Hold X and scroll + | ++ Scrolls forward/backwards through textures on the wall/upper-wall, depending on the direction you look. + | +
| + Control + | ++ Function + | +
| + E + | ++ Toggle edit mode. + | +
| + Backspace + | ++ Delete entity. + | +
| + L + | ++ Shows the lighting menu. + | +
| + F5 + | ++ Toggle ocullsion on/off. + | +
| + F6 + | ++ Toggle showmip on/off. + | +
+ If you would like to start creating a new map, type: /newmap and then the size you would like (7 is the sensible default) and + then press ENTER. If you made your mapsize too small, you can easily make it double in size, simply by typing /mapenlarge. +
++ You can save your map at any time by typing: /savemap and then the name you would like it saved as. The map gets + saved in the packages/maps directory. Save your map often, to avoid the frustration of losing all of your work if something goes wrong. +
++ Note: Make sure when you start a map, to use the /newmap command, rather than editing an existing map, otherwise your map may get saved + a bit strangely. Also note: you cannot put spaces or any illegal characters in the name you save it as. +
++ To load your map, type /map and the file name you chose for your map. If you have not placed lighting in your map yet, your map will turn up dark. + To temporarily fix this problem, type: /fullbright 1 - this will fill your whole map with light. The fullbright command only works in edit + mode and is not a permanent fix. To remove fullbright mode, reload the map, or type: /recalc. + Note: These commands can be found in the lighting menu (press L). +
+ + + diff --git a/docs/pics/editmode-entity.jpg b/docs/pics/editmode-entity.jpg new file mode 100644 index 00000000..2ac31e1d Binary files /dev/null and b/docs/pics/editmode-entity.jpg differ diff --git a/docs/pics/editmode-grid.jpg b/docs/pics/editmode-grid.jpg new file mode 100644 index 00000000..2ac31e1d Binary files /dev/null and b/docs/pics/editmode-grid.jpg differ diff --git a/docs/pics/editmode-heightfield.jpg b/docs/pics/editmode-heightfield.jpg new file mode 100644 index 00000000..2ac31e1d Binary files /dev/null and b/docs/pics/editmode-heightfield.jpg differ diff --git a/docs/pics/editmode-nearestent.jpg b/docs/pics/editmode-nearestent.jpg new file mode 100644 index 00000000..2ac31e1d Binary files /dev/null and b/docs/pics/editmode-nearestent.jpg differ diff --git a/docs/pics/editmode-selector.jpg b/docs/pics/editmode-selector.jpg new file mode 100644 index 00000000..2ac31e1d Binary files /dev/null and b/docs/pics/editmode-selector.jpg differ