Red Faction Command Line Parameters: Difference between revisions

From Red Faction Wiki
No edit summary
No edit summary
Line 41: Line 41:
| '''-startdir''' [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)
| (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).
|}
|}


==Purposes of the command-line parameters==
===MP Test===
Various command-line parameters are available to control operation of the game.
* This table lists command line parameters available only in [[Red Faction Multiplayer Test|Multiplayer Test]].
{| class="wikitable sortable"
|-
! Parameter Syntax
! Function
|-
| '''-multilog'''
| Only relevant when launching a dedicated server (via '''-dedicated'''). Writes a log of joining players and runtime to NAME_DayMoDD_HHMM.txt in the below format:


==General command-line parameters/switches==
:12/16 15:37:38~  Player Default has joined
*-level <RFL name> - Specifies a level to load in single player mode.  The .rfl extension can be omitted.
:12/16 15:38:18~  Player nick has joined
*-mod <mod name> - Runs a client/serverside mod.  The parameter must match the name of the mod's folder in /mods/.
:12/16 16:18:43~  Red Faction has been active for 0 hours, 42 minutes, and 1 seconds
*-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]]
:12/16 17:00:44~  Red Faction has been active for 1 hours, 24 minutes, and 2 seconds
*-port <port number> - Runs the server or client on the specified port.
:12/16 17:42:45~  Red Faction has been active for 2 hours, 6 minutes, and 3 seconds
[[Image:Servercmdline.jpg|250px|right|thumb|An example of using the command-line to run a [[dedicated server]]]]
:12/16 18:16:20~  Player digi has joined
*-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.
|}
 
==Command-line parameters/switches for mappers==
*-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
*-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).
 
==Command-line switches for graphics==
*-voodoo - Forces RF to use a Voodoo graphics card, ignoring the card specified in the [[launcher]].
*-voodoo3 - Same results as -voodoo, except for Voodoo3 cards as opposed to the original Voodoo.
 
==Hidden command-line switches==
*-startpos <xyz> - Used by [[RED]] to begin 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 <integers> - Used by [[RED]] to begin 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 <tracker ip/hostname> - This command-line switch, although undocumented by [[Volition Inc.|Volition]], is verified to exist in all released versions of [[Red Faction (Game)|Red Faction]], official and unofficial. (Multi Beta Test, 1.0, 1.1, 1.2, 1.3, [[Pure Faction|Pure]])  An IP or hostname is specified, and the game will use that server as the game tracker.  (Ex: -trackerip rfgt.factionfiles.com)
<!-- -trackerip is in fact hidden/undocumented -->


==Deprecated command-line switches==
==Deprecated command-line switches==

Revision as of 02:09, 31 August 2020

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.
-timedemo [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 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).

MP Test

Parameter Syntax Function
-multilog Only relevant when launching a dedicated server (via -dedicated). Writes a log of joining players and runtime to NAME_DayMoDD_HHMM.txt in the below format:
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

Deprecated command-line switches

  • -multilog - Only works 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:
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

RED Command-line switches

See RED Editor

Related Pages