🧭 You are here : Wiki home / Developer Guides / HLL RCON Commands

• Table of Contents
• Original Credit
• Protocol
  • Executing commands
    • Lists
    • Built-in console
    • Unique player IDs
• Commands
  • Help
  • Login <password>
  • RconPassword <old_password> <new_password>
  • Server
    • Get Name
    • Get Slots
    • Get GameState
    • Get MaxQueuedPlayers
    • Get NumVipSlots
    • SetMaxQueuedPlayers <size>
    • SetNumVipSlots <amount>
    • Say <message>
    • Broadcast <message>
    • ShowLog <timespan> ["filter"]
  • Maps
    • Get Map
    • Get MapsForRotation
    • RotList
    • RotAdd <map_name> [after_map_name] [after_map_ordinal]
    • RotDel <map_name> [map_ordinal]
    • Map <map_name> [map_ordinal]
    • QueryMapShuffle
    • ToggleMapShuffle
    • ListCurrentMapSequence
  • Players
    • Get Players
    • Get PlayerIds
    • Get AdminIds
    • Get AdminGroups
    • Get VipIds
    • PlayerInfo <player_name>
    • AdminAdd <"player_id"> <"role"> ["name"]
    • AdminDel <player_id>
    • VipAdd <"player_id"> <name>
    • VipDel <player_id>
  • Moderation
    • Get TempBans
    • Get PermaBans
    • Message <"player"> <"message">
    • Punish <"player"> ["reason"]
    • SwitchTeamOnDeath <player>
    • SwitchTeamNow <player>
    • Kick <"player"> ["reason"]
    • TempBan <"player_id"> [duration] ["reason"] ["admin_name"]
    • PermaBan <"player_id"> ["reason"] ["admin_name"]
    • PardonTempBan <ban_log>
    • PardonPermaPan <ban_log>
  • Configuration
    • Get Idletime
    • Get HighPing
    • Get TeamSwitchCooldown
    • Get AutoBalanceEnabled
    • Get AutoBalanceThreshold
    • Get VoteKickEnabled
    • Get VoteKickThreshold
    • Get Profanity
    • SetKickIdleTime <threshold>
    • SetHighPing <threshold>
    • SetTeamSwitchCooldown <cooldown>
    • SetAutoBalanceEnabled <bool>
    • SetAutoBalanceThreshold <threshold>
    • SetVoteKickEnabled <bool>
    • SetVoteKickThreshold <threshold_pairs>
    • ResetVoteKickThreshold
    • BanProfanity <profanities>
    • UnbanProfanity <profanities>
• Logs
• Available Maps
• Available Weapons
  • Firearms
  • Deployables
  • Vehicles (Roadkills)
  • Vehicles (Armament)
    • M8 Greyhound
    • Stuart M5A1
    • Sherman M4A3(75)W
    • Sherman M4A3E2 "75mm"
    • Sherman M4A3E2 "76mm"
    • M3 Half-track
    • Sd.Kfz.234 Puma
    • Sd.Kfz.121 Luchs
    • Sd.Kfz.161 Panzer IV
    • Sd.Kfz.171 Panther
    • Sd.Kfz.181 Tiger 1
    • Sd.Kfz 251 Half-track
    • BA-10
    • T70
    • T34/76
    • IS-1
    • Daimler
    • Tetrarch
    • Cromwell
    • Firefly
    • Churchill Mk.III
  • Commander Abilities
  • Removed Weapons
  • Bugged Weapon Names

https://gist.github.com/timraay/5634d85eab552b5dfafb9fd61273dc52

HLL servers open up a RCON port that lets people connect via TCP. All communication is and should be encrypted with a XOR cipher, of which the key will be sent upon opening the socket connection.

A few implementations can be found here:

• rcon/connection.py from MarechJ/hll_rcon_tool (Python 3, synchronous implementation using the socket stdlib)
• lib/protocol.py from timraay/HLLLogUtilities (Python 3, asynchronous implementation using the asyncio stdlib)
• async_hll_rcon/connection.py from cemathey/async_hll_rcon (Python 3, asynchronous implementation using trio)

Commands are simply (encrypted) strings with no special headers and the like. All responses are either SUCCESS, FAIL, EMPTY, or a custom string if the command should return information.

Commands may require one or more parameters. Parameters can be added behind the command itself, separated by a space. In some instances parameters are allowed to be wrapped in "quotation marks", making it possible to include spaces.

To execute any commands (except for the help command), the author needs to be authorized first. To do so, a login command has to be sent. If the response is not SUCCESS, the password is incorrect. Attempting to run a command without proper authorization will yield a FAIL.

Some commands may return a list as response. Each value is separated by a tab (\t). The first entry in the list will dictate the length of the list (excluding itself), and the response always ends with an additional tab: 2\tITEM1\tITEM2\t

WARNING: Some commands allow you to inject tabs into another command's response, which will cause programs attempting to unpack the list to fail. To prevent this from happening, you should replace any tabs before sending requests to the server.

An example of this is the vipadd command. When the name parameter here includes a tab, any subsequent get vipids commands will be programatically unreadable until the VIP is removed again using the vipdel command.

The game has a built-in RCON console which can be opened by pressing Ctrl + Alt + Shift + N. Depending on the admin role you have, you may still need to login to use certain commands.

Each player has a persistent unique ID (UID) associated to them, which is the ideal identifier to target individual players. A lot of commands do not accept UIDs however, and instead require the player's name. Carefully read the documentation of each command to see whether you can use UIDs or not.

UIDs come in different formats, depending on the player's platform. For Steam players, it will be their Steam64ID. For all other platforms it will be a version 4 UUID.

Legend:

<required>

[optional]

"may be quoted"

Commands are case-insensitive.

NOTE: In case no response is documented, you may assume the command will return SUCCESS.

See all commands and their parameters.

NOTE: You don't have to be logged in to use this command.

Returns:

• All available commands and parameters

Authorizes this connection to use commands.

Params:

• password (str) - The server's RCON password

Changes the RCON password.

Params:

• old_password (str) - The current RCON password
• new_password (str) - The new RCON password

Get the server's name, as can be seen in the server browser.

Returns:

• The server's name

Get the current and max amount of players on the server.

Returns:

• The current and max player count, separated by a slash

> get slots
89/100

Get information about the current match.

WARNING: If the last player on a server leaves, the player count on their team is not updated to 0 and will stay 1 until a player joins the server.

Returns:

• Detailed information about the current match

> get gamestate
Players: Allied: 48 - Axis: 50
Score: Allied: 2 - Axis: 3
Remaining Time: 0:31:44
Map: utahbeach_warfare
Next Map: stmariedumont_warfare

Get the max size of the server queue.

Returns:

• The max queue length

Get the number of slots on the server that are reserved for VIPs.

Returns:

• The number of reserved slots

Changes the maximum size of the server queue.

Params:

• size (int) - The queue size (max. 6)

Changes the amount of server slots reserved for VIPs.

Params:

• amount (int) - The number of reserved slots

Generally known as the welcome message, shown on the deployment screen and when first spawning in.

Updates the welcome message, and shows the new message to every player currently spawned in.

Params:

• message (str) - The welcome messagae

Broadcasts a message at the top left of the screen for all players, or clears the current broadcast if the message is empty.

NOTE: The message parameter is still required, but it can be left completely empty. "Broadcast" would fail, while "Broadcast " would clear the current message.

Params:

• message (str) - The broadcast message, leave empty to clear

Get server logs up to the specified amount of minutes ago.

WARNING: The server keeps track of all logs until it is restarted. You cannot obtain logs of actions that happened prior to a server restart.

Params:

• timespan (int) - The number of minutes ago that you want to include logs from. Setting this to, for instance, 5 will return all logs from now up to 5 minutes ago.
• filter (str) - A phrase to filter all results by.

Returns:

• Log messages separated by newlines (\n), or EMPTY if no logs match the given criteria. For more information on how to break down the response see the logs section.

Get the current map. If the same map is played twice in a row, it will get a _RESTART suffix (eg. utahbeach_warfare_RESTART).

While the server is loading a new map (which takes approx. 5 seconds), it may show a map called Untitled_#, with # being the index of the map it is loading in rotation.

Returns:

• The active map

Get a list of all existing maps. Not to be confused with the rotlist command, used to list all maps currently in rotation.

Returns:

• A list of map names

Return the current map rotation of the server.

Returns:

• A \n-delimited sequence of map names

Add a map to the rotation. This will be at the end, unless otherwise is specified.

WARNING: This command will not always return FAIL on failure, but instead may return a message explaining why it failed.

Changed in U14.7: map_name and after_map_name no longer need to be prefixed with /Game/Maps/ and are now case-insensitive.

Params:

• map_name (str) - The map to add
• after_map_name (str) - The name of a map already in rotation the map should be placed next after.
• after_map_ordinal (int) - If after_map_name is in rotation more than once, after which instance of said map the new map should be added, by default 1 (1st)

Remove a map from the rotation.

WARNING: This command will not always return FAIL on failure, but instead may return a message explaining why it failed.

Changed in U14.7: map_name no longer needs to be prefixed with /Game/Maps/ and is now case-insensitive.

Params:

• map_name (str) - The map to remove
• map_ordinal (int) - If map_name is in rotation more than once, which instance of said map should be removed, by default 1 (1st)

Starts a 60-second timer shown to all players on the server, after which the current match is immediately ended (skipping the End of Round screen) and the specified map is laoded.

Changed in U14.8: A map no longer needs to be in rotation to be switched to

Params:

• map_name (str) - The map to switch to
• map_ordinal (int) - If map_name is in rotation more than once, which isntance of said map should be switched to, by default 1 (1st)

Query whether map shuffling is enabled.

Returns:

• Map Shuffle: TRUE or Map Shuffle: FALSE

Toggle map shuffling on or off.

WARNING: This command can supposedly fail under certain unknown circimstances.

Assuming map shuffling has been enabled, returns the new, shuffled rotation

Returns:

• A \n-delimited sequence of map names

Get a list of names and UIDs of all online players.

Returns:

• A list of player names and UIDs:

> get players
2\t(WTH) Abu : 76561199023367826\tAnotherName : 12345678901234567\t

Get a list of the UIDs of all online players.

Returns:

• A list of player UIDs

Get a list of all admins, which includes their name, UID, and their role.

A list of available roles can be obtained using the get admingroups command.

Returns:

• A list of all admins. Each item in the list is a string containing a UID, a role, and a name, all separated by a space:

> get adminids
2\t76561199023367826 senior (WTH) Abu\t12345678901234567 camera AnotherName\t

Get a list of available permission groups or "roles", that can be assigned using the adminadd command.

Groups and their individual permissions can often be configured on the panel provided by Game Server Providers.

Returns:

• A list of roles

Get a list of all VIPs, which includes a UID and a comment (usually their name).

Returns:

• A list of all VIPs. Each item in the list is a string containing a UID and a comment, all separated by a space:

> get vipids
2\t76561199023367826 Abu (Admin)\t12345678901234567 AnotherName\t

Return detailed information about a player, including their team and unit, role, and kills.

NOTE: The PlayerInfo command is the only command that shows the full name of the player. All other commands will truncate names longer than 20 characters.

WARNING: The amount of information included may vary depending on the state of the player.

• If the player is on the team select screen, their team will be None and their current loadout is not included.
• If the player is not in a unit, no information related to their unit will be included.

WARNING: The player's loadout is only updated every time they spawn in.

WARNING: If a player's name has a space as 20th character, its truncated name will end with a space, which will cause this command to always fail. It is not possible to get detailed information about this player.

Params:

• player_name (str) - The name of a player

Returns:

• Detailed information about a player

> playerinfo (WTH) Abu
Name: (WTH) Abu
steamID64: 12345678901234567
Team: Allies
Role: Officer
Unit: 0 - Able
Loadout: NCO
Kills: 0 - Deaths: 0
Score: C 50, O 0, D 40, S 10
Level: 174

Assign an admin role to a user, granting them access to special permissions in-game.

Params:

• player_id (str) - The UID of a player
• role (str) - An assignable role
• name (str) - A name for the player

Remove any roles from a user, revoking their access to special permissions in-game.

Params:

• player_id (str) - The UID of a player

Assign VIP permissions to a user, allowing them to use reserved VIP slots.

Params:

• player_id (str) - The UID of a player
• name (str) - A name for the player

Remove VIP permissions from a user, revoking their ability to use reserved VIP slots.

Params:

• player_id (str) - The UID of a player

Get a list of all active temporary bans.

Each returned ban is a string (or so-called "ban log") that you have to parse yourself. It will include the UID, name at the time of ban, duration in hours, date banned, reason, and admin name:

76561199023367826 : nickname "(WTH) Abu" banned for 2 hours on 2021.12.09-16.40.08 for "Being a troll" by admin "Some Admin Name"

Both the reason and admin name are omitted if they were not provided when the player was banned.

WARNING: You may see some empty strings included in the array. These are expired bans that due to a game bug still affect the response.

You need the full, raw ban log to remove a temp ban.

Returns:

• A list of bans.

Get a list of all active permanent bans.

Each returned ban is a string (or so-called "ban log") that you have to parse yourself. It will include the UID, name at the time of ban, date banned, reason, and admin name:

76561199023367826 : nickname "(WTH) Abu" banned on 2021.12.09-16.40.08 for "Being a troll" by admin "Some Admin Name"

You need the full, raw ban log to remove a perma ban.

Returns:

• A list of bans.

Message a player with a specific message shown to them at the top right of their screen.

WARNING: Due to a game bug, using a name that contains one or more spaces to target a player will always fail. Use a UID instead to reliably target a player.

Params:

• player (str) - The name or UID of a player
• message (str) - The message shown to the player

Kill a player with a specific message shown to them.

Params:

• player (str) - The name of a player
• reason (str) - The reason shown to the player

Make a player switch teams next time they die.

Params:

• player (str) - The name of a player

Make a player switch teams immediately, killing them if they are alive.

Params:

• player (str) - The name of a player

Kick a player from the server with a specific message shown to them.

Params:

• player (str) - The name of a player
• reason (str) - The reason shown to the player

Temporarily ban a player for the duration and reason specified.

WARNING: The <"player_id"> parameter technically also supports player names. However, aside from the use of non-unique identifiers being unsafe, the game server does not return FAIL in case of an unrecognized name, and instead replaces the UID with an empty string.

Params:

• player_id (str) - The UID of a player
• duration (int) - The duration of the ban in hours, defaults to 2
• reason (str) - The reason shown to the player
• admin_name (str) - The name of whoever applied the ban, for audit purposes only

WARNING: The <"player_id"> parameter technically also supports player names. However, aside from the use of non-unique identifiers being unsafe, the game server does not return FAIL in case of an unrecognized name, and instead replaces the UID with an empty string.

Params:

• player_id (str) - The UID of a player
• reason (str) - The reason shown to the player
• admin_name (str) - The name of whoever applied the ban, for audit purposes only

Remove a temporary ban.

Params:

• ban_log (str) - A ban log as is returned by the get tempbans command

Remove a permanent ban.

Params:

• ban_log (str) - A ban log as is returned by the get permabans command

Get the current amount of minutes of inactivity before a player is automatically kicked.

Returns:

• The number of minutes players can be idle for

Get the current latency ("ping") threshold that will trigger an automated kick when surpassed.

Returns:

• The latency threshold in milliseconds

Get the current team switch cooldown in minutes.

Returns:

• The team switch cooldown

Get whether team auto balance is enabled or not.

Returns:

• 0 or 1

Get the current auto balance player threshold.

Returns:

• The auto balance threshold

Get whether players can initiate vote kicks or not.

Returns:

• 0 or 1

Get the current vote kick threshold. When the number of votes reaches this threshold the player is kicked.

Returns:

• The number of votes required

Get a list of all profanities (censored words in chat) on the server.

Returns:

• A list of all profanities

Changes the time it takes for inactive players to be automatically kicked.

Params:

• threshold (int) - The threshold in minutes, 0 to disable

Changes the latency threshold players have to not exceed in order to not be automatically kicked.

Params:

• threshold (int) - The threshold in milliseconds, 0 to disable

Changes the cooldown applied before being able to switch teams again.

Params:

• cooldown (int) - The cooldown in minutes

Enable or disable team auto balancing.

Params:

• bool (bool) - Whether auto balance should be enabled, either on or off.

Changes the maximum difference in players per team before players are forced to join the lesser full team.

Params:

• threshold (int) - The threshold

Enable or disable vote kicking.

Params:

• bool (bool) - Whether vote kicks should be enabled, either on or off.

Set the amount of votes required to kick a player. The amount can be varied depending on the amount of players online at the moment.

Params:

• threshold_pairs (str) - Expects a comma-separated list of playercount & threshold pairs. The first pair must always be for 0 players. You can add as many pairs as you want. For instance, 0,5,25,10 will require 5 votes when at least 0 players are online, or otherwise 10 votes when at least 25 players are online.

Reset the vote kick thresholds defined with the setvotekickthreshold command.

Add one or more words to the list of profanities.

Params:

• profanities (str) - A comma-separated list of words

Returns:

• A list of all profanities

Remove one or more words from the list of profanities.

Params:

• profanities (str) - A comma-separated list of words

Returns:

• A list of all profanities

Logs can be obtained with the Showlog command. Logs are returned as a wall of text, oldest first, with each line representing an event that happened on the game server.

Each line is prefixed with how long ago the event took place, as well as the timestamp.

TODO: Add vote kick logs

[10:00:00 hours (1639106251)] CONNECTED A Player Name (12345678901234567)
[10:00:00 hours (1639122640)] DISCONNECTED A Player Name (12345678901234567)
[10:00:00 hours (1639143555)] KILL: A Player Name(Axis/12345678901234567) -> (WTH) A Player name(Allies/12345678901234567) with MP40
[10:00:00 hours (1639144073)] TEAM KILL: A Player Name(Allies/12345678901234567) -> A Player Name(Allies/12345678901234567) with M1 GARAND
[30:00 min (1639144118)] CHAT[Team][A Player Name(Allies/12345678901234567)]: Please build garrisons!
[30:00 min (1639145775)] CHAT[Unit][A Player Name(Axis/12345678901234567)]: comms working?
[15.03 sec (1639148961)] Player [A Player Name (12345678901234567)] Entered Admin Camera
[15.03 sec (1639148961)] Player [A Player Name (12345678901234567)] Left Admin Camera
[15.03 sec (1639148961)] BAN: [A Player Name] has been banned. [BANNED FOR 2 HOURS BY THE ADMINISTRATOR!]
[15.03 sec (1639148961)] KICK: [A Player Name] has been kicked. [BANNED FOR 2 HOURS BY THE ADMINISTRATOR!]
[15.03 sec (1639148961)] MESSAGE: player [A Player Name(12345678901234567)], content [Stop teamkilling, you donkey!]
[805 ms (1639148969)] MATCH START SAINTE-MÈRE-ÉGLISE WARFARE
[805 ms (1639148969)] MATCH ENDED `SAINTE-MÈRE-ÉGLISE WARFARE` ALLIED (2 - 3) AXIS 

WARNING: Certain log lines may include unescaped newlines, turning them into multiple lines. As of writing, this can happen with BAN, KICK and MESSAGE log lines.

[13:35 min (1671206494)] MESSAGE: player [A Player Name(12345678901234567)], content [This is line 1.
This is line 2.
And this is line 3!]

You can escape these newlines with Regex. The below example uses a negative lookahead to replace any newlines not followed by the log time you see at the start of each line with an escaped newline.

# Python
import re
logs = logs.strip('\n')
logs = re.sub(r"\n(?!\[.+? \(\d+\)\])", "\\n", logs)

NOTE: Some night maps are yet to release and are currently only available in PTEs.

^{* This is how the map appears in the MATCH START and MATCH ENDED log lines.
** Lowercase in the output of the Get Map and Get Gamestate commands.}

TODO: Add U14.8 equipment and tanks

NOTE: The British melee weapon uses a so-called "En Dash" character (–) as opposed to the standard hyphen (-).

NOTE: If a vehicle gets destroyed, any kills made with said vehicle that get counted after its destruction will have the vehicle name excluded from the weapon name. Eg. "COAXIAL M1919 [M8 Greyhound]" would become "COAXIAL M1919"

Recon Vehicle - United States (US)

Light Tank - United States (US)

Medium Tank - United States (US)

Heavy Tank - United States (US)

Heavy Tank - United States (US)

Half-track - United States (US), Soviet Union (RUS) & Great Britain (GB)

Recon Vehicle - Germany (GER)

Light Tank - Germany (GER)

Medium Tank - Germany (GER)

Heavy Tank - Germany (GER)

Heavy Tank - Germany (GER)

Half-track - Germany (GER)

Recon Vehicle - Soviet Union (GER)

Light Tank - Soviet Union (GER)

Medium Tank - Soviet Union (GER)

Heavy Tank - Soviet Union (GER)

Recon Vehicle - Great Britain (GER)

Light Tank - Great Britain (GER)

Medium Tank - Great Britain (GER)

Heavy Tank - Great Britain (GER)

Heavy Tank - Great Britain (GER)

Names are the same across all factions.

^{* As in, kills with a Katyusha Barrage actually show up as "Unknown"}