Difference between revisions of "Command Line"

From Renegade-X Wiki
Jump to navigation Jump to search
(Cleaned up layout)
Line 1: Line 1:
Renegade X, which is built from the Unreal Development Kit (UDK), supports a wide range of command line options. Renegade X therefor supports all UDK command line options. You can find the UDK command line documentation [https://docs.unrealengine.com/udk/Three/CommandLineArguments.html here] but the following page lists options that are useful for Renegade X.
+
== Overview ==
 +
[[Renegade X]] supports a wide range of command line options, including most baseline UDK command line options. These are useful for setting server/client settings, running in Windowed mode, automating server startup, or quickly joining a server or level. These are most useful and primarily intended for server administrators, advanced users, and developers. The general syntax for the command line is: '''UDK.exe [server/editor] [destination (level or server address)][query options] [switches] [settings]'''
  
Plain switches (switches that don't have an =value), require a - in front of them. E.G. -windowed. Setting switches, (settings with an =value), dont require the - sign. E.G. GDIBotCount=10
+
=== Examples ===
  
The command line syntax is: ''udk.exe (client/server/editor) (map/server ip)?setting?setting?setting -switch''
+
{| class="wikitable"
 
+
|-
'''Examples of the command line syntax'''
+
! Example !! Description
 
+
|-
''UDK.exe CNC-Field.udk'' //Starts a skirmish game straight into the given map<br />
+
| UDK.exe CNC-Field || Starts a skirmish game with CNC-Field as the initial level
''UDK.exe server CNC-Field.udk?DEDICATED=true?bIsLanMatch=true''  //starts a server<br />
+
|-
''UDK.exe 127.0.0.1'' //joins a server directly.<br />
+
| UDK.exe CNC-Field?Name=Bob?TimeLimit=50 -windowed || Starts a skirmish game in windowed mode with CNC-Field as the initial level, with some query options
''UDK.exe 127.0.0.1?name=playername?password=serverpasswrd'' //joins a server directly, with the given player name and the server password.<br />
+
|-
 
+
| UDK.exe 127.0.0.1 || Joins the server located at 127.0.0.1 on the default port (7777)
 
+
|-
'''EXE locations'''<br />
+
| UDK.exe 127.0.0.1:7778 || Joins the server located at 127.0.0.1 on port 7778
 
+
|-
''(game folder)\Binaries\udklift.exe''    Auto selects correct exe based on your system. NOTE: Can select the 64bit exes automatically, which is currently not supported.<br />
+
| UDK.exe 127.0.0.1:7778?Name=Bob?Password=ServerPassword || Joins the server located at 127.0.0.1 on port 7778, with some query options
''(game folder)\Binaries\Win32\udk.exe''    The 32bit client<br />
+
|-
''(game folder)\Binaries\Win64\udk.exe''    The 64bit client. NOTE: Not currently supported<br />
+
| UDK.exe server CNC-Field || Starts a server with CNC-Field as the initial level on the default port (7777)
 +
|-
 +
| UDK.exe server CNC-Field Port=7778 || Starts a server with CNC-Field as the initial level on port 7778
 +
|-
 +
| UDK.exe server CNC-Field?AdminPassword=iLoveRenegadeX?TimeLimit=50 Port=7778 || Starts a server with CNC-Field as the initial level on port 7778, with some query options
 +
|-
 +
| UDK.exe editor || Starts the editor; this should only be run as part of the SDK
 +
|}
  
 +
== Switches ==
 +
Switches take no parameters, and are prefixed with a '-'. For example, the switch "Windowed" would be "-windowed" on the command line. Switches are not case sensitive.
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
! Name !! command !! Description
+
! Switch !! Description
 
|-
 
|-
| Windowed || -windowed || Starts the game in windowed mode.
+
| Windowed || Starts the game in windowed mode
 
|-
 
|-
| Fullscreen || -FULLSCREEN || Starts the game in fullscreen mode.
+
| Fullscreen || Starts the game in fullscreen mode
 
|-
 
|-
| Skip movies || -nomoviesstartup || Disables movies. NOTE: will also disable the map loading screen videos.
+
| NoMovies || Disables movies, including level loading movies
 
|-
 
|-
| Resolution || ResX=1920?ResY=1080 || Sets the game resolution.
+
| VSync || Enable VSync
 
|-
 
|-
| Player Name || name=playername || Sets the player's name.
+
| NoVSync || Disable VSync
 
|-
 
|-
| Password || password=serverpassword || The password of the server that is being connected to.
+
| Silent || Don't display or output anything.
 
|-
 
|-
| VSync || -VSync | -NoVSync || Enable/Disable VSync.
+
| LanPlay || Uncaps the client bandwidth when connection to servers. Warning: Causes double the amount of server updates and can saturate client’s bandwidth.
 
|-
 
|-
| Dedicated server || DEDICATED=true || Runs as a dedicated server. //to be tested
+
| NoSound || Turn off sound
 
|-
 
|-
| Mutators || MUTATOR=mutatorpackage.mutator || Loads a mutator.
+
| Log || Shows the log window
 
|-
 
|-
| Silent || -silent || Don't display or output anything.
+
| NoSplash || Suppress the splash screen on startup
 
|-
 
|-
| Lan server || bIsLanMatch=1 || Turns off online authentication. //to be tested
+
| OneThread || Restricts the game to 1 thread/core.
 +
|}
 +
 
 +
== Settings ==
 +
Settings take 1 parameter, and do not require any prefix. For example, the setting "Port" might be "Port=7777" on the command line. Settings are not case sensitive.
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
! Setting !! Parameter !! Description
 +
|-
 +
| ResX || Integer || Sets the game's horizontal resolution (i.e: ResX=1920)
 +
|-
 +
| ResY || Integer || Sets the game's vertical resolution (i.e: ResY=1080)
 +
|-
 +
| Multihome || String || Specifies the IP address to bind the server to
 +
|-
 +
| Port || Integer || Specifies the port to bind the server to
 
|-
 
|-
| Listen server || listen=true|| Runs a server in the same instance as a local client. For when a player is also hosting a game at the same time. //to be tested
+
| PrimaryNet || String || Specifies the IP address to bind the client to
 
|-
 
|-
| Difficulty || DIFFICULTY=7 || Bot difficulty. //doesn't work currently.
+
| Log || String || Which file to output logs to
 +
|}
 +
 
 +
== Query Parameters ==
 +
Query parameters are passed as a query string when joining a server or opening a level. These follow similar syntax to URL query strings.
 +
 
 +
{| class="wikitable sortable"
 
|-
 
|-
| Team Difficulty || (GDI/NOD)Difficulty=7 || Per team Bot difficulty. // Only works properly with initial bots.
+
! Query Key !! Parameter !! Description
 
|-
 
|-
| Number filler bots || NUMPLAY=20 || The player count that should be reached, filling with bots as needed. //doesn't work currently.
+
| Name || String || Sets the player's name
 
|-
 
|-
| Number of bots on team|| (GDI/NOD)BotCount=10 || Amount of bots on given team.
+
| Password || String || The password of the server to join
 
|-
 
|-
| LAN Play || -LANPLAY || For client side. Uncaps the client bandwidth when connection to servers. Warning: Causes double the amount of server updates and can saturate client’s bandwidth.
+
| Dedicated || true/false || Runs as a dedicated server
 
|-
 
|-
| Multihome || MULTIHOME=192.168.1.1 || Which IP address the server will run on.
+
| Mutator || String || Comma delimited list of mutators. Example: Package1.MutatorClass1,Package2.MutatorClass2
 
|-
 
|-
| Port || PORT=7777 || The port the server will run on.
+
| bIsLanMatch || true/false || Turns off online authentication (TODO: test)
 
|-
 
|-
| Primarynet || PRIMARYNET=192.168.1.1 || Which IP address the client should run on.
+
| Listen || true/false || Runs a server in the same instance as a local client, for when a player is also hosting a game at the same time
 
|-
 
|-
| No Sound || -NOSOUND || Turn of sound.
+
| GDIBotCount|| Integer || Number of bots to have on GDI
 
|-
 
|-
| Log || -log || Shows the log window.
+
| NodBotCount|| Integer || Number of bots to have on Nod
 
|-
 
|-
| Log File || log=Filename.ext || Sets the filename for the log.
+
| TimeLimit || Integer || Match time limit in minutes; 0 = unlimited
 
|-
 
|-
| No Splash || -NOSPLASH || Don't show the splash screen on startup.
+
| Team || Integer || Which team to join; 0=GDI, 1=NOD
 +
|}
 +
 
 +
== Executables ==
 +
There are several executable files used for launching Renegade X. The only one fully supported is the 32 bit client.
 +
 
 +
{| class="wikitable"
 
|-
 
|-
| Single thread || -ONETHREAD || Run the game on one thread(core).
+
! Executable Path !! Description
 
|-
 
|-
| Number of bots|| numbots=10 || How many bots to have. //doesn't work currently.
+
| \Binaries\Win32\udk.exe || The 32bit client
 
|-
 
|-
| Timelimit || timelimit=45 || Match time limit. 0 is no time limit.
+
| \Binaries\Win64\udk.exe || The 64bit client; NOT CURRENT SUPPORTED
 
|-
 
|-
| Team || team=0 || Which team to join. 0=GDI 1=NOD
+
| \Binaries\udklift.exe || Auto selects 32 or 64 bit executable based on your system hardware
 
|}
 
|}
 +
 +
==External Links==
 +
[https://docs.unrealengine.com/udk/Three/CommandLineArguments.html UDK Command Line]

Revision as of 22:14, 29 December 2017

Overview

Renegade X supports a wide range of command line options, including most baseline UDK command line options. These are useful for setting server/client settings, running in Windowed mode, automating server startup, or quickly joining a server or level. These are most useful and primarily intended for server administrators, advanced users, and developers. The general syntax for the command line is: UDK.exe [server/editor] [destination (level or server address)][query options] [switches] [settings]

Examples

Example Description
UDK.exe CNC-Field Starts a skirmish game with CNC-Field as the initial level
UDK.exe CNC-Field?Name=Bob?TimeLimit=50 -windowed Starts a skirmish game in windowed mode with CNC-Field as the initial level, with some query options
UDK.exe 127.0.0.1 Joins the server located at 127.0.0.1 on the default port (7777)
UDK.exe 127.0.0.1:7778 Joins the server located at 127.0.0.1 on port 7778
UDK.exe 127.0.0.1:7778?Name=Bob?Password=ServerPassword Joins the server located at 127.0.0.1 on port 7778, with some query options
UDK.exe server CNC-Field Starts a server with CNC-Field as the initial level on the default port (7777)
UDK.exe server CNC-Field Port=7778 Starts a server with CNC-Field as the initial level on port 7778
UDK.exe server CNC-Field?AdminPassword=iLoveRenegadeX?TimeLimit=50 Port=7778 Starts a server with CNC-Field as the initial level on port 7778, with some query options
UDK.exe editor Starts the editor; this should only be run as part of the SDK

Switches

Switches take no parameters, and are prefixed with a '-'. For example, the switch "Windowed" would be "-windowed" on the command line. Switches are not case sensitive.

Switch Description
Windowed Starts the game in windowed mode
Fullscreen Starts the game in fullscreen mode
NoMovies Disables movies, including level loading movies
VSync Enable VSync
NoVSync Disable VSync
Silent Don't display or output anything.
LanPlay Uncaps the client bandwidth when connection to servers. Warning: Causes double the amount of server updates and can saturate client’s bandwidth.
NoSound Turn off sound
Log Shows the log window
NoSplash Suppress the splash screen on startup
OneThread Restricts the game to 1 thread/core.

Settings

Settings take 1 parameter, and do not require any prefix. For example, the setting "Port" might be "Port=7777" on the command line. Settings are not case sensitive.

Setting Parameter Description
ResX Integer Sets the game's horizontal resolution (i.e: ResX=1920)
ResY Integer Sets the game's vertical resolution (i.e: ResY=1080)
Multihome String Specifies the IP address to bind the server to
Port Integer Specifies the port to bind the server to
PrimaryNet String Specifies the IP address to bind the client to
Log String Which file to output logs to

Query Parameters

Query parameters are passed as a query string when joining a server or opening a level. These follow similar syntax to URL query strings.

Query Key Parameter Description
Name String Sets the player's name
Password String The password of the server to join
Dedicated true/false Runs as a dedicated server
Mutator String Comma delimited list of mutators. Example: Package1.MutatorClass1,Package2.MutatorClass2
bIsLanMatch true/false Turns off online authentication (TODO: test)
Listen true/false Runs a server in the same instance as a local client, for when a player is also hosting a game at the same time
GDIBotCount Integer Number of bots to have on GDI
NodBotCount Integer Number of bots to have on Nod
TimeLimit Integer Match time limit in minutes; 0 = unlimited
Team Integer Which team to join; 0=GDI, 1=NOD

Executables

There are several executable files used for launching Renegade X. The only one fully supported is the 32 bit client.

Executable Path Description
\Binaries\Win32\udk.exe The 32bit client
\Binaries\Win64\udk.exe The 64bit client; NOT CURRENT SUPPORTED
\Binaries\udklift.exe Auto selects 32 or 64 bit executable based on your system hardware

External Links

UDK Command Line