mirror of
https://github.com/kevinbentley/Descent3.git
synced 2025-01-22 11:28:56 +00:00
Import wiki’s CLI docs into USAGE.md
This commit takes all of the command-line options documentation from the wiki [1] and merges it with the command-line options documentation that’s in USAGE.md. This change will eventually allow us to remove the command-line options documentation from the wiki so that we only have one list of command-line options instead of two. Before this change, USAGE.md used a Markdown table and the wiki used an HTML table. I ended up replacing the Markdown table in USAGE.md with an HTML table because it was easier to copy and paste the HTML table from the wiki than to convert the HTML table from the wiki into a Markdown table. The main motivation behind this change is to make it easier to create a future commit. That future commit will add documentation for the -additionaldir command-line option. Making sure that there’s only one list of command-line options instead of two will make it so that -additionaldir doesn’t need to be documented in two different places. This is related #618, but it doesn’t fully fix that issue. [1]: <https://github.com/DescentDevelopers/Descent3/wiki/Running-Descent-3#command-line-options>
This commit is contained in:
Jason Yundt
parent
74a18aed51
commit
ab384e97d5
452
USAGE.md
452
USAGE.md
@ -80,18 +80,444 @@ This error means that game data could not be found. Make sure you copied all
|
||||
game files to the `D3-open-source` folder, and that you're running the game
|
||||
from this same folder.
|
||||
|
||||
## Command line options
|
||||
## Command-Line Options
|
||||
|
||||
Here brief usage of command line options, supported by game.
|
||||
The following command-line options are available in Descent 3. You can set command-line options on the Misc. tab of the Setup section of the Descent 3 launcher or by creating a shortcut to `main.exe`. Case is not significant in command-line options, and `-`, `--`, and `+` are all accepted.
|
||||
|
||||
| Option | Type | Default | Platform | Description |
|
||||
|------------------------------------------------|---------|-------------------------------------|----------|-------------------------------------------------------------------|
|
||||
| `-dedicated <config file>`, `-d <config file>` | path | None | all | Run game in dedicated mode |
|
||||
| `-display <number>` | integer | 0 | all | Run game on the selected display |
|
||||
| `-fullscreen`, `-f` | boolean | On | all | Run game in fullscreen mode |
|
||||
| `-logfile` | boolean | Off | all | Enable file logging to Descent3.log |
|
||||
| `-loglevel <LEVEL>` | string | INFO (on Release), DEBUG (on Debug) | all | Set log level (NONE, VERBOSE, DEBUG, INFO, WARNING, ERROR, FATAL) |
|
||||
| `-nomousegrab`, `-m` | boolean | Off | all | Disable mouse capture |
|
||||
| `-service` | boolean | Off | all | Run game in service mode |
|
||||
| `-winconsole` | boolean | Off | WIN | Enable windows console (off by default) |
|
||||
| `-windowed`, `-w` | boolean | Off | all | Run game in windowed mode |
|
||||
<table>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Type</th>
|
||||
<th>Default</th>
|
||||
<th>Platform</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="5">Display Options</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-aspect <value></code></td>
|
||||
<td>floating-point number</td>
|
||||
<td>1.3333333333333333</td>
|
||||
<td>all</td>
|
||||
<td>Specifies the screen aspect ratio for non-standard displays, such as wide-screen TVs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-display <number></code></td>
|
||||
<td>integer</td>
|
||||
<td>0</td>
|
||||
<td>all</td>
|
||||
<td>Run game on the selected display.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-fullscreen</code> or <code>-f</code></td>
|
||||
<td>boolean</td>
|
||||
<td>On</td>
|
||||
<td>all</td>
|
||||
<td>Run game in fullscreen mode.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-height <height></code></td>
|
||||
<td>integer</td>
|
||||
<td>480 unless you select a different value in the options menu</td>
|
||||
<td>all</td>
|
||||
<td>Sets the screen resolution to the specified height, if possible.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-himem</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Forces normal operations even when low memory conditions are detected.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-lowmem</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Uses scaled-down textures and lower quality (8-bit) sounds to conserve memory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-NoRenderWindows</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Causes all windows to be fully transparent. Use this option if your card does not correctly render partially-transparent windows.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-superlowmem</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Uses the <code>-lowmem</code> settings and further scales down textures to conserve memory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-vsync</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Turns on Vertical Sync. The flag will be enabled in the registry so it will be on when the game is run again.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-width <width></code></td>
|
||||
<td>integer</td>
|
||||
<td>640 unless you select a different value in the options menu</td>
|
||||
<td>all</td>
|
||||
<td>Sets the screen resolution to the specified width, if possible.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-windowed</code> or </code>-w</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Runs the game in a window.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-z32bit</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>WIN</td>
|
||||
<td>Enables the 32-bit z-buffer on cards that support it, such as the Matrox G400.</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th colspan="5">Audio Options</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nomusic</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables music.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nosound</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables all sound, including music.</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th colspan="5">Input Options</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-alternatejoy</code> or <code>-directinput</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>WIN</td>
|
||||
<td>Causes DirectInput to be used for the joystick or other game controller, instead of standard Windows API.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-chpro</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Enables a CH Flightstick Pro or compatible joystick.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-deadzone# <k></code></td>
|
||||
<td><code>#</code> is either the character <code>0</code> or the character <code>1</code>. <code>k</code> is a floating-point number.</td>
|
||||
<td>0.2</td>
|
||||
<td>all</td>
|
||||
<td>Specifies the size of the deadzone for a joystick.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-mlooksens <scale></code></td>
|
||||
<td>floating-point number</td>
|
||||
<td>9.102</td>
|
||||
<td>all</td>
|
||||
<td>Determines how much the player moves when the mouse is moved.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-mouseman</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Enables special handling for the Logitech MouseMan.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-mousesens <scale></code></td>
|
||||
<td>floating-point number</td>
|
||||
<td>1.0</td>
|
||||
<td>all</td>
|
||||
<td>Adjusts the sensitivity of the mouse when not using mouselook mode.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nomousegrab</code> or <code>-m</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disable mouse capture.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="5">Performance Options</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-fastdemo</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Causes a demo to play back at the highest speed your computer is capable of.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-forcelightmaps</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Forces the use of lightmaps, even the Default Detail Level is set to Low in the launcher setup.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-framecap <fps></code></td>
|
||||
<td>integer</td>
|
||||
<td>60</td>
|
||||
<td>all</td>
|
||||
<td>Limits the framerate to the number of frames per second specified.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-highvidmem</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Causes 2 MB Voodoo 1 cards to behave as if they had more memory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nocompress</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Turns off S3TC texture compression for cards that support it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nolightmaps</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables lightmaps. This will improve performance on low-end video cards.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nomotionblur</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables motion blur on robots (Pentium III only).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nomultitexture</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables single-pass multitexturing. This option could fix problems due to buggy drivers on future video cards.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nooutdoorfog</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables fog on the terrain under Direct3D. This may improve performance on some cards.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nopentium3</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables detection of the Pentium III processor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nosatomega</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables alpha saturation on the omega cannon effect.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-subpixelcorrect</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Adjusts for subpixel correction under Direct3D for cards that do not support it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nosparkles</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables powerup sparkles (Pentium III only).</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th colspan="5">Multiplayer and Network Options</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-audiotauntdelay <time></code></td>
|
||||
<td>floating-point number</td>
|
||||
<td>5.0</td>
|
||||
<td>all</td>
|
||||
<td>Sets the time in seconds the a user must wait after sending an audio taunt before he or she is able to send another. This option is only active when starting a server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-autoexec <file></code></td>
|
||||
<td>path</td>
|
||||
<td><writable-base-directory>/netgames/autoexec.dmfc</td>
|
||||
<td>all</td>
|
||||
<td>Specifies the full path and file name of the multiplayer config file to be loaded and executed when a multiplayer game is initialized.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-dedicated <config file></code> or <code>-d <config file></code></td>
|
||||
<td>path</td>
|
||||
<td>None</td>
|
||||
<td>all</td>
|
||||
<td>Starts a dedicated server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-gamespyport <port></code></td>
|
||||
<td>integer</td>
|
||||
<td>20142</td>
|
||||
<td>all</td>
|
||||
<td>Specifies a port for to listen for GameSpy requests.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-gspyfile <config file></code></td>
|
||||
<td>path</td>
|
||||
<td>gamespy.cfg</td>
|
||||
<td>all</td>
|
||||
<td>Specifies a GameSpy configuration file to use.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-httpproxy <addr></code> or <code>-httpproxy <addr:port></code></td>
|
||||
<td>string</td>
|
||||
<td>None</td>
|
||||
<td>all</td>
|
||||
<td>Specifies an HTTP proxy server. Descent 3 uses HTTP to auto-download a mission; use this option if your ISP requires a proxy server for HTTP connections. If the first form is used, the port value defaults to 80.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nooutragelogo</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables the Outrage logo that is normally displayed for five seconds at the start of a multiplayer game.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nomultibmp</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables sending or receiving in-game custom bitmaps for ships.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nonetwork</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables all network multiplayer functionality.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-playermessages</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables all weapon-related HUD messages in multiplayer games.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-pxoport <port></code></td>
|
||||
<td>integer</td>
|
||||
<td>20142</td>
|
||||
<td>all</td>
|
||||
<td>Specifies the port that PXO will tell clients to use when contacting a server. The default is 2092.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-useip <IP></code></td>
|
||||
<td>string</td>
|
||||
<td>All available network interfaces</td>
|
||||
<td>all</td>
|
||||
<td>Binds Descent 3 to this IP address. Use this option to tell D3 which IP address to use if your computer has multiple IP addresses.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-useport <port></code></td>
|
||||
<td>integer</td>
|
||||
<td>2092</td>
|
||||
<td>all</td>
|
||||
<td>Specifies the port that TCP/IP and IPX will use.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-usesmoothing</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Enables code to smooth the interpolation for fast-moving objects. This will fix "skipping" problems with fast weapons, such as the Phoenix. This option applies to clients only; using it on the server has no effect.</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th colspan="5">Other Options</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-logfile</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Generates a logfile `d3.log` if using the Debug build. All `mprintf` statements output to the logfile.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-loglevel <LEVEL></code></td>
|
||||
<td>string</td>
|
||||
<td>INFO (on Release), DEBUG (on Debug)</td>
|
||||
<td>all</td>
|
||||
<td>Set log level (NONE, VERBOSE, DEBUG, INFO, WARNING, ERROR, FATAL)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-makemovie</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Causes the demo system to save a screenshot of every frame during playback.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-mission <name></code></td>
|
||||
<td>string</td>
|
||||
<td>None</td>
|
||||
<td>all</td>
|
||||
<td>Loads the specified mission file at startup.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-nocrashbox</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Disables the error dialog displayed if Descent3 crashes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-pilot <name></code></td>
|
||||
<td>string</td>
|
||||
<td>None</td>
|
||||
<td>all</td>
|
||||
<td>Specifies the pilot to use, skipping the pilot selection dialog when the game starts.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-service</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Run game in service mode.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-setdir <path></code></td>
|
||||
<td>path</td>
|
||||
<td>.</td>
|
||||
<td>all</td>
|
||||
<td>Specifies the working directory for Descent 3.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-useexedir</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>all</td>
|
||||
<td>Tells Descent 3 to use the directory in which the executable is located as the working directory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>-winconsole</code></td>
|
||||
<td>boolean</td>
|
||||
<td>Off</td>
|
||||
<td>WIN</td>
|
||||
<td>Enable windows console (off by default).</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user