RandumKiwi
13c8a5e278
git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@3404 e016b1c5-ed68-44aa-a2f7-31cac88cffde
436 lines
14 KiB
HTML
436 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN">
|
|
<html lang="en" xml:lang="en" xmlns:h="http://www.w3.org/1999/xhtml" xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>Command-line arguments </title>
|
|
<meta http-equiv="content-type" content="application/xhtml+xml;charset=utf-8" />
|
|
<link rel="shortcut icon" href="pics/favicon.ico" />
|
|
<link rel="stylesheet" href="styles/cubedoc.css" />
|
|
</head>
|
|
<body>
|
|
<div id="main">
|
|
<div id="logo">
|
|
<img src="pics/head.gif" alt="AssaultCube logo" />
|
|
</div>
|
|
<div id="title">
|
|
<h1>
|
|
AssaultCube: Command-line arguments
|
|
</h1>
|
|
</div>
|
|
<div id="content">
|
|
<h1>
|
|
Command-line arguments
|
|
</h1>
|
|
<p>
|
|
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.
|
|
<br clear="none" /><b>Note:</b> Some of these options can be changed in-game
|
|
through the menus without the need to manually edit the script file.
|
|
</p>
|
|
<h3>Contents:</h3>
|
|
<ul>
|
|
<li>
|
|
HowTo: <a href="#launcher">Editing the AssaultCube launcher</a>
|
|
</li>
|
|
<li>
|
|
<a href="#clientswitch">Client switches</a>
|
|
</li>
|
|
<li>
|
|
<a href="#serverswitch">Server switches</a>
|
|
</li>
|
|
</ul>
|
|
<h2 id="launcher">
|
|
HowTo: Editing the AssaultCube launcher
|
|
</h2>
|
|
|
|
<table>
|
|
<tr>
|
|
<td width="50" rowspan="1" colspan="1">
|
|
<img src="pics/vista.png" alt="Windows" />
|
|
</td>
|
|
<td rowspan="1" colspan="1">
|
|
<b>Microsoft Windows</b>
|
|
<br clear="none" />
|
|
<p>
|
|
In the AssaultCube folder, there is a file named "<i>assaultcube.bat</i>". Right
|
|
click this and open it with "notepad" to edit the clients launcher.
|
|
Also, after using the server wizard, in this folder will be "<i>server_autoconfigured.bat</i>".
|
|
Right click this and open it with "notepad" to edit the servers launcher.
|
|
</p>
|
|
<p>
|
|
All switches are placed after the phrase: <span class="code">bin_win32\ac_client.exe</span>
|
|
<br clear="none" />
|
|
If you're editing the client, you'll need to add it before the phrase: <span class="code">
|
|
%1 %2 %3 %4 %5</span>
|
|
</p>
|
|
<p>
|
|
Remember to save once you're finished!
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="50" rowspan="1" colspan="1">
|
|
<img src="pics/linux.png" alt="Linux" />
|
|
</td>
|
|
<td rowspan="1" colspan="1">
|
|
<b>Linux</b>
|
|
<br clear="none" />
|
|
<p>
|
|
In the AssaultCube folder, there is a file named "<i>assaultcube.sh</i>". Open it
|
|
with your favourite text editor, such as Gedit, Nano, etc. to edit the clients launcher.
|
|
<br clear="none" />
|
|
Also, after using the server wizard, in this folder will be "<i>server_autogenerated.sh</i>".
|
|
Open it with your favourite text editor to edit the servers launcher.
|
|
</p>
|
|
<p>
|
|
All switches for the client must be put inside the quote marks on this line: <span
|
|
class="code">CUBE_OPTIONS="--home=${HOME}/.assaultcube --init"</span>
|
|
</p>
|
|
<p>
|
|
All switches for the server must be placed after the phrase: <span class="code">./server.sh</span>.
|
|
</p>
|
|
<p>
|
|
Remember to save once you're finished!
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="50" rowspan="1" colspan="1">
|
|
<img src="pics/apple.png" alt="Apple Mac OS X" />
|
|
</td>
|
|
<td rowspan="1" colspan="1">
|
|
<b>Apple Mac OS X</b>
|
|
<br clear="none" />
|
|
<p>
|
|
After starting the AssaultCube launcher, under the "main" tab of the AssaultCube
|
|
launcher is an "Advanced options" bar. <br clear="none" />
|
|
You can type all the switches you need for the client into there.<br clear="none" />
|
|
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.<br clear="none" />
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 id="clientswitch">Client switches</h2>
|
|
<p>
|
|
These variables are specifically for the clients launcher, not the server.
|
|
Switches are case-sensitive!
|
|
</p>
|
|
<table>
|
|
<tr>
|
|
<td width="120" style="text-align: center;">
|
|
<span class="codecommandline">-w</span>X
|
|
</td>
|
|
<td>
|
|
Sets desired screen width to X, default is <span class="code">-w1024</span>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-h</span>Y
|
|
</td>
|
|
<td>
|
|
Sets desired screen height to Y, default is <span class="code">-h768</span>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-t</span>
|
|
</td>
|
|
<td>
|
|
Runs AssaultCube in windowed mode (fullscreen off).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-z</span>N
|
|
</td>
|
|
<td>
|
|
Sets the z-buffer precision to N bits. This should be at least 24
|
|
or you may experience depth problems.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-b</span>N
|
|
</td>
|
|
<td>
|
|
Sets the screen to N bits per pixel.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-s</span>N
|
|
</td>
|
|
<td>
|
|
Sets the stencil buffer precision to N bits. This should be 8 to enable
|
|
shadowing effects, or 0 to turn it off (the default).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-a</span>N
|
|
</td>
|
|
<td>
|
|
Sets FSAA (Full Scene AntiAliasing) to N samples (i.e. -a4 is 4xFSAA).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-v</span>N
|
|
</td>
|
|
<td>
|
|
Enables vsync if N is greater 0.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-m</span>M
|
|
</td>
|
|
<td>
|
|
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/
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">--init</span>
|
|
</td>
|
|
<td>
|
|
Executes the init script before starting the graphics
|
|
and sound subsystems (recommended). By default the script <i>config/init.cfg</i>
|
|
is used, but you can override this setting by using <i>--init=yourfile.cfg</i>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span id="mods" class="codecommandline">--mod=</span>PATH
|
|
</td>
|
|
<td>
|
|
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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">--home=</span>PATH
|
|
</td>
|
|
<td>
|
|
Specifies the home directory for the user profile, AssaultCube will write
|
|
custom settings and files to this directory (recommended).
|
|
</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<h2 id="serverswitch">Server switches</h2>
|
|
<p>
|
|
These variables are specifically for the servers launcher, not the client.
|
|
Switches are case-sensitive.
|
|
</p>
|
|
<table>
|
|
<tr>
|
|
<td style="text-align: center;" width="120">
|
|
<span class="codecommandline">-d</span>
|
|
</td>
|
|
<td>
|
|
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 <a href="server.html" shape="rect">Server Section</a>.
|
|
You don't need this parameter, if you're using the server binary.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-u</span>N
|
|
</td>
|
|
<td>
|
|
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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span id="serverdesc" class="codecommandline">-n</span>S
|
|
</td>
|
|
<td>
|
|
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
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-n1</span>S
|
|
</td>
|
|
<td>
|
|
Sets a server description prefix.
|
|
</td>
|
|
</tr>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-n2</span>S
|
|
</td>
|
|
<td>
|
|
Sets a server description suffix.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>
|
|
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 <span class="code">/serverdesc DESC</span>,
|
|
the server description will be changed to "prefixDESCsuffix".
|
|
At the end of the game, the default server description (set by
|
|
<span class="code"><a href="#serverdesc">-n</a></span>) is restored automatically.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-i</span>IP
|
|
</td>
|
|
<td>
|
|
Sets the server ip to IP. This option is only useful
|
|
for people running on machines with multiple network interfaces.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-m</span>M
|
|
</td>
|
|
<td>
|
|
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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-p</span>PASS
|
|
</td>
|
|
<td>
|
|
Sets the server password to PASS. Only clients
|
|
that use the command "/connect <i>IP PORT PASS</i>" will be able to connect.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-c</span>N
|
|
</td>
|
|
<td>
|
|
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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-x</span>M
|
|
</td>
|
|
<td>
|
|
Sets the <a href="server.html#serveradmin" shape="rect">
|
|
admin</a> 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".
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-X</span>f
|
|
</td>
|
|
<td>
|
|
Sets the admin password file. The default is <span class="code">-Xconfig/serverpwd.cfg</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-r</span>C
|
|
</td>
|
|
<td>
|
|
Sets the <a href="server.html#maprotation" shape="rect">
|
|
maprotation</a> file. Example: <span class="code">-rconfig/maprot.cfg</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-B</span>f
|
|
</td>
|
|
<td>
|
|
Sets the blacklist file. The default is
|
|
<span class="code">-Bconfig/serverblacklist.cfg</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-o</span>N
|
|
</td>
|
|
<td>
|
|
Sets the server's "message of the day" (MOTD).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-k</span>N
|
|
</td>
|
|
<td>
|
|
Sets the kick threshold. If a players score drops
|
|
below it, he will be kicked automatically (default: -5).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-y</span>N
|
|
</td>
|
|
<td>
|
|
Sets the ban threshold. If a players score drops
|
|
below it, he will be banned automatically (default: -6).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-D</span>
|
|
</td>
|
|
<td>
|
|
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. <span class="code">-D5</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-SW</span>
|
|
</td>
|
|
<td>
|
|
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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: center;">
|
|
<span class="codecommandline">-V</span>
|
|
</td>
|
|
<td>
|
|
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.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id="footer">
|
|
Rabid Viper Productions 2008/10/19
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|