Difference between revisions of "Remote Console Commands"
(Initial page setup) |
m (Minor edit to standardise argument notation for the login command) |
||
Line 5: | Line 5: | ||
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). | 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). | ||
<pre> | <pre> | ||
− | rc login | + | rc login <server_admin_password> |
</pre> | </pre> | ||
If you donât see any console output confirming the login, hit F1 a couple of times to close and reopen the console. | 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=== | ===Sending Remote Commands=== | ||
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. | 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. |
Revision as of 18:22, 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, the below are the more 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).
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.
The console also has tab completion 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:
- Typing
rc set drawFir
and pressingTab
will automatically expand the command to readrc set drawFirearmTrajectories
- Typing
rc carbonPlayers force
and pressingTab
will automatically expand the command to readrc carbonPlayers forceInput
as it cannot choose betweenforceInputRotation
orforceInputAxis
.
Console Commands
Some commands take arguments that determine how they behave. The command for God Mode takes an argument of either true
or false
to switch it on or off. Where commands take arguments, they will be contained 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 commandrc playerlist
.
Top Level Commands
Command | Description | Arguments |
---|---|---|
rc help [<command>] | Display help text about console commands | command (String): Optionally provide another command name to get further help on that specific command. e.g. rc help get
|
broadcast <message> | Send an admin message to all players on the server (can also be done in Admin chat with /bc <message> )
|
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. | fileType (List): One of the following options.
|
get [<argument>] | Fetches the value of a server setting (or all values if no argument provided). See Configuration Variables | argument (List): See Configuration Variables |
mapRotation <index> | Switches to the map configuration specified in the Server Configuration file. | 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. | command (List): One of the following commands.
ID (Integer): The ID of the player to affect |
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. | 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