|
|
| (108 intermediate revisions by 15 users not shown) |
| Line 1: |
Line 1: |
| − | This guide covers settings that can be reached through the in-game console (bound to F1 by default). While there are more console commands possible, these are the most commonly used and useful ones.
| + | {{DISPLAYTITLE:Remote Console Commands}} |
| | + | {{ContentTemplateModernInline |
| | + | | welcome = [[File:Forum Logo.png|link=|left|alt=Remote Console Commands]] |
| | + | | blurb = Admin the server from the in-game console (F1): login, multi-commands, delays, variables, bots, horses, naval and weather. |
| | + | | sections_title = On this page |
| | + | | sections_content = |
| | + | * [[#Using The Console|Using The Console]] |
| | + | ** [[#Logging In As Admin|Logging In As Admin]] |
| | + | ** [[#Sending Remote Commands|Sending Remote Commands]] |
| | + | ** [[#Sending Multiple Commands Per Line|Multiple Commands Per Line]] |
| | + | ** [[#Delayed Execution Commands|Delayed Execution Commands]] |
| | + | * [[#Console Commands|Console Commands]] |
| | + | ** [[#Top Level Commands|Top Level Commands]] |
| | + | * [[#Configuration Variables|Configuration Variables]] |
| | + | ** [[#Game Settings|Game Settings]] |
| | + | ** [[#Cavalry Management|Cavalry Management]] |
| | + | ** [[#Character Movement|Character Movement]] |
| | + | ** [[#Weapons|Weapons]] |
| | + | ** [[#Melee Kicks|Melee Kicks]] |
| | + | ** [[#Artillery|Artillery]] |
| | + | ** [[#Naval|Naval Variables]] |
| | + | ** [[#Weather Settings|Weather Settings]] |
| | + | * [[#Bot Commands|Bot Commands]] |
| | + | * [[#Horse Commands|Horse Commands]] |
| | + | * [[#Naval|Naval]] |
| | + | * [[#Updates|Updates]] |
| | | | |
| − | ==Using The Console==
| + | | featured_title = Remote Console Commands |
| − | ===Logging In As Admin===
| + | | featured_content = {{:{{FULLPAGENAME}}/Body}} |
| − | All commands will require login with the admin password first (see [[Server Hosting#Basic Configuration & Starting the Server|Server Hosting]] for how to set the <code>server_admin_password</code>). You only need to log on once per session (i.e. each time you reconnect to a server, but not on map rotation). The command to login is below and is case sensitive.
| + | | image_content = |
| − | <pre>
| + | | layout = auto |
| − | rc login <server_admin_password>
| + | | left_width = 320px |
| − | </pre>
| + | | aside_width = 320px |
| − | If you donât see any console output confirming the login, hit F1 a couple of times to close and reopen the console.
| + | | gap = 0.5rem |
| − | | + | | show_toc = no |
| − | ===Sending Remote Commands===
| + | | show_section_edit = yes |
| − | All commands are prefixed with <code>rc </code> to distinguish them from console commands that run on your local game only. For example, <code>rc help</code> prints the list of rc commands and some descriptive help text. If you just type <code>help</code> you would only get the ''local'' console commands rather than the remote commands.
| + | }} |
| − | | |
| − | The console also has auto completion by pressing <code>Tab</code> for most commands (if not all arguments). This means that you can type a partial command, hit <code>Tab</code>, and it will complete the rest of the command up to the point where there is no ambiguity. This is handy if you can only remember the start of the command, or to correct the case used for commands as the console is case sensitive.
| |
| − | | |
| − | ''Examples:''
| |
| − | # Typing <code>rc set drawFir</code> and pressing <code>Tab</code> will automatically expand the command to read <code>rc set drawFirearmTrajectories</code>
| |
| − | # Typing <code>rc carbonPlayers force</code> and pressing <code>Tab</code> will automatically expand the command to read <code>rc carbonPlayers forceInput</code> as it cannot choose between <code>forceInputRotation</code> or <code>forceInputAxis</code>.
| |
| − | | |
| − | ==Console Commands==
| |
| − | Some commands take arguments that determine how they behave. You've already seen one example of this - the ''server_admin_password above'' is an argument to the ''login'' command. Another would be setting God Mode on the servers.
| |
| − | | |
| − | <code>rc set characterGodMode true</code> Enables god mode, the argument is ''true''.
| |
| − | | |
| − | <code>rc set characterGodMode false</code> Disables god mode, the argument is ''false''.
| |
| − | | |
| − | Where commands take arguments, they will be listed in angle brackets (<code><argument></code>). In some cases, arguments are optional. These will be surrounded by square brackets (<code>[<optionalArgument>]</code>). Where more than one optional argument is available, all arguments up to the desired argument must be given.
| |
| − | | |
| − | e.g. For a command of the form <code>rc command <argument1> [<optional1>] [<optional2>] [<optional3>]</code>, to use <code><optional2></code>, we must also provide <code><optional1></code>.
| |
| − | Arguments will be listed in the form <code>''argument'' (type): description</code>, where ''argument'' is the name of the argument, ''type'' indicates the form the argument takes, and finally a ''description'' of the argument. Possible types of argument are:
| |
| − | {| | |
| − | | scope="col" style="font-weight: bold;width:100px;" |String: ||Any amount of text
| |
| − | |-
| |
| − | | scope="col" style="font-weight: bold;" |Boolean: ||<code>true</code> or <code>false</code>
| |
| − | |- | |
| − | | scope="col" style="font-weight: bold;" |Integer: ||A non-floating point number (i.e. no decimals)
| |
| − | |- | |
| − | | scope="col" style="font-weight: bold;" |Float: ||A floating point number (i.e. has decimals)
| |
| − | |- | |
| − | | scope="col" style="font-weight: bold;" |List: ||A specific list of options that will be provided (e.g. faction choices of British, Prussian, or French)
| |
| − | |}
| |
| − | ''Notes:''
| |
| − | * Some arguments will require numbers representing a position or rotation. These can be worked out in game by typing <code>get</code> in the console to give the current player's position and rotation.
| |
| − | * Some arguments will require the ID of a player. This is visible in the Admin/Mute Players Window (reached by pressing <code>P</code> by default), or by using the command <code>rc playerlist</code>.
| |
| − | * All remote commands can be added into your [[Server Configuration]] file for each map rotation, so you can automatically run commands when the map is selected. For example, you may want to always spawn 100 bots on a certain map for training purposes.
| |
| − | ===Top Level Commands===
| |
| − | {| class="wikitable"
| |
| − | ! scope="col" style="width:400px;" class="code" | Command
| |
| − | ! scope="col" style="width:500px;" | Description
| |
| − | ! Arguments
| |
| − | |-
| |
| − | |help [<command>]
| |
| − | |Display help text about console commands
| |
| − | | |
| − | e.g. <code>rc help get</code>
| |
| − | |''command'' (String): Optionally provide another command name to get further help on that specific command.
| |
| − | |-
| |
| − | |broadcast <message>
| |
| − | |Send an admin message to all players on the server (can also be done in Admin chat with <code>/bc <message></code>)
| |
| − | | |
| − | e.g. <code>rc broadcast Live at 18:30</code>
| |
| − | |''message'' (String): The text you want to broadcast. Subsequent calls to this will immediately replace the current message.
| |
| − | |- | |
| − | |carbonPlayers <command> [<arguments>]
| |
| − | |Bot controls. For more details see the section on [[#Bot Commands|Bot Commands]]
| |
| − | |See the section on [[#Bot Commands|Bot Commands]]
| |
| − | |-
| |
| − | |cls
| |
| − | |Clear the console. Useful if you're recording and want to clear your admin password before starting.
| |
| − | |N/A
| |
| − | |-
| |
| − | |fileReloader <fileType>
| |
| − | |Allows reloading of server configuration files without a server reboot. Useful for refreshing ban lists or tweaking [[Server_Configuration|map rotations]].
| |
| − | | |
| − | e.g. <code>rc fileReloader serverConfigFile</code>
| |
| − | |''fileType'' (List): One of the following options.
| |
| − | :* serverConfigFile: The [[Server_Configuration|Server Configuration]] file
| |
| − | :* blackWhiteLists: The blacklist / whitelist
| |
| − | :* bannedPlayers: Banned players file
| |
| − | :* bannedMachines: Banned machines file
| |
| − | :* mutePlayersVoip: The VOIP muted players file
| |
| − | :* mutePlayersChat: The chat muted players file
| |
| − | :* all: Loads all but the Server Configuration.
| |
| − | |-
| |
| − | |get [<variable>]
| |
| − | |Fetches the value of a server setting (or all values if no variable provided). See [[#Configuration Variables|Configuration Variables]]
| |
| − | | |
| − | e.g. <code>rc get characterGodMode</code>
| |
| − | |''variable'' (List): See [[#Configuration Variables|Configuration Variables]]
| |
| − | |-
| |
| − | |mapRotation <index>
| |
| − | |Switches to the map configuration specified in the [[Server_Configuration|Server Configuration]] file.
| |
| − | | |
| − | e.g. <code>rc mapRotation 1</code>
| |
| − | |''index'' (Integer): The number of the rotation to switch to. The first in the file is 1, the second 2, etc.
| |
| − | |-
| |
| − | |playerlist | |
| − | |List the players connected to the server
| |
| − | |N/A
| |
| − | |-
| |
| − | |scorelog
| |
| − | |Prints out a score log including a list of who killed who
| |
| − | |N/A
| |
| − | |-
| |
| − | |serverAdmin <command> <ID>
| |
| − | |Server admin commands. All generally accessible through the in-game "P" menu.
| |
| − | | |
| − | e.g. <code>rc serverAdmin slay 14</code>
| |
| − | |''command'' (List): One of the following commands.
| |
| − | :* ban
| |
| − | :* kick
| |
| − | :* chatMute
| |
| − | :* chatUnmute
| |
| − | :* voipMute
| |
| − | :* voipUnmute
| |
| − | :* permChatMute
| |
| − | :* permVoipMute
| |
| − | :* slay
| |
| − | | |
| − | ''ID'' (Integer): The ID of the player to affect
| |
| − | |-
| |
| − | |set <variable> <value>
| |
| − | |Sets the value of a server setting. See [[#Configuration Variables|Configuration Variables]]
| |
| − | | |
| − | e.g. <code>rc set characterGodMode true</code>
| |
| − | |''variable'' (List): See [[#Configuration Variables|Configuration Variables]]
| |
| − | | |
| − | ''value'' (?): The value and its type will depend on the variable used.
| |
| − | |-
| |
| − | |teleport <ID> <x> <y> <z>
| |
| − | |Teleports a specified player to a point on the map. Note that this does not currently take floating point arguments, limiting the accuracy to the nearest metre.
| |
| − | | |
| − | e.g. <code>rc teleport 14 200 10 435</code>
| |
| − | |''ID'' (Integer): The ID of the player
| |
| − | | |
| − | ''x'' (Integer): The X co-ordinate in space for the teleport.
| |
| − | | |
| − | ''y'' (Integer): The Y co-ordinate in space for the teleport. Positions the player vertically, so try to drop them gently!
| |
| − | | |
| − | ''z'' (Integer): The Z co-ordinate in space for the teleport.
| |
| − | |}
| |
| − | | |
| − | '''PAGE UNDER CONSTRUCTION'''
| |
| − | | |
| − | ===Configuration Variables===
| |
| − | There are a number of server-side variables that can be tweaked which affect how the game behaves. These generally carry over between map rotations, so once they're set they can only be reset manually or by restarting the server. A recommendation for server owners would be to add the appropriate commands to set defaults into their starter map rotation (such as Training Grounds) so that they can restore the settings without a restart. See [[Server Configuration]] for how to do this.
| |
| − | ====Game Settings====
| |
| − | ====Character Movement====
| |
| − | ====Weapons====
| |
| − | ====Artillery====
| |
| − | ===Nature Settings===
| |
| − | ===Bot Commands===
| |
| − | ===Naval===
| |
| − | ===Admin Controls===
| |
