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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +### 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