From e533f595589e56f7ca46d6f99d8f91ec59128d40 Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Sun, 6 Oct 2024 09:10:46 -0400 Subject: [PATCH] =?UTF-8?q?Import=20wiki=E2=80=99s=20CLI=20docs=20into=20U?= =?UTF-8?q?SAGE.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 | 448 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 434 insertions(+), 14 deletions(-) diff --git a/USAGE.md b/USAGE.md index c1edbd6c8..346d29237 100644 --- a/USAGE.md +++ b/USAGE.md @@ -35,17 +35,437 @@ Descent 3 Message(Error: Couldn't find the string table.) 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 - -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 | -| `-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 | +## 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionTypeDefaultPlatformDescription
Display Options
-aspect <value>floating-point number1.3333333333333333allSpecifies the screen aspect ratio for non-standard displays, such as wide-screen TVs.
-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).