Command line options: Difference between revisions

From EDukeWiki
Jump to navigation Jump to search
No edit summary
Updated documentation to what is present in the current eduke32 revisions, added more information and improved formatting.
Line 1: Line 1:
Usage: eduke32 [files] [options]<br>
Example: eduke32 -q4 -a -m -tx -map nukeland.map


Files can be *.grp/zip/con/def
= EDuke32 Parameters =
 
Usage: <code>eduke32 [files] [options]</code><br>
Example: <code>eduke32 nukeland.map -usecwd -cfg myconfig.cfg </code>
 
Files can be of types <code>{grp | zip | pk3 | pk4 | map | con | def | rts}</code>.
* Specifying a <code>{grp|zip|pk3|pk4}</code> file is equivalent to using the <code>-g</code> parameter.
* If a .map file is specified, it is immediately loaded and launched as a usermap (equivalent to <code>-map</code>).
* If a .con file is specified, it replaces <code>GAME.CON</code> (equivalent to <code>-x</code>).
* If a .def file is specified, it is used as the main DEF file (equivalent to <code>-h</code>).
* If a .rts file is specified, it is used as the main RTS soundbank (equivalent to <code>-rts</code>).


{| {{prettytable}}
{| {{prettytable}}
!Command!!Description!!Notes!!
!Parameter!!Description!!Notes!!
|-
| <code>-?</code><br><code>--help</code>
|Displays a help message listing the available parameters, then exits.
|
|-
|-
| -addon [0,1,2,3]
| <code> -addon {0,1,2,3}</code>
|Use one of the Megaton-edition packaged addons for duke3d
| Launch one of the addons for Duke 3D (if present), packaged with the Megaton Edition release.
| 0 = none, 1 = Duke it out in D.C., 2 = Duke: Nuclear Winter, 3 = Duke Caribbean: Life's a Beach
| 0 = none, 1 = Duke it out in D.C., 2 = Duke: Nuclear Winter, 3 = Duke Caribbean: Life's a Beach
|-
|-
| -cfg [file.cfg]
| <code>-cachesize [size]</code>
|Use an alternate configuration file
|Sets initial cache size, in kilobytes. Usually not needed, as cache size is adjusted dynamically.
| See also [[cachesize_(DEF)| cachesize (DEF)]].
|-
| <code>-cfg [cfg_path]</code>
|Use an alternate configuration file. (default is "eduke32.cfg")
|
|-
| <code>-clipmap [file.map]</code>
|Load an additional clipping map to define physical geometry for sprites, voxels and 3d models, for use with [[clipshape]].
|-
| <code>-d [file.edm][:arg1,arg2]</code>
| Plays an eduke32 demo. Can take optional parameters "arg1" and "arg2" which represent "frames per tic" and "number of repeats" respectively, and are used for debug performance profiling.
| By default, the game plays a loop starting at <code>edemo001.dem</code>.
|-
| <code>-debughelp</code>
|Displays debug parameters and exits.
|
|-
| <code>-game_dir [dir]</code>
| Duke3d_w32 compatibility option. Set the directory from which to load files, which also changes where the cfg is created.
| See also '-j'
|-
| <code> -gamegrp [file.grp]</code>
|Selects which file to use as main grp.
|
|-
| <code>-grp [path]</code><br><code>-g [path]</code>
| Use an extra group (or .pk3 or .zip) file to load data from.
|
|
|-
|-
| -clipmap [file.map]
| <code>-h [file.def]</code>
|Load an additional clipping map for use with clipshape
| Specify the main DEF file.
| By default uses 'duke3d.def' if present in the folder.
|-
|-
| -c#
| <code>-j [dir]</code>
|Use MP mode #, 1 = Dukematch, 2 = Co-op, 3 = Dukematch (no spawn)
|Adds a directory to EDuke32's search list. Does not alter the directory for config files.
|
|
|-
|-
| -d [file.edm]
| <code> -map [file.map]</code>
|Play a demo
| Starts the specified usermap on launch.
|
|
|-
|-
| -g [file.grp/.zip]
| <code> -mh [file.def]</code>
|Use an extra group file
|Include an additional DEF module, appended after the main DEF code.
|
|
|-
|-
| -h [file.def]
| <code>-mx [file.con]</code>
|Use an alternate def
|Include an additional CON script module, appended after the GAME.CON code.
|
|
|-
|-
| -j [dir]
| <code>-m</code>
|Adds a directory to EDuke32's search list
|Disable monsters ([[m_monsters_off]] = 1) and sets [[m_player_skill]] and [[player_skill]] to 0.
|
|
|-
|-
| -l#
| <code>-nam</code><br><code>-napalm</code><br><code>-ww2gi</code>
|Warp to level #
|Run in [[NAM]] or [[WWII GI]] -compatible mode.
|see -v
|
|-
|-
| -map [file.map]
| <code>-noautoload</code>
|Loads a map
| Disable loading content from the [[autoload]] directory.
|
|
|-
|-
| -mh [file.def]
| <code>-nodinput</code>
|Include an additional def module
| Disable DirectInput (joystick) support.
|
|
|-
|-
| -mx [file.con]
| <code>-noinstancechecking</code>
|Include an additional CON script module
| Prevents eduke32 from checking whether another instance is already running.
|
|
|-
|-
| -m
| <code>-nologo</code> <br> <code>-quick</code>
|Disable monsters
|Skip all the startup animations and logos.
|
|
|-
|-
| -nam<br>-ww2gi
| <code>-nosteam</code>
|Run in [[NAM]] or [[WWII GI]] -compatible mode
| Disables Steam community API integrations (such as achievements) if binary is compiled with parameter EDUKE32_STANDALONE.
| Currently only relevant for [[Ion Fury]] builds.
|-
| <code>-ns -nm </code>
| Disable sound and music respectively.
|
|
|-
|-
| -server
| <code>-r</code>
|Start multiplayer server
| Enables demo recording.
|(see [[multiplayer]])
|
|-
|-
| -r
| <code>-rotatesprite-no-widescreen</code>
|Record demo
| Debug parameter. If set, screen tiles (such as weapons) logos and menu tiles will be stretched horizontally.
|
|
|-
|-
| -s#
| <code>-s# </code>
|Set skill level (1-4)
| Set the skill level (0-4). Cannot exceed 4 even when more skill levels are defined. Setting this to 4 is hardcoded to enable [[respawn_monsters]] and [[m_respawn_monsters]], regardless of what the skill itself defines.
|
|
|-
|-
| -setup<br>-nosetup
| <code>-setup</code><br><code>-nosetup</code>
|Enables/disables startup window
|Enables/disables startup window
|[only on Windows, SDL, and/or GTK2 environments]
|[only on Windows, SDL, and/or GTK2 environments]
|-
|-
| -t#
| <code>-t#</code>
|Set respawn mode: 1 = Monsters, 2 = Items, 3 = Inventory, x = All
|Set respawn mode: 1 = Monsters, 2 = Items, 3 = Inventory, x = All
|
|
|-
|-
| -usecwd
| <code>-usecwd</code>
|Read game data and configuration file from working directory
| Force eduke32 to read game data and configuration files from working directory.
|
| See also [[user_profiles_disabled]].
|-
|-
| -u#########
| <code>-u#########</code>
|User's favorite weapon order
| Define the weapon switch order, as a string of 10 digits.
|(default: 3425689071)
|(Default: <code>3425689071</code>)
|-
|-
| -v#
| <code>-v[X] -l[Y]</code>
|Warp to volume #
| Warp to episode X, level Y if used together. If either is omitted, then warp assumes episode 1, resp. level 1.
|see -l
|-
| -x [game.con]
|Load custom CON script
|
|
|-
|-
| -#
| <code>-w</code>
|Load and run a game from slot # (0-9)
|Show coordinates as well as other debug information, including current sector num, lotag and hitag.
|
|
|-
|-
| -?<br>--help
| <code>-x [game.con]</code>
|Display this help message and exit
| Replace the main GAME.CON with the specified script file.
|
|
|-
|-
| -debughelp
| <code>-z# </code><br><code>-condebug</code>
|Display debug parameters message and exit
|Enable line-by-line CON compile debugging at level #, and print the number of labels, variables and arrays used.
|
|
|}
== Multiplayer Parameters ==
Note: Multiplayer is currently non-functional in mainline eduke32. For a working implementation, see [https://voidpoint.io/StrikerTheHedgefox/eduke32-csrefactor/-/releases EDuke32-OldMP].
The corresponding parameters are listed here for the sake of completeness.
{| {{prettytable}}
!Parameter!!Description!!Notes!!
|-
|-
| -a
| <code>-a</code>
|Use fake player AI (fake multiplayer only)
| Use fake player AI (dukebots) (fake multiplayer only).
|
| Sets [[playerai]] to 1, which doesn't do anything as of r9392.
|-
|-
| -cachesize #
| <code>-c#</code>
|Sets cache size, in Kb
| Changes the value of [[m_coop]] to set the multiplayer mode.
|
|
|-
|-
| -fNUM
| <code>-connect [ip]</code>
|Send fewer packets in multiplayer (1, 2, 4)
| Connect to the specified IP address.
|(deprecated)
|(see [[multiplayer]])
|-
|-
| -game_dir [dir]
| <code>-dedicated</code>
|Duke3d_w32 compatibility option
| Start eduke32 in dedicated server mode.
|see -j
|(see [[multiplayer]])
|-
|-
| -gamegrp 
| <code>-name [name]</code>
|Selects which file to use as main grp
| Set the player name on startup. Can also be changed ingame.
|
|
|-
|-
| -i#
| <code>-net</code>
|Use networking mode (1/0)
| Legacy P2P networking.
| Disabled as of r9392. Will exit with an error message.
|-
| <code>-noffire</code>
| Disables friendly fire in coop games (i.e. [[m_ffire]] set to 0).
|
|
|-
|-
| -name [name]
| <code>-password [pw]</code>
|Player name in multiplay
| Password required to authenticate when connecting to server. Default is no password.
|
|
|-
|-
| -nD
| <code>-port</code>
|Dump default gamevars to gamevars.txt
| Specify which UDP port to use for hosting the game or connecting.
|
|
|-
|-
| -noautoload
| <code>-q#</code>
|Disable loading content from autoload dir
| Fake multiplayer with # (2-16) players.
|
|
|-
|-
| -nologo
| <code>-rts [file.rts]</code>
|Skip the logo anim
| Use the specified RTS soundbank for remote ridicule sounds.
|
| Defaults: {DUKE.RTS, NAM.RTS, NAPALM.RTS, WW2GI.RTS}
|-
| <code>-server</code>
| Start multiplayer server for network games.
|(see [[multiplayer]])
|}
 
 
== Removed Parameters ==
 
The following parameters used to exist, but are no longer referenced in current eduke32 revisions.
 
{| {{prettytable}}
!Parameter!!Description!!Notes!!
|-
|-
| -ns<br>-nm
| <code>-stun</code>
|Disable sound or music
| Use UDP hole punching for multiplayer connections.
|
|
|-
|-
| -q#
| <code>-#</code>
|Fake multiplayer with # (2-8) players
| Load and run a game from slot # (0-9)
|
| EDuke32 no longer uses a fixed number of save slots, hence no longer works.
|-
|-
| -rmnet
| <code>-rmnet</code>
|Use network config file
| Use network config file.
|(OBSOLETE, see -net)
| (OBSOLETE, see -net)
|-
|-
| -stun
| <code>-i#</code>
|Use UDP hole punching for multiplayer connections
| Use networking mode (1/0)
|
|
|-
|-
| -w
| <code>-nD</code>
|Show coordinates
| Dump default gamevars to gamevars.txt
|
|
|-
|-
| -z#<br>-condebug
| <code>-f#</code>
|Enable line-by-line CON compile debugging at level #
|Send fewer packets in multiplayer (1, 2, 4)
|
|(deprecated)
|-
|}
|}

Revision as of 10:27, 22 June 2021

EDuke32 Parameters

Usage: eduke32 [files] [options]
Example: eduke32 nukeland.map -usecwd -cfg myconfig.cfg

Files can be of types {grp | zip | pk3 | pk4 | map | con | def | rts}.

  • Specifying a {grp|zip|pk3|pk4} file is equivalent to using the -g parameter.
  • If a .map file is specified, it is immediately loaded and launched as a usermap (equivalent to -map).
  • If a .con file is specified, it replaces GAME.CON (equivalent to -x).
  • If a .def file is specified, it is used as the main DEF file (equivalent to -h).
  • If a .rts file is specified, it is used as the main RTS soundbank (equivalent to -rts).
Parameter Description Notes
-?
--help
Displays a help message listing the available parameters, then exits.
-addon {0,1,2,3} Launch one of the addons for Duke 3D (if present), packaged with the Megaton Edition release. 0 = none, 1 = Duke it out in D.C., 2 = Duke: Nuclear Winter, 3 = Duke Caribbean: Life's a Beach
-cachesize [size] Sets initial cache size, in kilobytes. Usually not needed, as cache size is adjusted dynamically. See also cachesize (DEF).
-cfg [cfg_path] Use an alternate configuration file. (default is "eduke32.cfg")
-clipmap [file.map] Load an additional clipping map to define physical geometry for sprites, voxels and 3d models, for use with clipshape.
-d [file.edm][:arg1,arg2] Plays an eduke32 demo. Can take optional parameters "arg1" and "arg2" which represent "frames per tic" and "number of repeats" respectively, and are used for debug performance profiling. By default, the game plays a loop starting at edemo001.dem.
-debughelp Displays debug parameters and exits.
-game_dir [dir] Duke3d_w32 compatibility option. Set the directory from which to load files, which also changes where the cfg is created. See also '-j'
-gamegrp [file.grp] Selects which file to use as main grp.
-grp [path]
-g [path]
Use an extra group (or .pk3 or .zip) file to load data from.
-h [file.def] Specify the main DEF file. By default uses 'duke3d.def' if present in the folder.
-j [dir] Adds a directory to EDuke32's search list. Does not alter the directory for config files.
-map [file.map] Starts the specified usermap on launch.
-mh [file.def] Include an additional DEF module, appended after the main DEF code.
-mx [file.con] Include an additional CON script module, appended after the GAME.CON code.
-m Disable monsters (m_monsters_off = 1) and sets m_player_skill and player_skill to 0.
-nam
-napalm
-ww2gi
Run in NAM or WWII GI -compatible mode.
-noautoload Disable loading content from the autoload directory.
-nodinput Disable DirectInput (joystick) support.
-noinstancechecking Prevents eduke32 from checking whether another instance is already running.
-nologo
-quick
Skip all the startup animations and logos.
-nosteam Disables Steam community API integrations (such as achievements) if binary is compiled with parameter EDUKE32_STANDALONE. Currently only relevant for Ion Fury builds.
-ns -nm Disable sound and music respectively.
-r Enables demo recording.
-rotatesprite-no-widescreen Debug parameter. If set, screen tiles (such as weapons) logos and menu tiles will be stretched horizontally.
-s# Set the skill level (0-4). Cannot exceed 4 even when more skill levels are defined. Setting this to 4 is hardcoded to enable respawn_monsters and m_respawn_monsters, regardless of what the skill itself defines.
-setup
-nosetup
Enables/disables startup window [only on Windows, SDL, and/or GTK2 environments]
-t# Set respawn mode: 1 = Monsters, 2 = Items, 3 = Inventory, x = All
-usecwd Force eduke32 to read game data and configuration files from working directory. See also user_profiles_disabled.
-u######### Define the weapon switch order, as a string of 10 digits. (Default: 3425689071)
-v[X] -l[Y] Warp to episode X, level Y if used together. If either is omitted, then warp assumes episode 1, resp. level 1.
-w Show coordinates as well as other debug information, including current sector num, lotag and hitag.
-x [game.con] Replace the main GAME.CON with the specified script file.
-z#
-condebug
Enable line-by-line CON compile debugging at level #, and print the number of labels, variables and arrays used.

Multiplayer Parameters

Note: Multiplayer is currently non-functional in mainline eduke32. For a working implementation, see EDuke32-OldMP.

The corresponding parameters are listed here for the sake of completeness.

Parameter Description Notes
-a Use fake player AI (dukebots) (fake multiplayer only). Sets playerai to 1, which doesn't do anything as of r9392.
-c# Changes the value of m_coop to set the multiplayer mode.
-connect [ip] Connect to the specified IP address. (see multiplayer)
-dedicated Start eduke32 in dedicated server mode. (see multiplayer)
-name [name] Set the player name on startup. Can also be changed ingame.
-net Legacy P2P networking. Disabled as of r9392. Will exit with an error message.
-noffire Disables friendly fire in coop games (i.e. m_ffire set to 0).
-password [pw] Password required to authenticate when connecting to server. Default is no password.
-port Specify which UDP port to use for hosting the game or connecting.
-q# Fake multiplayer with # (2-16) players.
-rts [file.rts] Use the specified RTS soundbank for remote ridicule sounds. Defaults: {DUKE.RTS, NAM.RTS, NAPALM.RTS, WW2GI.RTS}
-server Start multiplayer server for network games. (see multiplayer)


Removed Parameters

The following parameters used to exist, but are no longer referenced in current eduke32 revisions.

Parameter Description Notes
-stun Use UDP hole punching for multiplayer connections.
-# Load and run a game from slot # (0-9) EDuke32 no longer uses a fixed number of save slots, hence no longer works.
-rmnet Use network config file. (OBSOLETE, see -net)
-i# Use networking mode (1/0)
-nD Dump default gamevars to gamevars.txt
-f# Send fewer packets in multiplayer (1, 2, 4) (deprecated)