Difference between revisions of "Remote Console Commands"

From Holdfast: Nations At War
Jump to navigation Jump to search
m (Updated post reviewer feedback)
m (Added some examples, and started Configuration Variables.)
Line 43: Line 43:
 
* 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 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>.
 
* 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===
 
===Top Level Commands===
 
{| class="wikitable"
 
{| class="wikitable"
Line 49: Line 50:
 
! Arguments
 
! Arguments
 
|-
 
|-
|rc help [<command>]
+
|help [<command>]
 
|Display help text about console commands
 
|Display help text about console commands
|''command'' (String): Optionally provide another command name to get further help on that specific command. e.g. <code>rc help get</code>
+
 
 +
e.g. <code>rc help get</code>
 +
|''command'' (String): Optionally provide another command name to get further help on that specific command.
 
|-
 
|-
 
|broadcast <message>
 
|broadcast <message>
 
|Send an admin message to all players on the server (can also be done in Admin chat with <code>/bc <message></code>)
 
|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.
 
|''message'' (String): The text you want to broadcast.  Subsequent calls to this will immediately replace the current message.
 
|-
 
|-
Line 67: Line 72:
 
|fileReloader <fileType>
 
|fileReloader <fileType>
 
|Allows reloading of server configuration files without a server reboot.  Useful for refreshing ban lists or tweaking [[Server_Configuration|map rotations]].
 
|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.
 
|''fileType'' (List): One of the following options.
 
:* serverConfigFile: The [[Server_Configuration|Server Configuration]] file
 
:* serverConfigFile: The [[Server_Configuration|Server Configuration]] file
Line 76: Line 83:
 
:* all: Loads all but the Server Configuration.
 
:* all: Loads all but the Server Configuration.
 
|-
 
|-
|get [<argument>]
+
|get [<variable>]
|Fetches the value of a server setting (or all values if no argument provided).  See [[#Configuration Variables|Configuration Variables]]
+
|Fetches the value of a server setting (or all values if no variable provided).  See [[#Configuration Variables|Configuration Variables]]
|''argument'' (List): See [[#Configuration Variables|Configuration Variables]]
+
 
 +
e.g. <code>rc get characterGodMode</code>
 +
|''variable'' (List): See [[#Configuration Variables|Configuration Variables]]
 
|-
 
|-
 
|mapRotation <index>
 
|mapRotation <index>
 
|Switches to the map configuration specified in the [[Server_Configuration|Server Configuration]] file.
 
|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.
 
|''index'' (Integer): The number of the rotation to switch to.  The first in the file is 1, the second 2, etc.
 
|-  
 
|-  
Line 94: Line 105:
 
|serverAdmin <command> <ID>
 
|serverAdmin <command> <ID>
 
|Server admin commands.  All generally accessible through the in-game "P" menu.
 
|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.
 
|''command'' (List): One of the following commands.
 
:* ban
 
:* ban
Line 106: Line 119:
  
 
''ID'' (Integer): The ID of the player to affect
 
''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>
 
|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.
 
|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
 
|''ID'' (Integer): The ID of the player
  
Line 121: Line 144:
  
 
===Configuration Variables===
 
===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====
 
====Game Settings====
 
====Character Movement====
 
====Character Movement====

Revision as of 20:38, 6 July 2019

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.

Using The Console

Logging In As Admin

All commands will require login with the admin password first (see Server Hosting for how to set the server_admin_password). 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.

rc login <server_admin_password>

If you don’t see any console output confirming the login, hit F1 a couple of times to close and reopen the console.

Sending Remote Commands

All commands are prefixed with rc to distinguish them from console commands that run on your local game only. For example, rc help prints the list of rc commands and some descriptive help text. If you just type help you would only get the local console commands rather than the remote commands.

The console also has auto completion by pressing Tab for most commands (if not all arguments). This means that you can type a partial command, hit Tab, 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:

  1. Typing rc set drawFir and pressing Tab will automatically expand the command to read rc set drawFirearmTrajectories
  2. Typing rc carbonPlayers force and pressing Tab will automatically expand the command to read rc carbonPlayers forceInput as it cannot choose between forceInputRotation or forceInputAxis.

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.

rc set characterGodMode true Enables god mode, the argument is true.

rc set characterGodMode false Disables god mode, the argument is false.

Where commands take arguments, they will be listed in angle brackets (<argument>). In some cases, arguments are optional. These will be surrounded by square brackets ([<optionalArgument>]). 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 rc command <argument1> [<optional1>] [<optional2>] [<optional3>], to use <optional2>, we must also provide <optional1>. Arguments will be listed in the form argument (type): description, 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:

String: Any amount of text
Boolean: true or false
Integer: A non-floating point number (i.e. no decimals)
Float: A floating point number (i.e. has decimals)
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 get 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 P by default), or by using the command rc playerlist.
  • 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

Command Description Arguments
help [<command>] Display help text about console commands

e.g. rc help get

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 /bc <message>)

e.g. rc broadcast Live at 18:30

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 See the section on 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 map rotations.

e.g. rc fileReloader serverConfigFile

fileType (List): One of the following options.
  • serverConfigFile: The 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

e.g. rc get characterGodMode

variable (List): See Configuration Variables
mapRotation <index> Switches to the map configuration specified in the Server Configuration file.

e.g. rc mapRotation 1

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. rc serverAdmin slay 14

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

e.g. rc set characterGodMode true

variable (List): See 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. rc teleport 14 200 10 435

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