diff --git a/docs/commandline.html b/docs/commandline.html index b33405eb..6a725889 100644 --- a/docs/commandline.html +++ b/docs/commandline.html @@ -81,55 +81,109 @@ Also, under the "server" tab of the AssaultCube launcher is an "Advanced options" bar. You can type all the switches you need for the server into there.

-

- Client

+

Client

- -wX sets desired screen width to X, default is - -w640 -
- -hY sets desired screen height to Y, default is - -h480 -
- -t runs windowed -

-

- -zN sets the z-buffer precision to N bits. This should - be at least 24 or you may experience depth problems. -

-

- -bN sets the screen to N bits per pixel -

-

- -zN sets the z-buffer precision to N bits. This should - be at least 24 or you may experience depth problems. -

-

- -sN sets the stencil buffer precision to N bits. This - should be 8 to enable shadowing effects, or 0 to turn it off (the default). -

-

- -aN sets FSAA (Full Scene AntiAliasing) to N samples, - i.e. -a4 is 4xFSAA -

-

- -vN enables vsync if N is greater 0 -

-

- --init executes the init script before starting the graphics - and sound subsystems (recommended). By default the script config/init.cfg - is used, but you can override this setting by using --init=yourfile.cfg -

-

- --mod=PATH adds the specified path to the list of directories - that are searched when loading resources. Use this to add your own mods in a clean - way without placing files into the main directory. -

-

- --home=PATH specifies the home directory for the user - profile, AssaultCube will write custom settings and files to this directory (recommended). -

-

- Server

+ These variables are specifically for the clients launcher, not the server. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ -wX + + Sets desired screen width to X, default is -w1024. +
+ -hY + + Sets desired screen height to Y, default is -h768. +
+ -t + + Runs AssaultCube in windowed mode (fullscreen off). +
+ -zN + + Sets the z-buffer precision to N bits. This should be at least 24 + or you may experience depth problems. +
+ -bN + + Sets the screen to N bits per pixel +
+ -sN + + Sets the stencil buffer precision to N bits. This should be 8 to enable + shadowing effects, or 0 to turn it off (the default). +
+ -aN + + Sets the FSAA (Full Scene AntiAliasing) to N samples (i.e. -a4 is 4xFSAA). +
+ -vN + + Enables vsync if N is greater 0 +
+ --init + + Executes the init script before starting the graphics + and sound subsystems (recommended). By default the script config/init.cfg + is used, but you can override this setting by using --init=yourfile.cfg +
+ --mod=PATH + + Adds the specified path to the list of directories + that are searched when loading resources. Use this to add your own mods in a clean + way without placing files into the main directory. +
+ --home=PATH + + Specifies the home directory for the user profile, AssaultCube will write + custom settings and files to this directory (recommended). +
+ +

Server

-d This starts an AssaultCube client binary as a dedicatated server. The default is a non-dedicated server with only a single client in graphical mode. See diff --git a/docs/mods.html b/docs/mods.html index 1b4fce71..5d4aab51 100644 --- a/docs/mods.html +++ b/docs/mods.html @@ -1,36 +1,60 @@ -Custom mods - - - + Custom mods + + + -

- -
-

- AssaultCube: Custom mods

-
-
-

Custom mods

-

- - -AssaultCube allows 3rd party developers to extend the game. It allows to use the existing assaultcube data for own modifications. When AssaultCube loads a file, it looks into several directories to look for the file to load. This list of directories can be extended using the --mod argument, which lets you add custom directories. Using this feature it is possible to supply a mod directory that contains customized data (textures, etc), so once AssaultCube loads data, it loads it from the mod directory instead of the main directory. -Assume you want to create a mod that provides a customized hud-gun, you would create a mod directory: -AssaultCube\mods\MyMod1\ -Where AssaultCube is your main directory (%programfiles%\AssaultCube_v1.0). Inside this mod directory you would then add your customized hudgun: -AssaultCube\mods\MyMod1\packages\models\hudguns\assaultrifle.md3 -Now to make AC aware of this mod you need to start it with the argument --mod=mods\MyMod1, now every time AC wants to load packages\models\hudguns\assaultrifle.md3 it will look in your mod directory first, therefore loading your custom version instead of the original version. - -

-
- -
+
+ +
+

AssaultCube: Custom mods

+
+
+

Custom mods

+

+ AssaultCube allows 3rd party developers to extend the game by using the existing AssaultCube + engine/data for their own modifications (so long as you keep within the license agreements for the particular media + which you are modifying), without the need to overwrite existing data (i.e. content replacement). + Another advantage is that it allows you to add mods cleanly without placing the files inside the + main AssaultCube directory. +

+

+ When AssaultCube loads files for the game, it looks into several directories to find the file to load. + This list of directories can be extended using the --mod argument, + which lets you add custom directories. + Using this feature, it is possible to supply a mod directory that contains customized data (textures, etc), + so once AssaultCube loads data, it loads it from that mod directory instead of the main directory. +

+

Example:

+

+ Assume you want to create a mod that provides a customized hud-gun, you would create a mod directory: +

+
    +
  1. + Create a "mod" directory: AssaultCube\mods\MyMod1\ +
    ...where AssaultCube is your main directory (%programfiles%\AssaultCube_v1.0). +
  2. +
  3. + Inside your mod directory, add your customized hudgun: AssaultCube\mods\MyMod1\packages\models\hudguns\assaultrifle.md3 +
  4. +
  5. + Now to make AssaultCube aware of this mod you'll need to start AssaultCube with the argument --mod=mods\MyMod1 +
    ...now every time AssaultCube wants to load packages\models\hudguns\assaultrifle.md3 + it will look in your mod directory first, therefore loading your custom version instead of the original version. +
  6. +
+

+ To start AssaultCube with the mod argument, you will most likely need to modify the AssaultCube launcher. + See command line on how to do this... +

+
+ +
diff --git a/docs/styles/ac.css b/docs/styles/ac.css index 98869e96..eb083edb 100644 --- a/docs/styles/ac.css +++ b/docs/styles/ac.css @@ -143,3 +143,13 @@ span.code margin: 0; padding: 0; } + +span.codecommandline +{ + font-family: Courier New, Courier, monospace, Sans-Serif; + margin: 0; + padding: 0; + font-weight: bold; + font-size: 1.3em; + text-align: center; +}