From d85e0b606f69c764bc6df738af74c7c0ce5101ed Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Sun, 6 Oct 2024 09:17:16 -0400 Subject: [PATCH 1/8] Fix description of -dedicated MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Before this change, USAGE.md said that -dedicated was a boolean option and that it took 0 arguments. This is not correct, and it contradicts the wiki’s documentation for -dedicated [1]. This commit fixes that issue. [1]: --- USAGE.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/USAGE.md b/USAGE.md index cdd6bbe1..6d519138 100644 --- a/USAGE.md +++ b/USAGE.md @@ -84,14 +84,14 @@ from this same folder. Here brief usage of command line options, supported by game. -| Option | Type | Default | Platform | Description | -|----------------------|---------|-------------------------------------|----------|-------------------------------------------------------------------| -| `-dedicated`, `-d` | boolean | Off | all | Run game in dedicated mode | -| `-display` | 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 ` | 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 | +| Option | Type | Default | Platform | Description | +|------------------------------------------------|---------|-------------------------------------|----------|-------------------------------------------------------------------| +| `-dedicated `, `-d ` | path | None | all | Run game in dedicated mode | +| `-display` | 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 ` | 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 | From 74a18aed519b5c8592d7a984bb080747f23e6ae3 Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Mon, 23 Dec 2024 13:43:40 -0500 Subject: [PATCH 2/8] Add missing for -display MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Before this change, the documentation for the command-line options that take arguments was inconsistent. There was a in the “option” cell for almost all of the command-line options that take arguments. -display was the only command-line option that takes arguments that didn’t have a . This change makes the documentation more consistent by ensuring that all command-line options that take arguments have . --- USAGE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/USAGE.md b/USAGE.md index 6d519138..466a073e 100644 --- a/USAGE.md +++ b/USAGE.md @@ -87,7 +87,7 @@ Here brief usage of command line options, supported by game. | Option | Type | Default | Platform | Description | |------------------------------------------------|---------|-------------------------------------|----------|-------------------------------------------------------------------| | `-dedicated `, `-d ` | path | None | all | Run game in dedicated mode | -| `-display` | integer | 0 | all | Run game on the selected display | +| `-display ` | 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 ` | string | INFO (on Release), DEBUG (on Debug) | all | Set log level (NONE, VERBOSE, DEBUG, INFO, WARNING, ERROR, FATAL) | From ab384e97d53aad648d96e6c5a0ceb17c0ee43980 Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Sun, 6 Oct 2024 09:10:46 -0400 Subject: [PATCH 3/8] =?UTF-8?q?Import=20wiki=E2=80=99s=20CLI=20docs=20into?= =?UTF-8?q?=20USAGE.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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]: --- USAGE.md | 452 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 439 insertions(+), 13 deletions(-) diff --git a/USAGE.md b/USAGE.md index 466a073e..23c62c11 100644 --- a/USAGE.md +++ b/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 `, `-d ` | path | None | all | Run game in dedicated mode | -| `-display ` | 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 ` | 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 | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionTypeDefaultPlatformDescription
Display Options
-aspect <value>floating-point number1.3333333333333333allSpecifies the screen aspect ratio for non-standard displays, such as wide-screen TVs.
-display <number>integer0allRun game on the selected display.
-fullscreen or -fbooleanOnallRun game in fullscreen mode.
-height <height>integer480 unless you select a different value in the options menuallSets the screen resolution to the specified height, if possible.
-himembooleanOffallForces normal operations even when low memory conditions are detected.
-lowmembooleanOffallUses scaled-down textures and lower quality (8-bit) sounds to conserve memory.
-NoRenderWindowsbooleanOffallCauses all windows to be fully transparent. Use this option if your card does not correctly render partially-transparent windows.
-superlowmembooleanOffallUses the -lowmem settings and further scales down textures to conserve memory.
-vsyncbooleanOffallTurns on Vertical Sync. The flag will be enabled in the registry so it will be on when the game is run again.
-width <width>integer640 unless you select a different value in the options menuallSets the screen resolution to the specified width, if possible.
-windowed or -wbooleanOffallRuns the game in a window.
-z32bitbooleanOffWINEnables the 32-bit z-buffer on cards that support it, such as the Matrox G400.
Audio Options
-nomusicbooleanOffallDisables music.
-nosoundbooleanOffallDisables all sound, including music.
Input Options
-alternatejoy or -directinputbooleanOffWINCauses DirectInput to be used for the joystick or other game controller, instead of standard Windows API.
-chprobooleanOffallEnables a CH Flightstick Pro or compatible joystick.
-deadzone# <k># is either the character 0 or the character 1. k is a floating-point number.0.2allSpecifies the size of the deadzone for a joystick.
-mlooksens <scale>floating-point number9.102allDetermines how much the player moves when the mouse is moved.
-mousemanbooleanOffallEnables special handling for the Logitech MouseMan.
-mousesens <scale>floating-point number1.0allAdjusts the sensitivity of the mouse when not using mouselook mode.
-nomousegrab or -mbooleanOffallDisable mouse capture.
Performance Options
-fastdemobooleanOffallCauses a demo to play back at the highest speed your computer is capable of.
-forcelightmapsbooleanOffallForces the use of lightmaps, even the Default Detail Level is set to Low in the launcher setup.
-framecap <fps>integer60allLimits the framerate to the number of frames per second specified.
-highvidmembooleanOffallCauses 2 MB Voodoo 1 cards to behave as if they had more memory.
-nocompressbooleanOffallTurns off S3TC texture compression for cards that support it.
-nolightmapsbooleanOffallDisables lightmaps. This will improve performance on low-end video cards.
-nomotionblurbooleanOffallDisables motion blur on robots (Pentium III only).
-nomultitexturebooleanOffallDisables single-pass multitexturing. This option could fix problems due to buggy drivers on future video cards.
-nooutdoorfogbooleanOffallDisables fog on the terrain under Direct3D. This may improve performance on some cards.
-nopentium3booleanOffallDisables detection of the Pentium III processor.
-nosatomegabooleanOffallDisables alpha saturation on the omega cannon effect.
-subpixelcorrectbooleanOffallAdjusts for subpixel correction under Direct3D for cards that do not support it.
-nosparklesbooleanOffallDisables powerup sparkles (Pentium III only).
Multiplayer and Network Options
-audiotauntdelay <time>floating-point number5.0allSets 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.
-autoexec <file>path<writable-base-directory>/netgames/autoexec.dmfcallSpecifies the full path and file name of the multiplayer config file to be loaded and executed when a multiplayer game is initialized.
-dedicated <config file> or -d <config file>pathNoneallStarts a dedicated server.
-gamespyport <port>integer20142allSpecifies a port for to listen for GameSpy requests.
-gspyfile <config file>pathgamespy.cfgallSpecifies a GameSpy configuration file to use.
-httpproxy <addr> or -httpproxy <addr:port>stringNoneallSpecifies 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.
-nooutragelogobooleanOffallDisables the Outrage logo that is normally displayed for five seconds at the start of a multiplayer game.
-nomultibmpbooleanOffallDisables sending or receiving in-game custom bitmaps for ships.
-nonetworkbooleanOffallDisables all network multiplayer functionality.
-playermessagesbooleanOffallDisables all weapon-related HUD messages in multiplayer games.
-pxoport <port>integer20142allSpecifies the port that PXO will tell clients to use when contacting a server. The default is 2092.
-useip <IP>stringAll available network interfacesallBinds Descent 3 to this IP address. Use this option to tell D3 which IP address to use if your computer has multiple IP addresses.
-useport <port>integer2092allSpecifies the port that TCP/IP and IPX will use.
-usesmoothingbooleanOffallEnables 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.
Other Options
-logfilebooleanOffallGenerates a logfile `d3.log` if using the Debug build. All `mprintf` statements output to the logfile.
-loglevel <LEVEL>stringINFO (on Release), DEBUG (on Debug)allSet log level (NONE, VERBOSE, DEBUG, INFO, WARNING, ERROR, FATAL)
-makemoviebooleanOffallCauses the demo system to save a screenshot of every frame during playback.
-mission <name>stringNoneallLoads the specified mission file at startup.
-nocrashboxbooleanOffallDisables the error dialog displayed if Descent3 crashes.
-pilot <name>stringNoneallSpecifies the pilot to use, skipping the pilot selection dialog when the game starts.
-servicebooleanOffallRun game in service mode.
-setdir <path>path.allSpecifies the working directory for Descent 3.
-useexedirbooleanOffallTells Descent 3 to use the directory in which the executable is located as the working directory.
-winconsolebooleanOffWINEnable windows console (off by default).
From 0d4b8cfda7694d02fbe92b34c19584e7fa81d527 Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Sun, 6 Oct 2024 09:49:32 -0400 Subject: [PATCH 4/8] Fix formatting of code in CLI option description MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Before this change, the documentation for -logfile did not format its code spans correctly. Specifically, it used back ticks to create code spans. Unfortunately, you can’t create code spans using back ticks if the code spans are embedded in an HTML block. This change fixes the formatting by replacing the back ticks with and . --- USAGE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/USAGE.md b/USAGE.md index 23c62c11..47a492bc 100644 --- a/USAGE.md +++ b/USAGE.md @@ -455,7 +455,7 @@ The following command-line options are available in Descent 3. You can set comma boolean Off all - Generates a logfile `d3.log` if using the Debug build. All `mprintf` statements output to the logfile. + Generates a logfile d3.log if using the Debug build. All mprintf statements output to the logfile. -loglevel <LEVEL> From 213df11ba669b5edfbff1e84388555df3a8e1cf3 Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Sun, 6 Oct 2024 09:58:04 -0400 Subject: [PATCH 5/8] Replace main.exe reference with Descent3.exe reference MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Before this change, USAGE.md talked about “main.exe”. In Descent 3 v1.4.0, there was indeed an executable named MAIN.EXE. However, that executable was renamed to Descent3.exe in v1.5.0. --- USAGE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/USAGE.md b/USAGE.md index 47a492bc..3a9bc12c 100644 --- a/USAGE.md +++ b/USAGE.md @@ -82,7 +82,7 @@ from this same folder. ## Command-Line Options -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. +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 `Descent3.exe`. Case is not significant in command-line options, and `-`, `--`, and `+` are all accepted. From db87580baa4f034c0e7f72d473f4e0dbf40354cb Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Sun, 6 Oct 2024 13:09:05 -0400 Subject: [PATCH 6/8] Remove docs for CLI options that no longer exist --- USAGE.md | 84 -------------------------------------------------------- 1 file changed, 84 deletions(-) diff --git a/USAGE.md b/USAGE.md index 3a9bc12c..9156f72c 100644 --- a/USAGE.md +++ b/USAGE.md @@ -172,13 +172,6 @@ The following command-line options are available in Descent 3. You can set comma - - - - - - - @@ -201,20 +194,6 @@ The following command-line options are available in Descent 3. You can set comma - - - - - - - - - - - - - - @@ -229,13 +208,6 @@ The following command-line options are available in Descent 3. You can set comma - - - - - - - @@ -274,27 +246,6 @@ The following command-line options are available in Descent 3. You can set comma - - - - - - - - - - - - - - - - - - - - - @@ -302,27 +253,6 @@ The following command-line options are available in Descent 3. You can set comma - - - - - - - - - - - - - - - - - - - - - @@ -330,13 +260,6 @@ The following command-line options are available in Descent 3. You can set comma - - - - - - - @@ -478,13 +401,6 @@ The following command-line options are available in Descent 3. You can set comma - - - - - - - From 5708b79c10db5d16a69fcbe33b1c10d33b705b03 Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Sun, 6 Oct 2024 11:07:14 -0400 Subject: [PATCH 7/8] Document -additionaldir --- USAGE.md | 70 ++++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 56 insertions(+), 14 deletions(-) diff --git a/USAGE.md b/USAGE.md index 9156f72c..87bd659a 100644 --- a/USAGE.md +++ b/USAGE.md @@ -80,6 +80,37 @@ 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. +## Base directories + +A base directory is a directory that Descent 3 expects game files to be in. When you run Descent 3, it will try to access many different files. Most of those files need to be stored in a base directory. There are two different types of files that are stored in base directories: + +- Read-write files are files that can change while you play Descent 3. Examples: `.plt` and files in the `savegame/` directory. +- Read-only files are files that do not change while you play Descent 3. Examples: `d3.hog` and files in the `movies/` directory. + +Descent 3 has two types of base directories: + +- The writable base directory can contain both read-write files and read-only files. There is only one writeable base directory. By default, the writable base directory gets set to the current working directory. +- The read-only base directories can only contain read-only files. There can be any number of read-only base directories. By default, Descent 3 uses zero read-only base directories. + +You can set the writable base directory and the list of read-only base directories using the `-setdir`, `-useexedir` and `-additionaldir` command-line options (see [the next section](#command-line-options)). + +When Descent 3 tries to find a read-only file, then it will look through the list of base directories in this order: + +- the last read-only base directory that was specified on the command-line, +- the second-to-last read-only base directory that was specified on the command-line, +- the third-to-last read-only base directory that was specified on the command-line, +- … +- the first read-only base directory that was specified on the command-line and, finally, +- the writable base directory. + +Files that are in base directories that are higher on that list will override files that are in base directories that are lower on that list. For example, lets say that you run Descent 3 like this: + +``` +Descent3 -setdir /home/user/my-writable-base-directory -additionaldir /home/user/my-read-only-base-directory +``` + +Let’s also say that both `my-writable-base-directory` and `my-read-only-base-directory` contain a file named `d3.hog`. In this example, Descent 3 will load `/home/user/my-read-only-base-directory/d3.hog` because read-only directories have a higher precedence than the writable base directory. Descent 3 will ignore `/home/user/my-writable-base-directory/d3.hog`. + ## Command-Line Options 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 `Descent3.exe`. Case is not significant in command-line options, and `-`, `--`, and `+` are all accepted. @@ -370,6 +401,31 @@ The following command-line options are available in Descent 3. You can set comma + + + + + + + + + + + + + + + + + + + + + + + + + @@ -415,20 +471,6 @@ The following command-line options are available in Descent 3. You can set comma - - - - - - - - - - - - - - From d45576cb8a9902afc4effcc515408d285a7579a9 Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Sun, 20 Oct 2024 17:29:30 -0400 Subject: [PATCH 8/8] Convert table of command-line options into list MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Before this change, USAGE.md had an HTML table that contained documentation for all of Descent 3’s command-line options. A concern was raised that an HTML table might not be easy to read if someone downloaded Descent 3 and opened USAGE.md in a plain text editor [1]. This commit alleviates that concern by converting the HTML table into bulleted lists. Credit for this idea goes to @Lgt2x [2]. The main motivation behind this change is to help get #623 merged. [1]: [2]: --- USAGE.md | 837 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 478 insertions(+), 359 deletions(-) diff --git a/USAGE.md b/USAGE.md index 87bd659a..5d600356 100644 --- a/USAGE.md +++ b/USAGE.md @@ -115,367 +115,486 @@ Let’s also say that both `my-writable-base-directory` and `my-read-only-base-d 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 `Descent3.exe`. Case is not significant in command-line options, and `-`, `--`, and `+` are all accepted. -
all Runs the game in a window.
-z32bitbooleanOffWINEnables the 32-bit z-buffer on cards that support it, such as the Matrox G400.
Audio Options
Input Options
-alternatejoy or -directinputbooleanOffWINCauses DirectInput to be used for the joystick or other game controller, instead of standard Windows API.
-chprobooleanOffallEnables a CH Flightstick Pro or compatible joystick.
-deadzone# <k> # is either the character 0 or the character 1. k is a floating-point number.all Determines how much the player moves when the mouse is moved.
-mousemanbooleanOffallEnables special handling for the Logitech MouseMan.
-mousesens <scale> floating-point numberall Limits the framerate to the number of frames per second specified.
-highvidmembooleanOffallCauses 2 MB Voodoo 1 cards to behave as if they had more memory.
-nocompressbooleanOffallTurns off S3TC texture compression for cards that support it.
-nolightmapsbooleanOffallDisables lightmaps. This will improve performance on low-end video cards.
-nomotionblur booleanall Disables motion blur on robots (Pentium III only).
-nomultitexturebooleanOffallDisables single-pass multitexturing. This option could fix problems due to buggy drivers on future video cards.
-nooutdoorfogbooleanOffallDisables fog on the terrain under Direct3D. This may improve performance on some cards.
-nopentium3booleanOffallDisables detection of the Pentium III processor.
-nosatomega booleanall Disables alpha saturation on the omega cannon effect.
-subpixelcorrectbooleanOffallAdjusts for subpixel correction under Direct3D for cards that do not support it.
-nosparkles booleanall Loads the specified mission file at startup.
-nocrashboxbooleanOffallDisables the error dialog displayed if Descent3 crashes.
-pilot <name> stringEnables 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.
Base Directory Options
-additionaldir <path>pathNoneallAdds a directory to the list of read-only base directories. This options can be used multiple times to add multiple directories to the list.
-setdir <path>path.allSets the writable base directory.
-useexedirbooleanOffallTells Descent 3 to use the directory in which the executable is located as the writable base directory.
Other Options
all Run game in service mode.
-setdir <path>path.allSpecifies the working directory for Descent 3.
-useexedirbooleanOffallTells Descent 3 to use the directory in which the executable is located as the working directory.
-winconsole boolean
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +### Display Options - - - - - - - - - - - - - - - - - +- `-aspect ` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + **Type:** floating-point number - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + **Default:** 1.3333333333333333 - - - - - - - - - - - - - - - - - - - - - - - - + **Platform:** all - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionTypeDefaultPlatformDescription
Display Options
-aspect <value>floating-point number1.3333333333333333allSpecifies the screen aspect ratio for non-standard displays, such as wide-screen TVs.
-display <number>integer0allRun game on the selected display.
-fullscreen or -fbooleanOnallRun game in fullscreen mode.
-height <height>integer480 unless you select a different value in the options menuallSets the screen resolution to the specified height, if possible.
-himembooleanOffallForces normal operations even when low memory conditions are detected.
-lowmembooleanOffallUses scaled-down textures and lower quality (8-bit) sounds to conserve memory.
-NoRenderWindowsbooleanOffallCauses all windows to be fully transparent. Use this option if your card does not correctly render partially-transparent windows.
-superlowmembooleanOffallUses the -lowmem settings and further scales down textures to conserve memory.
-vsyncbooleanOffallTurns on Vertical Sync. The flag will be enabled in the registry so it will be on when the game is run again.
-width <width>integer640 unless you select a different value in the options menuallSets the screen resolution to the specified width, if possible.
-windowed or -wbooleanOffallRuns the game in a window.
Audio Options
-nomusicbooleanOffallDisables music.
-nosoundbooleanOffallDisables all sound, including music.
Input Options
-deadzone# <k># is either the character 0 or the character 1. k is a floating-point number.0.2allSpecifies the size of the deadzone for a joystick.
-mlooksens <scale>floating-point number9.102allDetermines how much the player moves when the mouse is moved.
-mousesens <scale>floating-point number1.0allAdjusts the sensitivity of the mouse when not using mouselook mode.
-nomousegrab or -mbooleanOffallDisable mouse capture.
Performance Options
-fastdemobooleanOffallCauses a demo to play back at the highest speed your computer is capable of.
-forcelightmapsbooleanOffallForces the use of lightmaps, even the Default Detail Level is set to Low in the launcher setup.
-framecap <fps>integer60allLimits the framerate to the number of frames per second specified.
-nomotionblurbooleanOffallDisables motion blur on robots (Pentium III only).
-nosatomegabooleanOffallDisables alpha saturation on the omega cannon effect.
-nosparklesbooleanOffallDisables powerup sparkles (Pentium III only).
Multiplayer and Network Options
-audiotauntdelay <time>floating-point number5.0allSets 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.
-autoexec <file>path<writable-base-directory>/netgames/autoexec.dmfcallSpecifies the full path and file name of the multiplayer config file to be loaded and executed when a multiplayer game is initialized.
-dedicated <config file> or -d <config file>pathNoneallStarts a dedicated server.
-gamespyport <port>integer20142allSpecifies a port for to listen for GameSpy requests.
-gspyfile <config file>pathgamespy.cfgallSpecifies a GameSpy configuration file to use.
-httpproxy <addr> or -httpproxy <addr:port>stringNoneallSpecifies 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.
-nooutragelogobooleanOffallDisables the Outrage logo that is normally displayed for five seconds at the start of a multiplayer game.
-nomultibmpbooleanOffallDisables sending or receiving in-game custom bitmaps for ships.
-nonetworkbooleanOffallDisables all network multiplayer functionality.
-playermessagesbooleanOffallDisables all weapon-related HUD messages in multiplayer games.
-pxoport <port>integer20142allSpecifies the port that PXO will tell clients to use when contacting a server. The default is 2092.
-useip <IP>stringAll available network interfacesallBinds Descent 3 to this IP address. Use this option to tell D3 which IP address to use if your computer has multiple IP addresses.
-useport <port>integer2092allSpecifies the port that TCP/IP and IPX will use.
-usesmoothingbooleanOffallEnables 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.
Base Directory Options
-additionaldir <path>pathNoneallAdds a directory to the list of read-only base directories. This options can be used multiple times to add multiple directories to the list.
-setdir <path>path.allSets the writable base directory.
-useexedirbooleanOffallTells Descent 3 to use the directory in which the executable is located as the writable base directory.
Other Options
-logfilebooleanOffallGenerates a logfile d3.log if using the Debug build. All mprintf statements output to the logfile.
-loglevel <LEVEL>stringINFO (on Release), DEBUG (on Debug)allSet log level (NONE, VERBOSE, DEBUG, INFO, WARNING, ERROR, FATAL)
-makemoviebooleanOffallCauses the demo system to save a screenshot of every frame during playback.
-mission <name>stringNoneallLoads the specified mission file at startup.
-pilot <name>stringNoneallSpecifies the pilot to use, skipping the pilot selection dialog when the game starts.
-servicebooleanOffallRun game in service mode.
-winconsolebooleanOffWINEnable windows console (off by default).
+ **Description:** Specifies the screen aspect ratio for non-standard displays, such as wide-screen TVs. + +- `-display ` + + **Type:** integer + + **Default:** 0 + + **Platforms:** all + + **Description:** Run game on the selected display. + +- `-fullscreen` or `-f` + + **Type:** boolean + + **Default:** On + + **Platform:** all + + **Description:** Run game in fullscreen mode. + +- `-height ` + + **Type:** integer + + **Default:** 480 unless you select a different value in the options menu + + **Platform:** all + + **Description:** Sets the screen resolution to the specified height, if possible. + +- `-himem` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Forces normal operations even when low memory conditions are detected. + +- `-lowmem` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Uses scaled-down textures and lower quality (8-bit) sounds to conserve memory. + +- `-NoRenderWindows` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Causes all windows to be fully transparent. Use this option if your card does not correctly render partially-transparent windows. + +- `-superlowmem` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Uses the `-lowmem` settings and further scales down textures to conserve memory. + +- `-vsync` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Turns on Vertical Sync. The flag will be enabled in the registry so it will be on when the game is run again. + +- `-width ` + + **Type:** integer + + **Default:** 640 unless you select a different value in the options menu + + **Platform:** all + + **Description:** Sets the screen resolution to the specified width, if possible. + +- `-windowed` or `-w` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Runs the game in a window. + +### Audio Options + +- `-nomusic` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Disables music. + +- `-nosound` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Disables all sound, including music. + +### Input Options + +- `-deadzone# ` + + **Type:** `#` is either the character `0` or the character `1`. `k` is a floating-point number. + + **Default:** 0.2 + + **Platform:** all + + **Description:** Specifies the size of the deadzone for a joystick. + +- `-mlooksens ` + + **Type:** floating-point number + + **Default:** 9.102 + + **Platform:** all + + **Description:** Determines how much the player moves when the mouse is moved. + +- `-mousesens ` + + **Type:** floating-point number + + **Default:** 1.0 + + **Platform:** all + + **Description:** Adjusts the sensitivity of the mouse when not using mouselook mode. + +- `-nomousegrab` or `-m` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Disable mouse capture. + +### Performance Options + +- `-fastdemo` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Causes a demo to play back at the highest speed your computer is capable of. + +- `-forcelightmaps` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Forces the use of lightmaps, even the Default Detail Level is set to Low in the launcher setup. + +- `-framecap ` + + **Type:** integer + + **Default:** 60 + + **Platform:** all + + **Description:** Limits the framerate to the number of frames per second specified. + +- `-nomotionblur` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Disables motion blur on robots (Pentium III only). + +- `-nosatomega` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Disables alpha saturation on the omega cannon effect. + +- `-nosparkles` + + **Type:** boolean + + **Default:** Off + + **Platform:** all + + **Description:** Disables powerup sparkles (Pentium III only). + +### Multiplayer and Network Options + +- `-audiotauntdelay