From 5d546a41dd410eab061ecaeaa6235d5d2be46531 Mon Sep 17 00:00:00 2001 From: RandumKiwi Date: Wed, 20 Aug 2008 09:42:04 +0000 Subject: [PATCH] Map editing documentation: Cfg files - Complete. git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@2345 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- config/menus_bot.cfg | 2 +- docs/mapediting5.xml | 81 ++++++++++++++++++++++++++++++++------------ 2 files changed, 61 insertions(+), 22 deletions(-) diff --git a/config/menus_bot.cfg b/config/menus_bot.cfg index 1ef1a028..a810a0c5 100644 --- a/config/menus_bot.cfg +++ b/config/menus_bot.cfg @@ -83,7 +83,7 @@ menuitem "Paths..." [ showmenu "Paths" ] menuitem "Other operations..." [ showmenu "Other bot operations" ] menuitem """" menuitem "Flood map with waypoints" "wpflood" -menuitem "Save bot waypoints" [ wpsave; echo "Waypoints saved in ...bot\waypoints" ] +menuitem "Save bot waypoints" "wpsave" newmenu Waypoints diff --git a/docs/mapediting5.xml b/docs/mapediting5.xml index f38f59e0..1c71efbc 100644 --- a/docs/mapediting5.xml +++ b/docs/mapediting5.xml @@ -31,13 +31,13 @@ Custom skymaps
  • - Custom fog distances and colours + Custom fog distances and colours
  • - Ambient sounds + Ambient sounds
  • - Using the "loadnotexture" command + Using the "loadnotexture" command
  • The first step to using any of the above in your map is copying the @@ -93,16 +93,16 @@ not get messed up!

    - To add a new texture, use this format: texture 0 "./folder/file.jpg" on a single line. - Replace "folder" with the folder name and "file" with the name of the image. Be sure to put all your content + To add a new texture, use this format: texture 0 "./raboof/foobar.jpg" on a single line. + Replace "raboof" with the folder name and "foobar" with the name of the image. Be sure to put all your content inside a seperate folder so that it does not get mixed in with everyone elses content.

    Note: All textures MUST be placed inside /packages/textures/.

    - Warning: 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. + Warning: There is a texture command in the default config that has the comment "dummy" after it. + Do not touch or remove this texture command as it will break some configurations.

    Warning: There can only be maximum of 256 textures in your map! Any more won't be loaded. @@ -121,7 +121,7 @@ using the last maps mapmodel numbering.

    - To add a mapmodel, use this format: mapmodel X Y Z 0"model-folder" on a single line. + To add a mapmodel, use this format: mapmodel X Y Z 0 "model-folder" 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).|

    @@ -201,19 +201,58 @@

    Note: The skymap is hardcoded as the first texture, in the texture list.

    + +

    Custom fog distances and colours

    +

    + Fog is used in AssaultCube to help improve performance on some computers. However, it's not completely neccesary + and as long as it doesn't make your map too laggy and will improve your maps look, then you can make the fog appear + at different distances and colours to add to your maps appearance. +

    +

    + To change the distance at which fog will appear, add this command to a single line in your config file: fog X
    + Replace X with the distance at which you want the fog to start appearing (maximum of 1024, default is 160). +

    +

    + To change the colour of the fog, add this command to a single line in your config file: fogcolour X
    + Replace X with the appropriate hexadecimal colour code. +

    + +

    Ambient sounds

    +

    + To enable custom ambient sounds in your map, all sound files must be either .wav or .ogg format. + All files need to be put in the /packages/audio/sounds folder. Be + sure to put your sound files inside your own individual folder. +

    +

    + To add sounds to the config file, add this command to a single line: mapsound "raboof/foobar.wav" X Y
    + Replace "raboof" with your sounds folder name and replace "foobar.wav" with your sound files name. + Replace X with the volume that the sound should play at (the default is 0, so you will definitely have to + change this value for it to work). You can play a maximum volume of 255. Replace Y with how many times + the sound should be allowed to play at once (for example, if there are several of the same sound in one area, + this would define how many of them should play at once, as too many might be a bit of an overkill). Using the + value "-1" will make it play an unlimited amount of times. +

    +

    + The order that you place the mapsound commands in the config file, determines their slot number (i.e. the first one + in the list would be slot 0, the second mapsound command would be slot 1). +

    - - - - - - +

    Using the "loadnotexture" command

    +

    + Due to AssaultCube's light-weight approach to gaming, custom content from new custom maps are not downloaded + automatically to a players computer system, as content size can be quite big, which is just not appropriate for + 56k modem users and users with restricted bandwidth. Because of this, users will have to go and download + the content manually. Since the config and map files are downloaded (due to their small sizes), there is a + command + you can use in the config which will automatically load all textures that aren't found to be a specific already + existing texture. +

    +

    + When using this command, the texture that you want to load must be found within the + /packages/textures/ folder. To use this feature, add this command + to a single line: loadnotexture "raboof/foobar.jpg". Replace "raboof" with the folder name and + "foobar" with the name of the image. You will need to have commented-out or deleted the pre-existing "loadnotexture" + command. +