Difference between revisions of "Command-line parameters"

From RRU Knowledge Base
m
m (Added note about -window parameter)
(41 intermediate revisions by 4 users not shown)
Line 1: Line 1:
'''<!--Executable-->Command-line parameters''', also called '''arguments'''<!--command-line options, flags, or switches,--> are options for the initial execution of software. These options are commonly supplied in a command-line window or shortcut, and always come after the executable's file name. Available parameters, syntax, and effect all depend on the game or software they are used with. A common use for these options is for running games in debug mode or different resolutions.
'''<!--Executable-->Command-line parameters''', also called '''arguments''', '''flags''',
or '''switches''', are options for the initial execution of software. These options are commonly supplied in a command-line window or shortcut, and always come after the executable's file name. Available parameters, syntax, and effect all depend on the game or software they are used with. A common use for these options is for running games in debug mode or different resolutions.


For further detail, see the [[Wikipedia:Command-line interface#Arguments|Wikipedia article]].
Example:
{{todo|Flesh out. Would it be better to name this Command-line arguments?}}
<pre>"C:\Program Files\OldGame\Game.exe" -firstoption -secondoption</pre>
=== Example ===
<pre>"C:\Program Files\NewGame\Game.exe" /FIRSTOPTION /SECONDOPTION</pre>
<pre>C:\Program Files\Game\Game.exe -firstoption -secondoption</pre>
 
{{dablink|For further information, see [[Wikipedia:Command-line interface#Arguments|Command-line interface § Arguments]] on Wikipedia.}}
 
Currently, five LEGO video games for Windows are known to have command-line parameters:


==''LEGO Racers''==
==''LEGO Racers''==
There are seven command-line parameters in the 1999 version of ''[[LEGO Racers]]'', and eight in the 2001 version. Entering an incorrect parameter will cause ''LEGO Racers'' to terminate its launch and open an error message box, which displays a list of all parameters and their functions (except for {{nowrap|<kbd>-fov</kbd>}}).
{| class="wikitable" border="1"
|-
! Argument
! Effect
|-
| {{nowrap|-{{text anchor|alphatrans}}}}
| Forces use of alpha transparency
|-
| {{nowrap|-{{text anchor|horzres}} [res]}}
| Sets the value in pixels for horizontal display resolution. Replace <kbd>[res]</kbd> with an integer.
|-
| -{{text anchor|novideo}}
| Disables playback of opening videos
|-
| -{{text anchor|primary}}
| Forces use of primary display device. This parameter will be ignored if {{nowrap|<kbd>-select3d</kbd>}} is also used.
|-
| -{{text anchor|select3d}}
| Allows display driver and Direct3D device selection before the game launches ''(may not work with the Japanese version)''{{verify}}
|-
| {{nowrap|-{{text anchor|vertres}} [res]}}
| Sets the value in pixels for vertical display resolution. Replace <kbd>[res]</kbd> with an integer.
|-
| -{{text anchor|windowLR|window}}
| Allows the game to be launched in a window when in 16-bit color depth. The window will minimize if focus is lost.
|-
! colspan=2 | The following parameter only works with the 2001 version
|-
| -{{text anchor|fov}} [deg]
| Sets the value in degrees for the in-game camera's field of view. Replace <kbd>[deg]</kbd> with an integer. <kbd>90</kbd> is the default value. Values above <kbd>180</kbd> will invert the field of view. Values of <kbd>360</kbd> and onward can be used, but will be read as their coterminal equivalent below 360 degrees (e.g. 450=90).
|}
==''LEGO Racers 2''==
There are twenty-six command-line parameters in ''[[LEGO Racers 2]]''.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! scope="col" style="width: 120px;" | Argument
! Argument
! Effect
! Effect
|-
|-
| -alphatrans
| /{{text anchor|backlevel}}
| Force use of alpha transparency
| ''Untested''
|-
| /{{text anchor|bpp}}
| ''Untested''
|-
| /{{text anchor|cars}}
| ''Untested''
|-
| /{{text anchor|device}}
| ''Untested''
|-
| /{{text anchor|explore}}
| When any track is selected to race on, the player will be taken to explore mode in that track's world instead
|-
| /{{text anchor|foyer}}
| When any track is selected to race on, the player will be taken to the track's world's foyer instead (except for [[Sandy Bay]], which has no foyer and forces the player into explore mode)
|-
| /{{text anchor|height}} [res]
| Sets the value in pixels for vertical display resolution. Replace <kbd>[res]</kbd> with an integer.
|-
| /{{text anchor|highqualitysound}}
| ''Untested''
|-
| /{{text anchor|hz}}
| ''Untested, may not be in all versions''
|-
| /{{text anchor|levelname}}
| ''Untested''
|-
| /{{text anchor|loadcontroldata}}
| ''Untested''
|-
| /{{text anchor|lowqualitysound}}
| ''Untested''
|-
| /{{text anchor|nomusicLR2|nomusic}}
| Disables in-game music
|-
| /{{text anchor|nosfx}}
| Mutes all audio. '''Attempting to start a new adventure will crash the game.'''
|-
| /{{text anchor|options}}
| An options window appears on game start
|-
| /{{text anchor|overdraw}}
| Makes all polygons translucent, showing how many layers are overlapping
|-
| /{{text anchor|racers}} [range]
| Changes the number of racers. Replace <kbd>[range]</kbd> with an integer between 1 and 8
|-
| /{{text anchor|script}}
| ''Untested''
|-
| /{{text anchor|startpos}}
| Changes your starting position
|-
|-
| -horzres [res]
| /{{text anchor|track}}
| Set horizontal resolution<br />Replace <code>[res]</code> with an integer
| ''Untested''
|-
|-
| -fov
| /{{text anchor|width}} [res]
| ''Unknown''
| Sets the value in pixels for horizontal display resolution. Replace <kbd>[res]</kbd> with an integer.
|-
|-
| -novideo
| /{{text anchor|windowed}}
| Disables startup videos
| Allows the game to be launched in a window
|-
|-
| -primary
| /{{text anchor|windowx}}
| Force use of primary display device
| ''Untested''
|-
|-
| -select3d
| /{{text anchor|windowy}}
| Allows 3D device selection
| ''Untested''
|-
|-
| -vertres [res]
| /{{text anchor|wireframe}}
| Set vertical resolution<br />Replace <code>[res]</code> with an integer
| Displays all graphics in wireframe mode
|-
|-
| -window
| /{{text anchor|savecontroldata}}
| Run in windowed mode (16-bit depth only). However, it minimizes if it is clicked out of.
| ''Untested''
|}
|}


==''LEGO Rock Raiders''==
==''LEGO Rock Raiders''==
There are twenty-four command-line parameters in [[LEGO Rock Raiders (video game)|''LEGO Rock Raiders'']].
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! scope="col" style="width: 160px;" | Argument
! Argument
! Effect
! Effect
|-
|-
| -best
| -{{text anchor|best}}
| Launches the game with maximum graphics settings, skipping the Mode Selection prompt
| Launches the game with maximum graphics settings, skipping the Mode Selection prompt
|-
|-
| -cleansaves
| -{{text anchor|cleansaves}}
| Deletes all saved games
| Deletes all saved games
|-
|-
| -debug
| -{{text anchor|debug}}
| Allows for display resolutions of 640x480, 800x600, or 1024x768 to be selected; without extensive edits to [[Lego.cfg]], selecting either of the latter options will cause a crash
| Allows for display resolutions of 640x480, 800x600, or 1024x768 to be selected. However, only the positions and dimensions of interface items for a 640x480 resolution are defined in [[Lego.cfg]] by default; without extensive edits to designate coordinates for the latter two resolutions, selecting either of those options will cause the game to immediately crash. ''(Does not enable debug mode)''
|-
|-
| -debugcomplete
| -{{text anchor|debugcomplete}}
| ''Unknown''
| Allows for display resolutions of 640x480, 800x600, or 1024x768 to be selected. However, only the positions and dimensions of interface items for a 640x480 resolution are defined in [[Lego.cfg]] by default; without extensive edits to designate coordinates for the latter two resolutions, selecting either of those options will cause the game to immediately crash. ''(Does not enable debug mode)''
''Seems to have the same effect as <code>-debug</code>.  Further research needed.''
 
|-
|-
| -dualmouse
| -{{text anchor|dualmouse}}
| ''Unknown''
| Enables seperate detection of left and right mouse button presses.
|-
|-
| -flags
| -{{text anchor|flags}}
| Followed with an integer to turn on certain debug feature{{Needs evidence}}
| Followed with an integer to "turn on certain debug features"<ref name="karlwhite">https://www.rockraidersunited.com/topic/2132-wow-people-i-am-both-stunned-and-impressed/?page=7&tab=comments#comment-45108</ref>{{Needs evidence}}
|-
|-
| -fpslock
| -{{text anchor|fpslock}}
| Enables VSync, which locks the frame rate to the monitor refresh rate when running in a window
| Enables VSync, which locks the frame rate to the monitor refresh rate when running in a window
|-
|-
| -ftm
| -{{text anchor|ftm}}
| Forces video card to use all available texture memory and disables in-game dynamic lighting (except for walls)
| Forces the video card to use all available texture memory and disables in-game dynamic lighting (except for walls)
|-
|-
| -fvf
| -{{text anchor|fvf}}
| Creates a gradual fog effect while in eye view or shoulder view
| Creates a gradual fog effect while in eye view or shoulder view
|-
|-
| -insistOnCD
| -{{text anchor|insistOnCD}}
| Make the game request the disc before it starts
| Makes the game request the disc before it starts
|-
|-
| -nom
| -{{text anchor|nm}}
| Disables texture management for Voodoo2 based cards
| Disables texture management for [[Wikipedia:Voodoo2|Voodoo2]]-based cards. Incorrectly listed as {{nowrap|<kbd>-nom</kbd>}} in the readme file.
|-
|-
| -nosound
| -{{text anchor|nosound}}
| Mutes all in-game sound
| Mutes all in-game sound
|-
|-
| -programmer
| -{{text anchor|programmer}}
| Enables [[Debug keys#LEGO Rock Raiders|debug keys]] and allows the opening logos to be skipped
| Enables [[Debug keys#LEGO Rock Raiders|debug keys]] and allows the opening logos to be skipped
|-
|-
| -reduceanimation
| {{nowrap|-{{text anchor|reduceanimation}}}}
| Disables the rockfall transition animation in the main menu
| Disables the rockfall transition animation in the main menu
|-
|-
| -reduceflics
| -{{text anchor|reduceflics}}
| Disables all FLIC animations
| Disables all [[FLIC file|FLIC animations]]
|-
|-
| -reduceimages
| -{{text anchor|reduceimages}}
| Texture sizes are halved at load time, reducing the memory overhead
| Texture sizes are halved at load time, reducing the memory overhead<ref name="karlwhite"/>
|-
|-
| -reducepromeshes
| {{nowrap|-{{text anchor|reducepromeshes}}}}
| Reduces the number of LOD meshes
| Reduces the number of LOD meshes<ref name="karlwhite"/>
|-
|-
| -reducesamples
| -{{text anchor|reducesamples}}
| Disables sounds on the menu (except for clicking and music), voices (except for Chief's briefings), and cave ambiance. Streamed sounds are unaffected.
| Disables sounds on the menu (except for clicking and music), voices (except for Chief's briefings), and cave ambiance. Streamed sounds, such as the aforementioned music and briefings, are unaffected.
|-
|-
| -reward
| -{{text anchor|reward}}
| Disables [[Chief]]'s animation on the reward screen
| Disables [[Chief]]'s animation on the reward screen
|-
|-
| -showversion
| -{{text anchor|showversion}}
| Displays the game's version number (V.0.121) in the bottom-right corner of the main menu, level select, and pause menu
| Displays the game's version number (V.0.121) in the bottom-right corner of the main menu, level select, and pause menu
|-
|-
| -startlevel
| -{{text anchor|startlevel}}
| Launches the game directly into a level{{Needs evidence}}
| Launches the game directly into a level; requires a level identifier be used in the format of <code>Levels::Levels10</code>.  Note that in order for this to work, the <code>FrontEnd</code> property in the [[Config documentation|config file]] must be set to <code>FALSE</code>.<ref name="karlwhite"/>
|-
|-
| -testercall
| -{{text anchor|testercall}}
| Unlocks all levels at start
| Unlocks all levels at start, same as <code>-testlevels</code><ref name="karlwhite"/><!--testicle-->
|-
|-
| -testlevels
| -{{text anchor|testlevels}}
| Unlocks all levels at start
| Unlocks all levels at start.
|-
|-
| -window
| -{{text anchor|windowLRR|window}}
| Allows the game to be launched in a window when in 16-bit color mode
| Allows the game to be launched in a window when in 16-bit color mode. This is only applicable when used with the <code>-best</code> parameter. 
|}
|}
==''LEGO Stunt Rally''==
These parameters must be used in a shortcut to ''_msr.exe'', not ''StuntRally.exe''
*0.3.5.1 is the version number for the original release of the game.
*0.3.8.1 is the version number for the later, more common releases of the game, as well as the Japanese demo by Eidos.
*0.4.0.7 is the version number for all other demo versions of the game.
{| class="wikitable" border="1"
|-
! scope="col" style="width: 120px;" | Argument
! Effect
|-
| /{{text anchor|FREEFORM}}
| Disables automatic steering
|-
| /{{text anchor|FROMLAUNCHER}}
| '''Required for all other parameters to work'''
|-
! colspan=2 | The following parameters do not work in version 0.4.0.7
|-
| /{{text anchor|FILES}}
| '''Unknown''' - Attempts to open a resource table file, resulting in a runtime error at startup{{verify}}
|-
| /{{text anchor|IGTEST}}
| Disables respawning
|-
| /{{text anchor|NOINTROVIDEO}}
| Disables playback of opening videos
|-
| RESTART
| ''Untested''
|-
| /{{text anchor|XAFTOXBF}}
| '''Unknown''' - Game freezes when loading a race{{verify}}
|-
! colspan=2 | The following parameters do not work in version 0.3.8.1, but do work in version 0.3.5.1 and the Japanese demo
|-
| /{{text anchor|NORES}}
| '''Unknown''' - Causes a runtime error at startup{{verify}}
|-
| /{{text anchor|RES_FILES}}
| ''Untested''
|-
! colspan=2 | The following parameters only work with version 0.3.5.1
|-
| /{{text anchor|ALLAI}}
| ''Untested''
|-
| /{{text anchor|CDIN}}
| ''Untested''
|-
| /{{text anchor|DEBUGINFO}}
| 'Displays the current position, lap number, and held powerup of all AI opponents
|-
| /{{text anchor|LOAD_TEXT}}
| ''Untested''
|-
| /{{text anchor|WINDOWED}}
| Allows the game to be launched in a window when in 16-bit color mode (the game will launch in 32-bit color mode, but may appear graphically corrupted)
|}
==''LEGOLAND''==
There are four command-line parameters in [[LEGOLAND (video game)|''LEGOLAND'']].
{| class="wikitable" border="1"
|-
! scope="col" style="width: 120px;" | Argument
! scope="col" style="width: 250px;" | Effect
|-
| -{{text anchor|nointro}}
| Disables playback of opening videos
|-
| -{{text anchor|nomusicLL|nomusic}}
| Disables in-game music
|-
| {{text anchor|WINDEBUG}}
| Starts the game in windowed mode.
|-
| {{text anchor|BLT}}
| ''Unknown''
|}
==References==
{{Reflist}}
[[Category:Documentations]]

Revision as of 12:50, 16 April 2019

Command-line parameters, also called arguments, flags, or switches, are options for the initial execution of software. These options are commonly supplied in a command-line window or shortcut, and always come after the executable's file name. Available parameters, syntax, and effect all depend on the game or software they are used with. A common use for these options is for running games in debug mode or different resolutions.

Example:

"C:\Program Files\OldGame\Game.exe" -firstoption -secondoption
"C:\Program Files\NewGame\Game.exe" /FIRSTOPTION /SECONDOPTION

Currently, five LEGO video games for Windows are known to have command-line parameters:

LEGO Racers

There are seven command-line parameters in the 1999 version of LEGO Racers, and eight in the 2001 version. Entering an incorrect parameter will cause LEGO Racers to terminate its launch and open an error message box, which displays a list of all parameters and their functions (except for -fov).

Argument Effect
-alphatrans Forces use of alpha transparency
-horzres [res] Sets the value in pixels for horizontal display resolution. Replace [res] with an integer.
-novideo Disables playback of opening videos
-primary Forces use of primary display device. This parameter will be ignored if -select3d is also used.
-select3d Allows display driver and Direct3D device selection before the game launches (may not work with the Japanese version)[verify]
-vertres [res] Sets the value in pixels for vertical display resolution. Replace [res] with an integer.
-window Allows the game to be launched in a window when in 16-bit color depth. The window will minimize if focus is lost.
The following parameter only works with the 2001 version
-fov [deg] Sets the value in degrees for the in-game camera's field of view. Replace [deg] with an integer. 90 is the default value. Values above 180 will invert the field of view. Values of 360 and onward can be used, but will be read as their coterminal equivalent below 360 degrees (e.g. 450=90).

LEGO Racers 2

There are twenty-six command-line parameters in LEGO Racers 2.

Argument Effect
/backlevel Untested
/bpp Untested
/cars Untested
/device Untested
/explore When any track is selected to race on, the player will be taken to explore mode in that track's world instead
/foyer When any track is selected to race on, the player will be taken to the track's world's foyer instead (except for Sandy Bay, which has no foyer and forces the player into explore mode)
/height [res] Sets the value in pixels for vertical display resolution. Replace [res] with an integer.
/highqualitysound Untested
/hz Untested, may not be in all versions
/levelname Untested
/loadcontroldata Untested
/lowqualitysound Untested
/nomusic Disables in-game music
/nosfx Mutes all audio. Attempting to start a new adventure will crash the game.
/options An options window appears on game start
/overdraw Makes all polygons translucent, showing how many layers are overlapping
/racers [range] Changes the number of racers. Replace [range] with an integer between 1 and 8
/script Untested
/startpos Changes your starting position
/track Untested
/width [res] Sets the value in pixels for horizontal display resolution. Replace [res] with an integer.
/windowed Allows the game to be launched in a window
/windowx Untested
/windowy Untested
/wireframe Displays all graphics in wireframe mode
/savecontroldata Untested

LEGO Rock Raiders

There are twenty-four command-line parameters in LEGO Rock Raiders.

Argument Effect
-best Launches the game with maximum graphics settings, skipping the Mode Selection prompt
-cleansaves Deletes all saved games
-debug Allows for display resolutions of 640x480, 800x600, or 1024x768 to be selected. However, only the positions and dimensions of interface items for a 640x480 resolution are defined in Lego.cfg by default; without extensive edits to designate coordinates for the latter two resolutions, selecting either of those options will cause the game to immediately crash. (Does not enable debug mode)
-debugcomplete Allows for display resolutions of 640x480, 800x600, or 1024x768 to be selected. However, only the positions and dimensions of interface items for a 640x480 resolution are defined in Lego.cfg by default; without extensive edits to designate coordinates for the latter two resolutions, selecting either of those options will cause the game to immediately crash. (Does not enable debug mode)

Seems to have the same effect as -debug. Further research needed.

-dualmouse Enables seperate detection of left and right mouse button presses.
-flags Followed with an integer to "turn on certain debug features"[1][verify]
-fpslock Enables VSync, which locks the frame rate to the monitor refresh rate when running in a window
-ftm Forces the video card to use all available texture memory and disables in-game dynamic lighting (except for walls)
-fvf Creates a gradual fog effect while in eye view or shoulder view
-insistOnCD Makes the game request the disc before it starts
-nm Disables texture management for Voodoo2-based cards. Incorrectly listed as -nom in the readme file.
-nosound Mutes all in-game sound
-programmer Enables debug keys and allows the opening logos to be skipped
-reduceanimation Disables the rockfall transition animation in the main menu
-reduceflics Disables all FLIC animations
-reduceimages Texture sizes are halved at load time, reducing the memory overhead[1]
-reducepromeshes Reduces the number of LOD meshes[1]
-reducesamples Disables sounds on the menu (except for clicking and music), voices (except for Chief's briefings), and cave ambiance. Streamed sounds, such as the aforementioned music and briefings, are unaffected.
-reward Disables Chief's animation on the reward screen
-showversion Displays the game's version number (V.0.121) in the bottom-right corner of the main menu, level select, and pause menu
-startlevel Launches the game directly into a level; requires a level identifier be used in the format of Levels::Levels10. Note that in order for this to work, the FrontEnd property in the config file must be set to FALSE.[1]
-testercall Unlocks all levels at start, same as -testlevels[1]
-testlevels Unlocks all levels at start.
-window Allows the game to be launched in a window when in 16-bit color mode. This is only applicable when used with the -best parameter.

LEGO Stunt Rally

These parameters must be used in a shortcut to _msr.exe, not StuntRally.exe

  • 0.3.5.1 is the version number for the original release of the game.
  • 0.3.8.1 is the version number for the later, more common releases of the game, as well as the Japanese demo by Eidos.
  • 0.4.0.7 is the version number for all other demo versions of the game.
Argument Effect
/FREEFORM Disables automatic steering
/FROMLAUNCHER Required for all other parameters to work
The following parameters do not work in version 0.4.0.7
/FILES Unknown - Attempts to open a resource table file, resulting in a runtime error at startup[verify]
/IGTEST Disables respawning
/NOINTROVIDEO Disables playback of opening videos
RESTART Untested
/XAFTOXBF Unknown - Game freezes when loading a race[verify]
The following parameters do not work in version 0.3.8.1, but do work in version 0.3.5.1 and the Japanese demo
/NORES Unknown - Causes a runtime error at startup[verify]
/RES_FILES Untested
The following parameters only work with version 0.3.5.1
/ALLAI Untested
/CDIN Untested
/DEBUGINFO 'Displays the current position, lap number, and held powerup of all AI opponents
/LOAD_TEXT Untested
/WINDOWED Allows the game to be launched in a window when in 16-bit color mode (the game will launch in 32-bit color mode, but may appear graphically corrupted)

LEGOLAND

There are four command-line parameters in LEGOLAND.

Argument Effect
-nointro Disables playback of opening videos
-nomusic Disables in-game music
WINDEBUG Starts the game in windowed mode.
BLT Unknown

References