Red Faction Command Line Parameters: Difference between revisions

From Red Faction Wiki
 
(34 intermediate revisions by 7 users not shown)
Line 1: Line 1:
''This article is regarding [[Red Faction]]''
[[Red Faction (Game)|Red Faction]] has a number of command line parameters available when launching the game.


[[Red Faction]] has support for command-line parameters that specify variables to the EXE before loading.
==Available Parameters==
===Base Game===
* This table lists command line parameters available as of the latest official client version (v1.20) of '''rf.exe'''.
{| class="wikitable sortable"
|-
! Parameter Syntax
! Function
|-
| '''-level''' [filename]
| Immediately loads into the specified level filename in single player mode when the game launches. [[.rfl]] file with corresponding filename must be in a directory loadable by the game (either the stock game files, or within a [[.vpp]] file in \user_maps\multi\ or \user_maps\single\.
|-
| '''-mod''' [mod name]
| Launch the game (or server, if run in conjunction with '''-dedicated''') with the specified total conversion mod. [mod name] must exactly match the name of the mod's corresponding folder in \mods\.
|-
| '''-dedicated''' [config name]
| Launch a dedicated server with the specified config from [[dedicated_server.txt]].  If no config name parameter is specified, it will default to the first configuration.
|-
| '''-port''' [port number]
| Launch the game (or server, if run in conjunction with '''-dedicated''') on the specified UDP port. If this parameter is not specified, defaults to UDP 7755.
|-
| '''-lanonly'''
| Only relevant when launching a dedicated server (via '''-dedicated'''). Stops your server from reporting to the multiplayer game tracker.
* '''NOTE:''' Using this parameter ''does not'' restrict non-LAN connections.
|-
| '''-timedemo''' [filename]
| Launch the game, immediately load into the specified level filename in single player mode, spawn at the origin of the level (XYZ: 0, 0, 0) and spin in a circle once.  Framerate statistics are displayed in the console and dumped to timedemo.txt.
|-
| '''-frameratetest''' [filename]
| Does the same as '''-timedemo''', but the test is performed at the origin, then again at each path node in the level.
* '''WARNING:''' This process could take some time to complete, and you will be unable to exit the game during the test unless you forcefully kill the process via some external method like <code>taskkill</code> or Task Manager.
|-
| '''-voodoo'''
| Launch the game with Voodoo GPU compatibility.
|-
| '''-voodoo3'''
| Launch the game with Voodoo3 GPU compatibility.
|-
| '''-startpos''' [coordinates]
| (Undocumented) Used by [[RED]] to start the level at the camera position. (Format: <code>-startpos [0|1],x;[0|1],y;[0|1],z</code> Note: 0 is for negative coordinates and 1 is for positive coordinates)
|-
| '''-startdir''' [coordinates]
| (Undocumented) Used by [[RED]] to start the level facing a specific direction. (Format: <code>-startdir [0|1],integer;[0|1],integer;[0|1],integer</code> Note: 0 is for negtive orientation and 1 is for positive orientation)
|-
| '''-trackerip''' [ip/hostname]
| (Undocumented) Used to specify an alternate multiplayer server tracker. If not specified, game will use the tracker configured in the registry (via launcher options).
|}


The command-line is often known as command-line, commandline, cmdline.
===Dash Faction===
* This table lists new command line parameters introduced in Dash Faction. Dash Faction is run from '''DashFactionLauncher.exe''', and any command line parameters must be as well.
* Note that all command line parameters listed above under Base Game are also usable in Dash Faction (by running '''DashFactionLauncher.exe''' with them).
{| class="wikitable sortable"
|-
! Parameter Syntax
! Required Dash Version
! Function
|-
| '''-game'''
| 1.3.0+
| Launch the game immediately without displaying the launcher window.
|-
| '''-editor'''
| 1.3.0+
| Launch the level editor immediately without displaying the launcher window.
|-
| '''-win32-console'''
| 1.4.1+
| Only relevant when launching a dedicated server (via '''-dedicated'''). Launch the server in a native Win32 console window.
|-
| '''-exe-path''' [path]
| 1.5.0+
| Use the specified file path (RF.exe or RED.exe) instead of the one configured under '''Game executable''' in the '''Options''' panel. As an example, this option is very useful for running multiple dedicated servers using separate game directories.
|-
| '''-url''' [rf:// URL]
| 1.5.0+
| (Undocumented) Launch the game and immediately join the server specified in the URL parameter. URL format is '''rf://IP:PORT''' (eg. '''-url rf://127.0.0.1:7755''' to join a server running on localhost using the default port)
|}


==Purposes of the command-line parameters==
===Pure Faction===
Various command-line parameters are available to control operation of the game's EXE.
* This table lists new command line parameters introduced in Pure Faction (run via '''PF.exe''') Note that all command line parameters listed above under Base Game are also usable in Pure Faction.
 
{| class="wikitable sortable"
==General command-line parameters/switches==
|-
*-level <RFL name> - Specifies a level to load in single player mode.  The .rfl extension can be omitted.
! Parameter Syntax
*-mod <mod name> - Runs a client/serverside mod.  The parameter must match the name of the mod's folder in /mods/.
! Required PF Version
*-dedicated <config name> - Hosts a dedicated server with the specified config (set up in [[dedicated_server.txt]]).  If no config name parameter is given, it will default to the first configuration in [[dedicated_server.txt]]
! Function
*-port <port number> - Runs a server or client on the specified port. No lower boundary is known.  The upper boundary is 65535, imposed by Windows.  It is safe to assume that ports from 1024-65535 are valid.
|-
[[Image:Servercmdline.jpg|250px|right|thumb|An example of using the command-line to run a [[dedicated server]]]]
| '''-childsafemode'''
*-lanonly - Forces a server to not contact the game tracker.  However, using this switch ''does not'' restrict connections from non-LAN clients.  Assuming ports are forwarded and NAT is set up appropriately, people outside of a LAN can still join the server, assuming they know the IP and port.  The -lanonly switch is often used to run [[clanwar]] servers, requiring that players must add the IP and port to their [[Favourites list]] to see and play in the server.
| 3.0+
*-trackerip <tracker ip/domain> - This command-line switch, although undocumented by [[Volition Inc.]], is verified to exist in all released versions of [[Red Faction]], official and non-official. (Multi Beta Test, 1.0, 1.1, 1.2, 1.3, Pure) An IP or domain is specified, and the game will use that server as the game tracker. (Ex: -trackerip rfgt.nebulamods.com)
| (Undocumented) Disable ability to send or receive chat messages in multiplayer.
 
|-
==Command-line parameters/switches for mappers==
| '''-hideip'''
*-timedemo <RFL name> - When an appropriate RFL name is specified (with the .rfl extension omitted), a player will be automatically spawned at the origin of the level (XYZ: 0, 0, 0) and spin in a circle once.  Framerate statistics are displayed in the console and dumped to timedemo.txt
| 3.0+
*-frameratetest <RFL name> - This does the same as -timedemo, with the exception that the test will be performed at the origin, and every path node in the level.  Caution must be used if not playing RF in windowed mode, as there is no way to exit the game until the test has completed (except for killing the process, which is difficult in fullscreen mode).
| (Undocumented) No known function.
 
|-
==Command-line switches for graphics==
| '''-nokill'''
*-voodoo - Forces RF to use a Voodoo graphics card, ignoring the card specified in the [[launcher]].
| 3.0+
*-voodoo3 - Same results as -voodoo, except for Voodoo3 cards as opposed to the original Voodoo.
| (Undocumented) No known function.
 
|-
==Hidden command-line switches==
| '''-faststart'''
*-startpos <xyz> - Used by [[RED]] when it plays the level from camera position.
| 3.0+
*-startdir <directory> - Assumed to specify starting directory.
| (Undocumented) Skip the THQ and Volition logo movies when starting the game.
 
|-
==Deprecated command-line switches==
| '''-fastmulti'''
*-multilog - Only working in [[Red Faction Multiplayer Test]] (beta).  When used, the server will write a log of joining players and runtime to NAME_DayMoDD_HHMM.txt.  An example can be seen below:
| 3.0+
| (Undocumented) Launch the game and go immediately to the multiplayer server list.
|}


===MP Test===
* This table lists command line parameters available only in [[Red Faction Multiplayer Test|Multiplayer Test]].
{| class="wikitable sortable"
|-
! Parameter Syntax
! Function
|-
| '''-multilog'''
| (Undocumented) Only relevant when launching a dedicated server (via '''-dedicated'''). Writes a log of joining players and runtime to NAME_DayMoDD_HHMM.txt.
|}
* Example formatting for NAME_DayMoDD_HHMM.txt:
:12/16 15:37:38~  Player Default has joined
:12/16 15:37:38~  Player Default has joined
:12/16 15:38:18~  Player nick has joined
:12/16 15:38:18~  Player nick has joined
Line 39: Line 125:
:12/16 18:16:20~  Player digi has joined
:12/16 18:16:20~  Player digi has joined


==RED Command-line switches==
===Level Editor===
''See [[RED#RED_Command-line_switches|RED Editor]]''
* This table lists command line parameters available in Red Faction's level editor ([[RED]]).
{| class="wikitable sortable"
|-
! Parameter Syntax
! Function
|-
| '''-mod'''
| Launch RED with the specified total conversion mod. [mod name] must exactly match the name of the mod's corresponding folder in \mods\.
* '''WARNING:''' Once a map is saved when RED is running with a mod, that map is flagged as requiring a mod and then may ''only'' be played when the game has that same mod loaded. It is ''very'' difficult to remove this mod flag, so please be absolutely sure you wish to save your map with a mod before doing it.
|-
| '''-sound'''
| (Undocumented) Allows the ''Preview'' button in [[RED Objects#Ambient Sound|Ambient Sound]] properties to work.
|-
| '''-win32'''
| (Undocumented) No known benefit. Makes all editor viewports display flat white.
|-
| '''-opengl'''
| (Undocumented) No known benefit. Makes all editor viewports display flat white. It can be reasonably assumed that this switch was originally intended to force the editor to render using OpenGL.
|-
| '''-update''' [filename]
| (Undocumented) No known function.
|}


==Related Pages==
==Related Pages==

Latest revision as of 14:25, 12 December 2021

Red Faction has a number of command line parameters available when launching the game.

Available Parameters

Base Game

  • This table lists command line parameters available as of the latest official client version (v1.20) of rf.exe.
Parameter Syntax Function
-level [filename] Immediately loads into the specified level filename in single player mode when the game launches. .rfl file with corresponding filename must be in a directory loadable by the game (either the stock game files, or within a .vpp file in \user_maps\multi\ or \user_maps\single\.
-mod [mod name] Launch the game (or server, if run in conjunction with -dedicated) with the specified total conversion mod. [mod name] must exactly match the name of the mod's corresponding folder in \mods\.
-dedicated [config name] Launch a dedicated server with the specified config from dedicated_server.txt. If no config name parameter is specified, it will default to the first configuration.
-port [port number] Launch the game (or server, if run in conjunction with -dedicated) on the specified UDP port. If this parameter is not specified, defaults to UDP 7755.
-lanonly Only relevant when launching a dedicated server (via -dedicated). Stops your server from reporting to the multiplayer game tracker.
  • NOTE: Using this parameter does not restrict non-LAN connections.
-timedemo [filename] Launch the game, immediately load into the specified level filename in single player mode, spawn at the origin of the level (XYZ: 0, 0, 0) and spin in a circle once. Framerate statistics are displayed in the console and dumped to timedemo.txt.
-frameratetest [filename] Does the same as -timedemo, but the test is performed at the origin, then again at each path node in the level.
  • WARNING: This process could take some time to complete, and you will be unable to exit the game during the test unless you forcefully kill the process via some external method like taskkill or Task Manager.
-voodoo Launch the game with Voodoo GPU compatibility.
-voodoo3 Launch the game with Voodoo3 GPU compatibility.
-startpos [coordinates] (Undocumented) Used by RED to start the level at the camera position. (Format: -startpos [0|1],x;[0|1],y;[0|1],z Note: 0 is for negative coordinates and 1 is for positive coordinates)
-startdir [coordinates] (Undocumented) Used by RED to start the level facing a specific direction. (Format: -startdir [0|1],integer;[0|1],integer;[0|1],integer Note: 0 is for negtive orientation and 1 is for positive orientation)
-trackerip [ip/hostname] (Undocumented) Used to specify an alternate multiplayer server tracker. If not specified, game will use the tracker configured in the registry (via launcher options).

Dash Faction

  • This table lists new command line parameters introduced in Dash Faction. Dash Faction is run from DashFactionLauncher.exe, and any command line parameters must be as well.
  • Note that all command line parameters listed above under Base Game are also usable in Dash Faction (by running DashFactionLauncher.exe with them).
Parameter Syntax Required Dash Version Function
-game 1.3.0+ Launch the game immediately without displaying the launcher window.
-editor 1.3.0+ Launch the level editor immediately without displaying the launcher window.
-win32-console 1.4.1+ Only relevant when launching a dedicated server (via -dedicated). Launch the server in a native Win32 console window.
-exe-path [path] 1.5.0+ Use the specified file path (RF.exe or RED.exe) instead of the one configured under Game executable in the Options panel. As an example, this option is very useful for running multiple dedicated servers using separate game directories.
-url [rf:// URL] 1.5.0+ (Undocumented) Launch the game and immediately join the server specified in the URL parameter. URL format is rf://IP:PORT (eg. -url rf://127.0.0.1:7755 to join a server running on localhost using the default port)

Pure Faction

  • This table lists new command line parameters introduced in Pure Faction (run via PF.exe) Note that all command line parameters listed above under Base Game are also usable in Pure Faction.
Parameter Syntax Required PF Version Function
-childsafemode 3.0+ (Undocumented) Disable ability to send or receive chat messages in multiplayer.
-hideip 3.0+ (Undocumented) No known function.
-nokill 3.0+ (Undocumented) No known function.
-faststart 3.0+ (Undocumented) Skip the THQ and Volition logo movies when starting the game.
-fastmulti 3.0+ (Undocumented) Launch the game and go immediately to the multiplayer server list.

MP Test

Parameter Syntax Function
-multilog (Undocumented) Only relevant when launching a dedicated server (via -dedicated). Writes a log of joining players and runtime to NAME_DayMoDD_HHMM.txt.
  • Example formatting for NAME_DayMoDD_HHMM.txt:
12/16 15:37:38~ Player Default has joined
12/16 15:38:18~ Player nick has joined
12/16 16:18:43~ Red Faction has been active for 0 hours, 42 minutes, and 1 seconds
12/16 17:00:44~ Red Faction has been active for 1 hours, 24 minutes, and 2 seconds
12/16 17:42:45~ Red Faction has been active for 2 hours, 6 minutes, and 3 seconds
12/16 18:16:20~ Player digi has joined

Level Editor

  • This table lists command line parameters available in Red Faction's level editor (RED).
Parameter Syntax Function
-mod Launch RED with the specified total conversion mod. [mod name] must exactly match the name of the mod's corresponding folder in \mods\.
  • WARNING: Once a map is saved when RED is running with a mod, that map is flagged as requiring a mod and then may only be played when the game has that same mod loaded. It is very difficult to remove this mod flag, so please be absolutely sure you wish to save your map with a mod before doing it.
-sound (Undocumented) Allows the Preview button in Ambient Sound properties to work.
-win32 (Undocumented) No known benefit. Makes all editor viewports display flat white.
-opengl (Undocumented) No known benefit. Makes all editor viewports display flat white. It can be reasonably assumed that this switch was originally intended to force the editor to render using OpenGL.
-update [filename] (Undocumented) No known function.

Related Pages

Retrieved from "https://www.redfactionwiki.com/w/index.php?title=Red_Faction_Command_Line_Parameters&oldid=8181"