Difference between revisions of "Source port parameters"

From DoomWiki.org

[unchecked revision][checked revision]
(Use the same format as Parameters)
m (-join)
(19 intermediate revisions by 4 users not shown)
Line 5: Line 5:
 
  |}
 
  |}
  
Source ports support various extra [[Parameter|command line parameter]]s not found in [[vanilla Doom]]. Below is a list of the most commonly used ones.
+
Source ports support various extra [[Parameter|command line parameter]]s not found in [[vanilla Doom]]. Where not otherwise stated, ports derived from ones listed here usually support their parent ports' command-line parameters, and are therefore not exhaustively listed below.
  
 
=== -1 ===
 
=== -1 ===
 
:''[[PrBoom]]''<br/>
 
:''[[PrBoom]]''<br/>
 
:Prevents window scaling (if it has been activated via an in-game menu). The graphics resolution will be set by the <tt>-height</tt> and <tt>-width</tt> options.
 
:Prevents window scaling (if it has been activated via an in-game menu). The graphics resolution will be set by the <tt>-height</tt> and <tt>-width</tt> options.
 +
 +
=== -<width>x<height>[w] ===
 +
:''[[Doom95]]''<br/>
 +
:Composite parameter specifying display size and, optionally, windowed mode.  The choices are limited to Doom95's supported screen resolutions (320x200, 320x240, 640x400, and 640x480); windowed mode additionally requires {{wp|8-bit color}}.
 +
 +
=== -8in32 ===
 +
:''[[Chocolate Doom]]'', ''[[Eternity Engine]]''<br/>
 +
:Transform the 8-bit screen buffers created by the renderer into 32-bit before display, solving problems that happen otherwise with SDL and modern hardware.
  
 
=== -basewad ===
 
=== -basewad ===
Line 22: Line 30:
 
:''[[PrBoom]]''<br/>
 
:''[[PrBoom]]''<br/>
 
:Causes debugging information related to [[DeHackEd|.deh]] and [[BEX|.bex]] patches to be written to the file <name>.
 
:Causes debugging information related to [[DeHackEd|.deh]] and [[BEX|.bex]] patches to be written to the file <name>.
 +
 +
=== -cmdfrag ===
 +
:''[[Doom95]]''<br/>
 +
:Sets a [[frag]] limit for [[deathmatch]] games.
  
 
=== -complevel <compatibility level> ===
 
=== -complevel <compatibility level> ===
Line 32: Line 44:
  
 
=== -deh <filename> ===
 
=== -deh <filename> ===
:''[[Boom]], [[Doom Legacy]], [[ZDoom]]''<br/>
+
:''[[Boom]], [[Chocolate Doom]], [[Doom Legacy]], [[EDGE]], [[ZDoom]]''<br/>
 
:Loads a [[Dehacked]] file.
 
:Loads a [[Dehacked]] file.
  
Line 54: Line 66:
 
:''[[Boom]]''<br/>
 
:''[[Boom]]''<br/>
 
:Ends a [[deathmatch]] game when one player has achieved a [[frag]] count of <i>num</i>.
 
:Ends a [[deathmatch]] game when one player has achieved a [[frag]] count of <i>num</i>.
 +
 +
=== -game <name> ===
 +
:''[[Doomsday]]'', ''[[Eternity Engine]]''<br/>
 +
:Tells Doomsday to launch straight into a game, rather than entering the Ring Zero GUI. The names Doomsday uses for each game can be viewed in the Ring Zero GUI.
 +
:In the Eternity Engine, this parameter controls which game subfolder to use under the <tt>/base</tt> and <tt>/user</tt> paths. Depending on the end user's setup of their file system, this may launch the requested game.
 +
 +
=== -geom <width>x<height>[w] ===
 +
:''[[Eternity Engine]]'', ''[[PrBoom+]]''
 +
:Allows specification of any supported video mode or window size, overriding any settings stored in the configuration file. Eternity also supports [[eternity_wiki:Geom string |additional optional letter flags]] at the end for controlling vsync, window border, and other low-level video options.
 +
 +
=== -guid ===
 +
:''[[Doom95]]''<br/>
 +
:
  
 
=== -height <num> ===
 
=== -height <num> ===
Line 61: Line 86:
 
=== -host <num> ===
 
=== -host <num> ===
 
:''[[ZDoom]]''<br/>
 
:''[[ZDoom]]''<br/>
:Starts a [[multiplayer]] game for <num> players. The game will wait until the other <num>-1 players join (see -join).
+
:Starts a [[multiplayer]] game for <num> players. The game will wait until the other <num>-1 players join (see <tt>[[#-join <ip>|-join]]</tt>).
  
 
=== -iwad <filename> ===
 
=== -iwad <filename> ===
:''[[Boom]], [[Doom Legacy]], [[ZDoom]]''<br/>
+
:''[[Boom]], [[Chocolate Doom]], [[Doom Legacy]], [[Doomsday]], [[DOSDoom]], [[ZDoom]]''<br/>
:Specifies an [[IWAD]] file to use.
+
:In most ports, specifies an [[IWAD]] file to use.
 +
:In Doomsday, it instead specifies the directory in which IWADs are located. If Doomsday only finds one Iwad at the location, it will automatically launch straight into the game it is for, bypassing the Ring Zero GUI.
 +
:DOSDoom supports using this parameter to specify a directory or a file.
  
 
=== -join <ip> ===
 
=== -join <ip> ===
 
:''[[ZDoom]]''<br/>
 
:''[[ZDoom]]''<br/>
:Joins a multiplayer game being established using <tt>-host</tt>.
+
:Joins a multiplayer game being established using <tt>[[#-host <num>|-host]]</tt>.
  
 
=== -net <hostname> <port> ===
 
=== -net <hostname> <port> ===
Line 78: Line 105:
 
:''[[LxDoom]], [[PrBoom]]''<br/>
 
:''[[LxDoom]], [[PrBoom]]''<br/>
 
:Disables certain types of graphics acceleration in [[Wikipedia:X Window System | X]] (for maximum compatibility during multiplayer games).
 
:Disables certain types of graphics acceleration in [[Wikipedia:X Window System | X]] (for maximum compatibility during multiplayer games).
 +
 +
=== -noautoload ===
 +
:''[[ZDoom]]''<br/>
 +
:Disables autoloading mechanisms existing in ZDoom (autoload section in the configuration file, and skins folder).
 +
 +
=== -noclipper ===
 +
:''[[Doom95]]''<br/>
 +
:
  
 
=== -nodm ===
 
=== -nodm ===
Line 98: Line 133:
 
:''[[PrBoom]]''<br/>
 
:''[[PrBoom]]''<br/>
 
:Prevents mouse "grabbing". The default behavior is to grab the mouse (see <tt>-grabmouse</tt>).
 
:Prevents mouse "grabbing". The default behavior is to grab the mouse (see <tt>-grabmouse</tt>).
 +
 +
=== -nosfxformat ===
 +
:''[[Doom95]]''<br/>
 +
:Disable [[Doom95#Differences between vanilla Doom and Doom95|upsampling of sound effects]].
 +
 +
=== -nowarn ===
 +
:''[[Doom95]]''<br/>
 +
:Skip the dialog box ("Warning: this Doom version has been modified...") when loading a [[PWAD]].
 +
 +
=== -onet ===
 +
:''[[Doom95]]''<br/>
 +
:
 +
 +
=== -penti ===
 +
:''[[Doom95]]''<br/>
 +
:Sets internal "{{wp|Pentium}}" flag, if used the first time the game is ever run.
 +
 +
=== -players ===
 +
:''[[Doom95]]''<br/>
 +
:Specifies the number of players in [[multiplayer]] (2, 3, or 4).
  
 
=== -save <directory> ===
 
=== -save <directory> ===
Line 110: Line 165:
 
:''[[PrBoom+]], [[ZDoom]]''<br/>
 
:''[[PrBoom+]], [[ZDoom]]''<br/>
 
:Specifies a directory for screenshots (the default is the directory which contains the executable).
 
:Specifies a directory for screenshots (the default is the directory which contains the executable).
 +
 +
=== -solo-net ===
 +
:''[[Chocolate Doom]]'', ''[[Eternity Engine]]'', ''[[PrBoom]]''
 +
:Allows beginning a game with [[cooperative]] gameplay rules while only a single player is active. Players can respawn without restarting a level, and extra weapons, items, and enemies which are marked as "multiplayer-only" will spawn in levels, often providing an increase in difficulty beyond the ''Ultra Violence'' [[skill level]].
 +
 +
=== -sysmem ===
 +
:''[[Doom95]]''<br/>
 +
:Forces video surfaces into RAM.
 +
 +
=== -ticdup ===
 +
:''[[Doom95]]''<br/>
 +
:[[Ticdup|Duplicates tic commands]] to reduce latency in modem games.
 +
 +
=== -viddump <filename> ===
 +
:''[[PrBoom+]]''<br/>
 +
:Captures a [[parameter#-timedemo|timedemo]] to a {{wp|Matroska}} file of the given name with {{wp|H.264/MPEG-4 AVC|h264}} video and {{wp|Ogg Vorbis}} audio. Requires external programs to be available in PrBoom+'s own folder. MIDI playback is only recorded if [[FluidSynth]] or [[OPL emulation]] is used.
 +
 +
=== -vidmem ===
 +
:''[[Doom95]]''<br/>
 +
:Keeps video surfaces in graphics memory.
  
 
=== -weirdo <seconds> ===
 
=== -weirdo <seconds> ===
Line 125: Line 200:
 
*{{eterwiki|List_of_command_line_parameters|Eternity Engine command line parameters}}
 
*{{eterwiki|List_of_command_line_parameters|Eternity Engine command line parameters}}
 
*{{zdoomwiki|Command_line_parameters|ZDoom command line parameters}}
 
*{{zdoomwiki|Command_line_parameters|ZDoom command line parameters}}
 +
*[[The "Official" Doom FAQ]] section 9-2
 +
*[http://classicdoom.com/doomparm.htm DOOMPARM.HTM: Common Doom/Doom II/Doom95 Command-line Parameters], at [[ClassicDoom.com]]
 
[[Category:Lists]]
 
[[Category:Lists]]
 
[[Category:Source ports]]
 
[[Category:Source ports]]

Revision as of 11:30, 19 March 2014

For a list of command line parameters in original Doom games and for general information on Doom parameters, see the main parameters article.

Source ports support various extra command line parameters not found in vanilla Doom. Where not otherwise stated, ports derived from ones listed here usually support their parent ports' command-line parameters, and are therefore not exhaustively listed below.

-1

PrBoom
Prevents window scaling (if it has been activated via an in-game menu). The graphics resolution will be set by the -height and -width options.

-<width>x<height>[w]

Doom95
Composite parameter specifying display size and, optionally, windowed mode. The choices are limited to Doom95's supported screen resolutions (320x200, 320x240, 640x400, and 640x480); windowed mode additionally requires 8-bit color.

-8in32

Chocolate Doom, Eternity Engine
Transform the 8-bit screen buffers created by the renderer into 32-bit before display, solving problems that happen otherwise with SDL and modern hardware.

-basewad

Doom95
Specifies an IWAD file to use.

-beta

MBF
Emulates the Doom press release beta.

-bexout <name>

PrBoom
Causes debugging information related to .deh and .bex patches to be written to the file <name>.

-cmdfrag

Doom95
Sets a frag limit for deathmatch games.

-complevel <compatibility level>

PrBoom
Toggles various bug fixes and enhanced features for maximum compatibility with other (related) source ports. A compatibility level of -1 means that all enhanced features and bug fixes are available, while 0 through 4 correspond to vanilla Doom, 5 corresponds to DOSDoom, 6 corresponds to TASDOOM, 7 through 9 correspond to Boom, 10 corresponds to LxDoom, 11 corresponds to MBF, and 12 through 17 emulate earlier versions of PrBoom.

-config <name>

ZDoom
Uses the specified file as the config file.

-deh <filename>

Boom, Chocolate Doom, Doom Legacy, EDGE, ZDoom
Loads a Dehacked file.

-dogs <num>

MBF
Overrides the current number of helper dogs, setting it to num.

-emulate

Doom95
Disables DirectDraw acceleration and vertical synchronization.

-fastdemo

Boom, PrBoom
Similar to -timedemo, but faster.

-ffmap <l>

PrBoom
When used with -playdemo, causes the demo to play at -fastdemo speed until it reaches level l of any episode, then slow down to normal speed. Ignored in the presence of -timedemo.

-frags <num>

Boom
Ends a deathmatch game when one player has achieved a frag count of num.

-game <name>

Doomsday, Eternity Engine
Tells Doomsday to launch straight into a game, rather than entering the Ring Zero GUI. The names Doomsday uses for each game can be viewed in the Ring Zero GUI.
In the Eternity Engine, this parameter controls which game subfolder to use under the /base and /user paths. Depending on the end user's setup of their file system, this may launch the requested game.

-geom <width>x<height>[w]

Eternity Engine, PrBoom+
Allows specification of any supported video mode or window size, overriding any settings stored in the configuration file. Eternity also supports additional optional letter flags at the end for controlling vsync, window border, and other low-level video options.

-guid

Doom95

-height <num>

PrBoom
Sets vertical screen resolution to num pixels (the default is 200). If -2 or -3 is also used, it will multiply this value accordingly.

-host <num>

ZDoom
Starts a multiplayer game for <num> players. The game will wait until the other <num>-1 players join (see -join).

-iwad <filename>

Boom, Chocolate Doom, Doom Legacy, Doomsday, DOSDoom, ZDoom
In most ports, specifies an IWAD file to use.
In Doomsday, it instead specifies the directory in which IWADs are located. If Doomsday only finds one Iwad at the location, it will automatically launch straight into the game it is for, bypassing the Ring Zero GUI.
DOSDoom supports using this parameter to specify a directory or a file.

-join <ip>

ZDoom
Joins a multiplayer game being established using -host.

-net <hostname> <port>

PrBoom
Starts a network game using the UDP/IP protocol, by connecting to the machine hostname via port number port. (The port number may be omitted, in which case port 5030 is used.)

-noaccel

LxDoom, PrBoom
Disables certain types of graphics acceleration in X (for maximum compatibility during multiplayer games).

-noautoload

ZDoom
Disables autoloading mechanisms existing in ZDoom (autoload section in the configuration file, and skins folder).

-noclipper

Doom95

-nodm

Doom95
Bypasses the GUI launcher (command line arguments will not work with Doom95 otherwise).

-nodrawers

PrBoom
Identical to -nodraw.

-nojoy

PrBoom, ZDoom
Disables joystick input.

-noload

MBF
Starts a game without loading any of the default PWADs or executable patches (defined within an in-game menu).

-nomouse

PrBoom
Prevents mouse "grabbing". The default behavior is to grab the mouse (see -grabmouse).

-nosfxformat

Doom95
Disable upsampling of sound effects.

-nowarn

Doom95
Skip the dialog box ("Warning: this Doom version has been modified...") when loading a PWAD.

-onet

Doom95

-penti

Doom95
Sets internal "Pentium" flag, if used the first time the game is ever run.

-players

Doom95
Specifies the number of players in multiplayer (2, 3, or 4).

-save <directory>

Boom, PrBoom
Specifies a directory for saved games (the default is the directory which contains the executable).

-savedir <directory>

ZDoom
Specifies a directory for saved games (the default is the directory which contains the executable).

-shotdir <directory>

PrBoom+, ZDoom
Specifies a directory for screenshots (the default is the directory which contains the executable).

-solo-net

Chocolate Doom, Eternity Engine, PrBoom
Allows beginning a game with cooperative gameplay rules while only a single player is active. Players can respawn without restarting a level, and extra weapons, items, and enemies which are marked as "multiplayer-only" will spawn in levels, often providing an increase in difficulty beyond the Ultra Violence skill level.

-sysmem

Doom95
Forces video surfaces into RAM.

-ticdup

Doom95
Duplicates tic commands to reduce latency in modem games.

-viddump <filename>

PrBoom+
Captures a timedemo to a Matroska file of the given name with h264 video and Ogg Vorbis audio. Requires external programs to be available in PrBoom+'s own folder. MIDI playback is only recorded if FluidSynth or OPL emulation is used.

-vidmem

Doom95
Keeps video surfaces in graphics memory.

-weirdo <seconds>

Doom95
Items respawn after a specified time.

-width <num>

PrBoom
Sets horizontal screen resolution to num pixels (the default is 320). If -2 or -3 is also used, it will multiply this value accordingly.

External links