Command Line Parameters: Difference between revisions

From Unofficial Homecoming Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
=Command Line Parameters=
Command Line Parameters are secondary commands used to enable, disable, or change features of the game when the program begins. Command line parameters are also called Launch Parameters since they are executed when the game launches or starts. A "command line" typically refers to a box in which users would type a line or string of commands for an operating system (or even a program) to run. Command line parameters can be used in command-line interpreting programs such as Command Prompt for Windows or Terminal in MacOS. They can also be used in graphical interface icons called "shortcuts" (Windows) or "aliases" (MacOS). Lastly, a command line parameter can also be typed into the Extra Launch Parameters box in the City of Heroes Launcher, which is probably the easiest way to use these parameters (and the only way to use command line parameters if you are running the game in MacOS).  
Command Line Parameters are secondary commands used to enable, disable, or change features of the game when the program begins. Command line parameters are also called Launch Parameters since they are executed when the game launches or starts. A "command line" typically refers to a box in which users would type a line or string of commands for an operating system (or even a program) to run. Command line parameters can be used in command-line interpreting programs such as Command Prompt for Windows or Terminal in MacOS. They can also be used in graphical interface icons called "shortcuts" (Windows) or "aliases" (MacOS). Lastly, a command line parameter can also be typed into the Extra Launch Parameters box in the City of Heroes Launcher, which is probably the easiest way to use these parameters (and the only way to use command line parameters if you are running the game in MacOS).  


A command line parameter is typically placed after the command executable, with a space in-between. A hyphen (-) must be added to the beginning of each parameter in order to tell the game that it is an option that must be used when the game starts. Multiple parameters can be used in the same command line as long as each one is separated by a blank space. The order in which you place the parameters generally doesn't matter, however if there's trouble try adding the parameters to the command line in a different sequence.
A command line parameter is typically placed after the command executable (.exe) file, with a space in-between. A hyphen (-) must be added to the beginning of each parameter in order to tell the game that it is an option that must be used when the game starts. Multiple parameters can be used in the same command line as long as each one is separated by a blank space. The order in which you place the parameters generally doesn't matter, however if there's trouble try adding the parameters to the command line in a different sequence.
 
Although some command line parameters can only be used as a launch parameter, there are many parameters that can also be used while in game and typed into the chat box as slash commands. The duration and permanency of these slash commands vary by command. Some last only until the game is refreshed by loading a character into a different zone, and some last until the game client is restarted. There are also other parameters that alter game settings that are persistent. However, if you want to use a value for a setting that is not allowed in the Options window (such as increasing the Character Detail in the Graphics and Audio settings beyond 200%, for example), then adding the command as a launch parameter can make the value more or less permanent by setting it every time the game client starts. Otherwise, the non-typical values are reset to the maximum allowed when the game restarts.
 
When used as a slash command, many command line parameters will appear active but do nothing. These "non-functional" slash commands are actually meant to be used only as launch parameters. 
 


==Examples==
The following are some examples of using command line parameters:
The following are some examples of using command line parameters:


Command Prompt
===Command Prompt===
  <COH Install Directory>\bin\win64\live\CityOfHeroes.exe -lodbias 10 -showfps 1
  <COH Install Directory>\bin\win64\live\CityOfHeroes.exe -lodbias 10 -showfps 1


Shortcut
===Shortcut===
[[File:Shortcut1.png‎|thumb|150px|none|Windows Shortcut]]


COH Launcher
===COH Launcher===
<gallery>
<gallery>
File:Launcher+Settings.png‎|thumb|450px|left|COH Launcher Settings
File:Launcher+Settings.png‎|thumb|450px|left|COH Launcher Settings
Line 19: Line 29:




Note: Command line parameters are often referred to as command line arguments, switches, flags, or options. All of these are correct or incorrect depending on the operating system environment used to run the program and the programming language used to write the program. Suffice it to say there is a lot of confusion as to which name to use, and in casual discussion they are often used interchangeably as more or less the same thing. Back when City of Heroes was live, the developers primarily referred to these as "command line parameters" in patch notes, but also used "command line options" and "command line overrides" in various data files.
'''Note:''' Command line parameters are often referred to as command line arguments, switches, flags, or options. All of these are correct or incorrect depending on the operating system environment used to run the program and the programming language used to write the program. Suffice it to say there is a lot of confusion as to which name to use, and in casual discussion they are often used interchangeably as more or less the same thing. Back when City of Heroes was live, the developers primarily referred to these as "command line parameters" in patch notes, but also used "command line options" and "command line overrides" in various data files.

Revision as of 22:37, 11 June 2023

Command Line Parameters

Command Line Parameters are secondary commands used to enable, disable, or change features of the game when the program begins. Command line parameters are also called Launch Parameters since they are executed when the game launches or starts. A "command line" typically refers to a box in which users would type a line or string of commands for an operating system (or even a program) to run. Command line parameters can be used in command-line interpreting programs such as Command Prompt for Windows or Terminal in MacOS. They can also be used in graphical interface icons called "shortcuts" (Windows) or "aliases" (MacOS). Lastly, a command line parameter can also be typed into the Extra Launch Parameters box in the City of Heroes Launcher, which is probably the easiest way to use these parameters (and the only way to use command line parameters if you are running the game in MacOS).

A command line parameter is typically placed after the command executable (.exe) file, with a space in-between. A hyphen (-) must be added to the beginning of each parameter in order to tell the game that it is an option that must be used when the game starts. Multiple parameters can be used in the same command line as long as each one is separated by a blank space. The order in which you place the parameters generally doesn't matter, however if there's trouble try adding the parameters to the command line in a different sequence.

Although some command line parameters can only be used as a launch parameter, there are many parameters that can also be used while in game and typed into the chat box as slash commands. The duration and permanency of these slash commands vary by command. Some last only until the game is refreshed by loading a character into a different zone, and some last until the game client is restarted. There are also other parameters that alter game settings that are persistent. However, if you want to use a value for a setting that is not allowed in the Options window (such as increasing the Character Detail in the Graphics and Audio settings beyond 200%, for example), then adding the command as a launch parameter can make the value more or less permanent by setting it every time the game client starts. Otherwise, the non-typical values are reset to the maximum allowed when the game restarts.

When used as a slash command, many command line parameters will appear active but do nothing. These "non-functional" slash commands are actually meant to be used only as launch parameters.


Examples

The following are some examples of using command line parameters:

Command Prompt

<COH Install Directory>\bin\win64\live\CityOfHeroes.exe -lodbias 10 -showfps 1

Shortcut

Windows Shortcut

COH Launcher



Note: Command line parameters are often referred to as command line arguments, switches, flags, or options. All of these are correct or incorrect depending on the operating system environment used to run the program and the programming language used to write the program. Suffice it to say there is a lot of confusion as to which name to use, and in casual discussion they are often used interchangeably as more or less the same thing. Back when City of Heroes was live, the developers primarily referred to these as "command line parameters" in patch notes, but also used "command line options" and "command line overrides" in various data files.