Command Line Parameters: Difference between revisions
No edit summary |
mNo edit summary |
||
| (39 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
=Command Line Parameters= | =Command Line Parameters= | ||
Command Line Parameters are | Command Line Parameters are commands used to enable, disable, or change features of City of Heroes when the game begins. Command line parameters are also called [[Game Client#Launching the Game|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 [[Homecoming Launcher|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. | 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 efficacy, 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 | Because the Homecoming developers have made improvements to the game, such as changing file locations, whenever attempting to run the game without one of the Homecoming launchers (HC launcher, Tequila, Island Rum), either the parameter {{launchparam|legacylayout}} or {{launchparam|profile}} must be used in the command line depending on whether or not your game is using the current Homecoming installation. You will also need to use the {{launchparam|assetpath}} launch parameter to point the game client to the folder(s) holding the piggs files. The game client cannot be run from the command line (or a Windows shortcut) if the version of the game residing on the player's computer is different than the version of the game on the Homecoming servers. Updating prior to running the game can be done through the command line by using the [[Homecoming Launcher Manual#Command Line Use|launcherCLI.exe command]]. | ||
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|slash commands]]. The efficacy, 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 [[lodbias (Slash Command)|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 conventional settings 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. | 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. | ||
Most command line parameters | Most command line parameters accessible to players deal with the game's [[The Players' Guide to the Cities/User Interface/Options Window|graphics]] and [[The Players' Guide to the Cities/User Interface|graphical user interface (GUI)]]. Other parameters alter game file locations, CPU settings, and miscellaneous game features. | ||
<span style="color:red;text-decoration:underline">'''Warning'''</span>: Some command line parameters, especially obsolete or depreciated commands, can cause your game client to crash and even corrupt your launcher and game. Nothing a restart or a clean install of the game won't fix, but use at your own risk. | |||
| Line 17: | Line 26: | ||
===Command Prompt=== | ===Command Prompt=== | ||
C:\Games\Homecoming\bin\win64\live\CityOfHeroes.exe -profile live -auth 51.161.76.201 -legacylayout -assetpath assets/Issue24 -assetpath assets/live -lodbias 10 -maxfps 80 -showfps 1 | |||
===Shortcut=== | ===Shortcut=== | ||
[[File:Shortcut1.png|thumb|150px|none|Windows Shortcut]] | [[File:Shortcut1.png|thumb|150px|none|Windows Shortcut]] | ||
| Line 33: | Line 42: | ||
'''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" | '''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", "command line overrides", and simply "arguments" in various game data files. | ||
==See Also== | |||
* [[List of Command Line Parameters]] | |||
* [[Game Client]] | |||
* [[Slash Commands]] | |||
{{Navbox Command Line Parameters}} | |||
[[Category:Gameplay]] | |||
[[Category:Command Line Parameters]] | |||
Latest revision as of 06:11, 14 July 2023
Command Line Parameters
Command Line Parameters are commands used to enable, disable, or change features of City of Heroes when the game 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.
Because the Homecoming developers have made improvements to the game, such as changing file locations, whenever attempting to run the game without one of the Homecoming launchers (HC launcher, Tequila, Island Rum), either the parameter -legacylayout or -profile must be used in the command line depending on whether or not your game is using the current Homecoming installation. You will also need to use the -assetpath launch parameter to point the game client to the folder(s) holding the piggs files. The game client cannot be run from the command line (or a Windows shortcut) if the version of the game residing on the player's computer is different than the version of the game on the Homecoming servers. Updating prior to running the game can be done through the command line by using the launcherCLI.exe command.
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 efficacy, 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 conventional settings 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.
Most command line parameters accessible to players deal with the game's graphics and graphical user interface (GUI). Other parameters alter game file locations, CPU settings, and miscellaneous game features.
Warning: Some command line parameters, especially obsolete or depreciated commands, can cause your game client to crash and even corrupt your launcher and game. Nothing a restart or a clean install of the game won't fix, but use at your own risk.
Examples
The following are some examples of using command line parameters:
Command Prompt
C:\Games\Homecoming\bin\win64\live\CityOfHeroes.exe -profile live -auth 51.161.76.201 -legacylayout -assetpath assets/Issue24 -assetpath assets/live -lodbias 10 -maxfps 80 -showfps 1
Shortcut
COH Launcher
COH Launcher Settings
Extra Launch Parameters
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", "command line overrides", and simply "arguments" in various game data files.
See Also