mods.html
git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@3403 e016b1c5-ed68-44aa-a2f7-31cac88cffde
This commit is contained in:
+102
-48
@@ -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.<br clear="none" />
|
||||
</p>
|
||||
<h2>
|
||||
Client</h2>
|
||||
<h2>Client</h2>
|
||||
<p>
|
||||
<span class="code">-wX</span> sets desired screen width to X, default is <span class="code">
|
||||
-w640</span>
|
||||
<br clear="none" />
|
||||
<span class="code">-hY</span> sets desired screen height to Y, default is <span class="code">
|
||||
-h480</span>
|
||||
<br clear="none" />
|
||||
<span class="code">-t</span> runs windowed
|
||||
</p>
|
||||
<p>
|
||||
<span class="code">-zN</span> sets the z-buffer precision to N bits. This should
|
||||
be at least 24 or you may experience depth problems.
|
||||
</p>
|
||||
<p>
|
||||
<span class="code">-bN</span> sets the screen to N bits per pixel
|
||||
</p>
|
||||
<p>
|
||||
<span class="code">-zN</span> sets the z-buffer precision to N bits. This should
|
||||
be at least 24 or you may experience depth problems.
|
||||
</p>
|
||||
<p>
|
||||
<span class="code">-sN</span> sets the stencil buffer precision to N bits. This
|
||||
should be 8 to enable shadowing effects, or 0 to turn it off (the default).
|
||||
</p>
|
||||
<p>
|
||||
<span class="code">-aN</span> sets FSAA (Full Scene AntiAliasing) to N samples,
|
||||
i.e. -a4 is 4xFSAA
|
||||
</p>
|
||||
<p>
|
||||
<span class="code">-vN</span> enables vsync if N is greater 0
|
||||
</p>
|
||||
<p>
|
||||
<span class="code">--init</span> 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>
|
||||
</p>
|
||||
<p>
|
||||
<span class="code">--mod=PATH</span> 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.
|
||||
</p>
|
||||
<p>
|
||||
<span class="code">--home=PATH</span> specifies the home directory for the user
|
||||
profile, AssaultCube will write custom settings and files to this directory (recommended).
|
||||
</p>
|
||||
<h2>
|
||||
Server</h2>
|
||||
These variables are specifically for the clients launcher, not the server.
|
||||
</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 the 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">--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 id="mods" 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>Server</h2>
|
||||
<p>
|
||||
<span class="code">-d</span> 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
|
||||
|
||||
+54
-30
@@ -1,36 +1,60 @@
|
||||
<!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>Custom mods</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"/>
|
||||
<title>Custom mods</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: Custom mods</h1>
|
||||
</div>
|
||||
<div id="content">
|
||||
<h1>Custom mods</h1>
|
||||
<p>
|
||||
|
||||
|
||||
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.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div id="footer">
|
||||
Rabid Viper Productions 2008/03/07
|
||||
</div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div id="logo">
|
||||
<img src="pics/head.gif" alt="AssaultCube logo"/>
|
||||
</div>
|
||||
<div id="title">
|
||||
<h1>AssaultCube: Custom mods</h1>
|
||||
</div>
|
||||
<div id="content">
|
||||
<h1>Custom mods</h1>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
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 <a href="commandline.html#mods">--mod argument</a>,
|
||||
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.
|
||||
</p>
|
||||
<h3>Example:</h3>
|
||||
<p>
|
||||
Assume you want to create a mod that provides a customized hud-gun, you would create a mod directory:
|
||||
</p>
|
||||
<ol>
|
||||
<li>
|
||||
Create a <i>"mod"</i> directory: <b>AssaultCube\mods\MyMod1\</b>
|
||||
<br clear="none" />...where AssaultCube is your main directory (%programfiles%\AssaultCube_v1.0).
|
||||
</li>
|
||||
<li>
|
||||
Inside your mod directory, add your customized hudgun: <b>AssaultCube\mods\MyMod1\packages\models\hudguns\assaultrifle.md3</b>
|
||||
</li>
|
||||
<li>
|
||||
Now to make AssaultCube aware of this mod you'll need to start AssaultCube with the argument <b>--mod=mods\MyMod1 </b>
|
||||
<br clear="none" />...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.
|
||||
</li>
|
||||
</ol>
|
||||
<p>
|
||||
To start AssaultCube with the mod argument, you will most likely need to modify the AssaultCube launcher.
|
||||
See <a href="commandline.html#launcher">command line</a> on how to do this...
|
||||
</p>
|
||||
</div>
|
||||
<div id="footer">
|
||||
Rabid Viper Productions 2008/03/07
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -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;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user