Map editing documentation -> Cfg files

git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@2343 e016b1c5-ed68-44aa-a2f7-31cac88cffde

docs/mapediting5.xml

@@ -23,15 +23,15 @@
          <a href="#models">Custom mapmodels</a>
          <ol>
            <li>
-             Custom "nothing" clips
+             <a href="#clips">Custom "nothing" clips</a>
            </li>
          </ol>
        </li>
        <li>
-         Custom skymaps
+         <a href="#skymap">Custom skymaps</a>
        </li>
        <li>
-         Custom watercolouring or water textures
+         <a href="#water">Custom watercolouring or water textures</a>
        </li>
        <li>
          Custom fog distances and colours
@@ -76,13 +76,15 @@
    </p>
    <p>
      Preferably, textures should be 256x256 pixels. But, each cube in AssaultCube measures 32x32 pixels, so, as
-     long as the image is a multiple of 32 pixels and doesn't take up too much space, the texture should work fine.
+     long as the image is a multiple of 32 pixels and doesn't take up too much space, the texture should work fine. If 
+     the image is not a multiple of 32 pixels, it will not fit on the cube properly and will be unaligned and look strange.
      When creating/using custom textures, remember that too much detail/size could make that texture in the map too laggy!
    </p>
    <p>
      You will notice in the default config a command "texturereset". This ensures that all the textures
      in your map are always shown in the correct order, so make sure you leave this where it is! Textures are in a numbered
-     list and the "texturereset" command resets that list. The first and second textures in the list are hardcoded as the 
+     list and the "texturereset" command resets that list, so that your map is not using the last maps texture list. 
+     The first and second textures in the list are hardcoded as the 
      skymap and water textures.
    </p> 
    <p>
@@ -101,6 +103,10 @@
    <p>
      <b>Note:</b> All textures <b>MUST</b> be placed inside <a href="../packages/textures">/packages/textures/</a>.
    </p>
+   <p>
+     <b>Warning:</b> There is a texture command above the water textures in the default config that has the comment "dummy". 
+     Do not touch or remove this as it will break some configurations.
+   </p>
    <p>
      <b>Warning:</b> There can only be maximum of 256 textures in your map! Any more won't be loaded.
    </p>
@@ -112,18 +118,116 @@
      to create a seperate folder for your mapmodel. Inside it, you will need to place the model with the name "tris" 
      (and the .md2 or .md3 extension). You will also need to place the skin in the same folder with the name "skin.jpg".
    </p>
+   <p>
+     You will see a command called "mapmodelreset". All mapmodels can be placed below this. The mapmodelreset command 
+     ensures that the mapmodels in the numbered list are reset, meaning that everything appears as it should, rather than 
+     using the last maps mapmodel numbering.
+   </p>
+   <p>
+     To add a mapmodel, use this format: <b>mapmodel X Y Z 0"model-folder"</b> on a single line.
+     Replace "model-folder" with the name of the folder that the mapmodel is in (for example, if the file is
+     in /packages/models/mapmodels/tree, you would put "tree" there).|
+   </p>
+   <p>
+     Mapmodels use an invisible force to make them feel solid (i.e. you colide against them, rather than falling through
+     them). This invisible force is called a "clip". 
+   <ul>
+     <li>
+       <b>W:</b> Defines the total width/length (in radius) that the invisible force (clip) should take up 
+       from the centre of the mapmodel.
+     </li>
+     <li>
+       <b>X:</b> Defines the total height that the invisible force (clip) should take up.
+     </li>
+     <li>
+       <b>Y:</b> Defines the initial height off the ground you would like the mapmodel to appear.
+     </li>
+     <li>
+       <b>0:</b> The last zero on the mapmodels clipping should be left alone. Do not touch this value and leave it assigned at zero. Changing or 
+       removing this number will break the mapmodel command.
+     </li>
+   </ul>   
+   </p>
+   <p>
+     <b>Note:</b> The mapmodel number is defined by where the mapmodel is placed inside the mapmodel list, i.e. the 21st
+     mapmodel command will be the 21st mapmodel
+   </p>
+   <p>
+     <b>Tip:</b> If you define the mapmodel to have 0 clipping of the width/length but give it a height 
+     clipping (for example, a clipping of 8 high)
+     then that model will actually take up the width/length of 1 single cube with the height you defined
+     (if you define both to be 0, then it won't be clipped)
+   </p>
+   
+   <h3 id="#clips">Custom "nothing" clips</h3>
+   <p>
+     <a href="mapediting3.xml#clips">Nothing clips</a> can be used to block off areas that you don't want to 
+     be accessed by players, see this <a href="mapediting3.xml#clips">link</a> for more details. To create a customised
+     nothing clip, do it how you would normally create a mapmodel but use the word "nothing" where the folder name should
+     be. Choose your own customised clip (invisible force that you collide against) as you would normally (i.e. define
+     the clip width/length and height).
+   </p>
+   
+   <h2 id="skymap">Custom skymaps</h2>
+   <p>
+     All skymaps should be placed in their own individual folder inside 
+     <a href="../packages/textures/skymaps/">packages/textures/skymaps/</a>. <br />
+     Six pieces make up a skymap and should be named as below (replace "foobar" with the name of the skymap):
+     <ul>
+       <li>
+         <b>foobar_bk.jpg</b> - For the back part of the skymap.
+       </li> 	
+       <li>
+         <b>foobar_dn.jpg</b> - For the bottom part of the skymap.
+       </li> 	
+       <li>
+         <b>foobar_ft.jpg</b> - For the front part of the skymap.
+       </li> 	
+       <li>
+         <b>foobar_lf.jpg</b> - For the left part of the skymap.
+       </li> 	
+       <li>
+         <b>foobar_rt.jpg</b> - For the right part of the skymap.
+       </li> 	
+       <li>
+         <b>foobar_up.jpg</b> - For the top part of the skymap.
+       </li>
+     </ul>
+     Look for the part of the config with the commands "loadsky". Delete or "comment out" the current skymap
+     commands there so they don't conflict with your skymap. Then, on a single line, use this format to add your skymap:
+     <b>loadsky "textures/skymaps/FOLDER/SKYMAP-NAME"</b>. Replace "folder" with the folder name you used, and "skymap-name"
+     with the skymaps filename (i.e. foobar). 
+   </p>
+   <p>
+     <b>Note:</b> There are a selection of skymaps already available for you to use if needed. Just uncomment the one you want (comment the others).
+   </p>
+   <p>
+     <b>Note:</b> The skymap is hardcoded as the first texture, in the texture list.
+   </p>
+   
+   <h2 id="water">Custom watercolouring or water textures</h2>
+   <p>
+     Water colouring is very simple. Add this command to a line in your config file: <b>watercolour R G B</b>. Replace
+     <b>R</b> with the red colour for the water, <b>G</b> with the green colour for the water and <b>B</b> with the blue
+     colour for the water to choose your colouring mix. When using this command, ensure that you create a value for each
+     colour (even if the value is just "1"), otherwise, the command may not work correctly
+   </p>
+
+     
+   
+
 
 <!-- 
-
 TO DO: 
-
+	
 * loadnotexture 
-* loadsky + Adv of the different parts of a skybox (1st texture in list)
-* mapmodelreset + mapmodel + clips/clipping
 * fog + fogcolour
 * mapsound
 * watercolour + watertexture (2nd texture in list)
  - Ask driAn about dummy texture..
+ - Ask/check what the "Z" in mapmodels is for...
+ - Ask why watercolour needs to be in cfg.
+
 
 -->