diff --git a/docs/commandline.html b/docs/commandline.html index 6a725889..97333aa4 100644 --- a/docs/commandline.html +++ b/docs/commandline.html @@ -20,70 +20,104 @@

Command-line arguments

-

- About -

- When launching AssaultCube, you need to use a small script file, irrespective of - operating system. These script files can be modified with "switches" to allow different - settings to occur on startup. Note: Some of these options can be changed in-game + When launching AssaultCube, irrespective of operating system, a small script is used. + These script files can be modified with "switches" to allow different + settings to occur on startup. +
Note: Some of these options can be changed in-game through the menus without the need to manually edit the script file.

+

Contents:

+

- How to edit the AssaultCube launcher + HowTo: Editing the AssaultCube launcher

-

- Microsoft Windows -

-

- In the AssaultCube folder, there is a file named "assaultcube.bat". Right - click this and open it with "notepad" to edit the clients launcher. -
- Also, after using the server wizard, in this folder will be "server_autoconfigured.bat". - Right click this and open it with "notepad" to edit the servers launcher. -

-

- All switches are placed after the phrase: bin_win32\ac_client.exe
- (If you're editing the client, you'll need to add it before the phrase: - %1 %2 %3 %4 %5). -

-

- Remember to save once you're finished! -

-

- Linux -

-

- In the AssaultCube folder, there is a file named "assaultcube.sh". Open it - with your favourite text editor, such as Gedit, Nano, etc. to edit the clients launcher. -
- Also, after using the server wizard, in this folder will be "server_autogenerated.sh". - Open it with your favourite text editor to edit the servers launcher. -

-

- All switches for the client must be put inside the quote marks on this line: CUBE_OPTIONS="--home=${HOME}/.assaultcube --init" -

-

- All switches for the server must be placed after the phrase: ./server.sh. -

-

- Remember to save once you're finished! -

-

- Apple Mac OS X -

-

- After starting the AssaultCube launcher, under the "main" tab of the AssaultCube - launcher is an "Advanced options" bar. You can type all the switches you need for - the client into there.
- 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

+ + + + + + + + + + + + + + + + +
+ Windows + + Microsoft Windows +
+

+ In the AssaultCube folder, there is a file named "assaultcube.bat". Right + click this and open it with "notepad" to edit the clients launcher. + Also, after using the server wizard, in this folder will be "server_autoconfigured.bat". + Right click this and open it with "notepad" to edit the servers launcher. +

+

+ All switches are placed after the phrase: bin_win32\ac_client.exe +
+ If you're editing the client, you'll need to add it before the phrase: + %1 %2 %3 %4 %5 +

+

+ Remember to save once you're finished! +

+
+ Linux + + Linux +
+

+ In the AssaultCube folder, there is a file named "assaultcube.sh". Open it + with your favourite text editor, such as Gedit, Nano, etc. to edit the clients launcher. +
+ Also, after using the server wizard, in this folder will be "server_autogenerated.sh". + Open it with your favourite text editor to edit the servers launcher. +

+

+ All switches for the client must be put inside the quote marks on this line: CUBE_OPTIONS="--home=${HOME}/.assaultcube --init" +

+

+ All switches for the server must be placed after the phrase: ./server.sh. +

+

+ Remember to save once you're finished! +

+
+ Apple Mac OS X + + Apple Mac OS X +
+

+ After starting the AssaultCube launcher, under the "main" tab of the AssaultCube + launcher is an "Advanced options" bar.
+ You can type all the switches you need for the client into there.
+ 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 switches

These variables are specifically for the clients launcher, not the server. + Switches are case-sensitive!

@@ -124,7 +158,7 @@ -bN @@ -141,7 +175,7 @@ -aN @@ -149,7 +183,17 @@ -vN + + + + @@ -174,105 +218,214 @@ +
- Sets the screen to N bits per pixel + Sets the screen to N bits per pixel.
- Sets the FSAA (Full Scene AntiAliasing) to N samples (i.e. -a4 is 4xFSAA). + Sets FSAA (Full Scene AntiAliasing) to N samples (i.e. -a4 is 4xFSAA).
- Enables vsync if N is greater 0 + Enables vsync if N is greater 0. +
+ -mM + + Sets the client to update itself against masterserver M. + M is the base url of the master server and has to end in a / and without a + http:// prefix, the default is masterserver.cubers.net/cgi-bin/AssaultCube.pl/
- --home=PATH + --home=PATH Specifies the home directory for the user profile, AssaultCube will write custom settings and files to this directory (recommended).
-

Server

+

Server switches

- -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 - the Server Section. You don't need this parameter, if you're using the server binary. -

-

- -uN sets the server upstream bandwidth (per player) to N bytes per - second. only set this parameter if you know what you are doing, specifying a wrong - value is worse than not specifying it at all. -

-

- -nS sets the server description, for people pinging the - server. Usually does not need to be set if you have a descriptive domain name already, - but if you set it, keep it short as it may otherwise be truncated, i.e. -nBobsInstagibServer -

-

- -n1S sets a server description prefix. -
- -n2S sets a server description suffix. -
- To enable the admin to temporary change the server description, a description prefix and/or suffix has to be set. - If the admin executes the command /serverdesc DESC, the server description - will be changed to "prefixDESCsuffix". At the end of the game, the default server description (set by - -n) is restored automatically. -

-

- -iIP sets the server ip to IP. this option is only useful - for people running on machines with multiple network interfaces. -

-

- -mM sets the master server to use for either server (registering) - and client (updating) to M. M is the base url of the master server and has to end - in a / and without a http:// prefix, the default is masterserver.cubers.net/cgi-bin/AssaultCube.pl/. - If you want your server to be private and not report to the masterserver, use -mlocalhost. -

-

- -pPASS sets the server password to PASS. Only clients - that use the command "connect ip port PASS" will be able to connect. -

-

- -cN sets the maximum number of players that can play on - this server to N (default 6). If more players try to connect they will get a "server - full" message. -

-

- -xM sets the - admin password. If you don't want your commandline to contain the password, or if you need - more than one admin password, use the file "config/serverpwd.cfg". -

-

- -Xf sets the admin password file. The default is - -Xconfig/serverpwd.cfg -

-

- -rC sets the - maprotation file, e.g. -rconfig/maprot.cfg -

-

- -Bf sets the blacklist file. The default is - -Bconfig/serverblacklist.cfg -

-

- -oN sets the server's message of the day. -

-

- -kN sets the kick threshold. If a players score drops - below it, he will be kicked automatically. (default: -5) -

-

- -yN sets the ban threshold. If a players score drops - below it, he will be banned automatically. (default: -6) -

-

- -D enables permanent demo recording. Every game will - be recorded. The recorded demos will be held in RAM. By default, up to 5 demos will be kept. - The oldest demo will be deleted automatically, if necessary, to record further demos. - To change the default of 5 demos in RAM, you can add the number of demos to the parameter, - e.g. -D5 -

-

- -SW starts the server as windows service and sets the - name of the windows service that should be used. Works only for the server binary - is started directly from the windows service manager. -

-

- -V sets the server to verbose mode. This enables additional - log messages to be printed, including the server configuration files (after parsing). Be careful: - the logfile will contain all content from serverpwd.cfg. -

+ These variables are specifically for the servers launcher, not the client. + Switches are case-sensitive. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ -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 the Server Section. + You don't need this parameter, if you're using the server binary. +
+ -uN + + Sets the server upstream bandwidth (per player) to N bytes per + second. only set this parameter if you know what you are doing, specifying a wrong + value is worse than not specifying it at all. +
+ -nS + + Sets the server description, for people pinging the server. This usually does not need to + be set if you have a descriptive domain name already, but if you set it, keep it short + as it may otherwise be truncated, i.e. -nBobsInstagibServer +
+ -n1S + + Sets a server description prefix. +
+ -n2S + + Sets a server description suffix. +
+ To enable the admin to temporarily change the server description, a server description prefix + and/or suffix needs to be set. If the admin executes the command /serverdesc DESC, + the server description will be changed to "prefixDESCsuffix". + At the end of the game, the default server description (set by + -n) is restored automatically. +
+ -iIP + + Sets the server ip to IP. This option is only useful + for people running on machines with multiple network interfaces. +
+ -mM + + Sets the server to register itself against masterserver M. + M is the base url of the master server and has to end in a / and without a http:// prefix, + the default is masterserver.cubers.net/cgi-bin/AssaultCube.pl/. + If you want your server to be private and not report to the masterserver, use -mlocalhost. +
+ -pPASS + + Sets the server password to PASS. Only clients + that use the command "/connect IP PORT PASS" will be able to connect. +
+ -cN + + Sets the maximum number of players that can play on + this server to N (default 6). If more players try to connect they will get a "server + full" message. +
+ -xM + + Sets the + admin password. If you don't want your commandline to contain the password, or if you need + more than one admin password, use the file "config/serverpwd.cfg". +
+ -Xf + + Sets the admin password file. The default is -Xconfig/serverpwd.cfg +
+ -rC + + Sets the + maprotation file. Example: -rconfig/maprot.cfg +
+ -Bf + + Sets the blacklist file. The default is + -Bconfig/serverblacklist.cfg +
+ -oN + + Sets the server's "message of the day" (MOTD). +
+ -kN + + Sets the kick threshold. If a players score drops + below it, he will be kicked automatically (default: -5). +
+ -yN + + Sets the ban threshold. If a players score drops + below it, he will be banned automatically (default: -6). +
+ -D + + Enables permanent demo recording. Every game will + be recorded. The recorded demos will be held in RAM. By default, up to 5 demos will be kept. + The oldest demo will be deleted automatically if necessary, to allow recording of further demos. + To change the default of 5 demos in RAM, you can add the number of demos to the parameter, + e.g. -D5 +
+ -SW + + Starts the server as windows service and sets the + name of the windows service that should be used. Works only for the server binary + is started directly from the windows service manager. +
+ -V + + Sets the server to verbose mode. This enables additional + log messages to be printed, including the server configuration files (after parsing). Be careful: + the logfile will contain all content from serverpwd.cfg. +