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

• Table of Contents
• 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
    • Get ObjectiveRow_0 to Get ObjectiveRow_4
    • RotList
    • RotAdd <map_name> [after_map_name] [after_map_ordinal]
    • RotDel <map_name> [map_ordinal]
    • Map <map_name> [map_ordinal]
    • GameLayout <obj0> <obj1> <obj2> <obj3> <obj4>
    • 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>
    • PardonPermaBan <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
    • M3 Stuart Honey
    • Cromwell
    • Crusader Mk.III
    • Firefly
    • Churchill Mk.III
    • Churchill Mk.VII
  • Commander Abilities
  • Removed Weapons
  • Bugged Weapon Names

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

Implementations include:

• rcon/connection.py from MarechJ/hll_rcon_tool (Python 3, synchronous, socket stdlib)
• lib/protocol.py from timraay/HLLLogUtilities (Python 3, asynchronous, asyncio stdlib)
• async_hll_rcon/connection.py from cemathey/async_hll_rcon (Python 3, asynchronous, trio)
• go-hll-rcon from FlorianSW/go-hll-rcon (Golang)
• go-let-loose from zMoooooritz/go-let-loose (Golang)

Commands are encrypted strings without special headers. Responses are SUCCESS, FAIL, EMPTY, or a custom string for information.

Parameters are added after the command, separated by spaces. Some parameters can be wrapped in "quotation marks" to include spaces.

All commands except help require authorization via the login command. An incorrect password returns a non-SUCCESS response, and unauthorized commands yield FAIL.

Some commands return a tab-separated (\t) list, with the first entry indicating the list length (excluding itself), ending with a tab: 2\tITEM1\tITEM2\t

WARNING: Some commands allow tab injection into responses, causing parsing failures. Replace tabs in inputs to prevent this. For example, in vipadd, a tab in the name parameter makes subsequent get vipids responses unreadable until removed with vipdel.

The game has a built-in RCON console, opened with Ctrl + Alt + Shift + N. Depending on your admin role, you may need to login to use certain commands.

Each player has a persistent unique ID (UID), ideal for targeting individuals. Many commands require player names instead of UIDs, so check each command’s documentation.

UIDs vary by platform:

• Steam: Steam64ID
• Other platforms: MD5-hashed version 4 UUID (Changed in U15.2: UUIDs are now hashed).

Legend:

<required>

[optional]

"may be quoted"

Commands are case-insensitive.

NOTE: Unless documented, assume the command returns SUCCESS.

See all commands and their parameters.

NOTE: No login required.

Returns:

• All available commands and parameters

Authorizes the connection to use commands.

Params:

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

Changes the RCON password.

Params:

• old_password (str) - Current RCON password
• new_password (str) - New RCON password

Get the server’s name, as seen in the server browser.

Returns:

• The server’s name

Get the current and maximum player count.

Returns:

• Current/max player count, separated by a slash

> get slots
89/100

Get current match information.

WARNING: If the last player leaves, their team’s player count stays at 1 until someone joins.

Returns:

• Match details

> 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 maximum server queue size.

Returns:

• Max queue length

Get the number of slots reserved for VIPs.

Returns:

• Number of reserved slots

Changes the maximum server queue size.

Params:

• size (int) - Queue size (max. 6)

Changes the number of slots reserved for VIPs.

Params:

• amount (int) - Number of reserved slots

Updates the welcome message, shown on the deployment screen and when spawning. Displays to all currently spawned players.

Params:

• message (str) - Welcome message

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

NOTE: The message parameter is required but can be empty. Broadcast fails, but Broadcast clears the message.

Params:

• message (str) - Broadcast message, leave empty to clear

Get server logs up to the specified minutes ago.

WARNING: Logs are retained until server restart. Actions before a restart are not logged.

Params:

• timespan (int) - Minutes ago to include logs from (e.g., 5 for the last 5 minutes)
• filter (str) - Phrase to filter results

Returns:

• Log messages separated by newlines (\n), or EMPTY if no logs match. See logs section for details.

Get the current map. Repeated maps have a _RESTART suffix (e.g., utahbeach_warfare_RESTART). During map loading (~5 seconds), it may show Untitled_#, where # is the rotation index.

Returns:

• Active map

Get a list of all existing maps, unlike rotlist, which lists maps in rotation.

Returns:

• List of map names

Get a list of three objective names for the specified row, from left-to-right or top-to-bottom based on map orientation. Used with GameLayout.

WARNING: Fails in Skirmish mode, returning: Cannot execute command for this gamemode.

NOTE: Cannot retrieve the five currently selected objectives.

Added in U15.2.

Returns:

• List of objective names

Return the current map rotation.

Returns:

• \n-delimited sequence of map names

Add a map to the rotation, at the end unless specified.

WARNING: May return a failure message instead of FAIL.

Changed in U14.7: map_name and after_map_name no longer need /Game/Maps/ prefix and are case-insensitive.

Params:

• map_name (str) - Map to add
• after_map_name (str) - Map in rotation to place the new map after
• after_map_ordinal (int) - Instance of after_map_name to add after, default 1 (1st)

Remove a map from the rotation.

WARNING: May return a failure message instead of FAIL.

Changed in U14.7: map_name no longer needs /Game/Maps/ prefix and is case-insensitive.

Params:

• map_name (str) - Map to remove
• map_ordinal (int) - Instance of map_name to remove, default 1 (1st)

Starts a 60-second timer shown to all players, then ends the match (skipping the End of Round screen) and loads the specified map.

Changed in U14.7: Map no longer needs to be in rotation; map_name is case-insensitive.

Params:

• map_name (str) - Map to switch to
• map_ordinal (int) - Instance of map_name to switch to, default 1 (1st)

Restarts the match with specified objectives, from left-to-right or top-to-bottom based on map orientation. Objectives must match names from Get ObjectiveRow_0 to _4.

NOTE: Objective names are case-insensitive.

WARNING: Invalid objective names or partial parameters may crash the server on Warfare/Offensive modes, poisoning the map until server reinstall. In Skirmish, the match restarts regardless of parameters. TODO: Verify if this bug is patched.

Added in U15.2.

Params:

• obj0 (str) - 1st objective name
• obj1 (str) - 2nd objective name
• obj2 (str) - 3rd objective name
• obj3 (str) - 4th objective name
• obj4 (str) - 5th objective name

Query if map shuffling is enabled.

Added in U14.

Returns:

• Map Shuffle: TRUE or Map Shuffle: FALSE

Toggle map shuffling on or off.

WARNING: May fail under unknown circumstances.

Added in U14.

If map shuffling is enabled, returns the shuffled rotation.

Added in U14.

Returns:

• \n-delimited sequence of map names

Get a list of names of all online players.

Returns:

• List of player names

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

Returns:

• List of player names and UIDs:

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

Get a list of all admins, including name, UID, and role.

Roles are listed via get admingroups.

Returns:

• List of admins, each with UID, role, and name, space-separated:

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

Get a list of permission groups or "roles" assignable via adminadd.

Roles and permissions are often configurable via Game Server Provider panels.

Returns:

• List of roles

Get a list of all VIPs, including UID and comment (usually name).

Returns:

• List of VIPs, each with UID and comment, space-separated:

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

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

NOTE: Only command showing full player names; others truncate names over 20 characters.

WARNING: Information varies by player state:

• On team select screen: team is None, no loadout.
• Not in a unit: no unit information.
• Loadout updates only on spawn.
• If name has a space as the 20th character, the truncated name ends with a space, causing failure.

Params:

• player_name (str) - Player’s name

Returns:

• Player details

> 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, granting in-game permissions.

Params:

• player_id (str) - Player’s UID
• role (str) - Assignable role
• name (str) - Player’s name

Remove admin roles, revoking permissions.

Params:

• player_id (str) - Player’s UID

Assign VIP permissions for reserved slots.

WARNING: name must be quoted to include spaces. An empty player_id cannot be removed.

Params:

• player_id (str) - Player’s UID
• name (str) - Player’s name

Remove VIP permissions.

Params:

• player_id (str) - Player’s UID

Get a list of active temporary bans.

Each ban is a string ("ban log") with UID, name at ban time, duration, date, 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"

Reason and admin name are omitted if not provided.

WARNING: Empty strings may appear due to a bug with expired bans.

Use the full ban log to remove via pardontempban.

Returns:

• List of bans

Get a list of active permanent bans.

Each ban is a string ("ban log") with UID, name at ban time, date, 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"

Use the full ban log to remove via pardonpermaban.

Returns:

• List of bans

Send a message to a player, shown top-right.

WARNING: Names with spaces fail due to a bug; use UID instead.

Params:

• player (str) - Player’s name or UID
• message (str) - Message to show

Kill a player with a message.

Params:

• player (str) - Player’s name
• reason (str) - Reason shown

Switch a player’s team on next death.

Params:

• player (str) - Player’s name

Switch a player’s team immediately, killing them if alive.

Params:

• player (str) - Player’s name

Kick a player with a message.

Params:

• player (str) - Player’s name
• reason (str) - Reason shown

Temporarily ban a player.

WARNING: player_id supports names, but it’s unsafe and doesn’t return FAIL for unrecognized names, using an empty string instead.

Params:

• player_id (str) - Player’s UID
• duration (int) - Ban duration in hours, default 2
• reason (str) - Reason shown
• admin_name (str) - Admin’s name, for audit

Permanently ban a player.

WARNING: player_id supports names, but it’s unsafe and doesn’t return FAIL for unrecognized names, using an empty string instead.

Params:

• player_id (str) - Player’s UID
• reason (str) - Reason shown
• admin_name (str) - Admin’s name, for audit

Remove a temporary ban.

Params:

• ban_log (str) - Ban log from get tempbans

Remove a permanent ban.

Params:

• ban_log (str) - Ban log from get permabans

Get minutes of inactivity before auto-kick.

Returns:

• Minutes players can be idle

Get latency threshold for auto-kick.

Returns:

• Latency threshold in milliseconds

Get team switch cooldown.

Returns:

• Cooldown in minutes

Check if team auto-balance is enabled.

Returns:

• 0 or 1

Get auto-balance player threshold.

Returns:

• Threshold

Check if vote kicks are enabled.

Returns:

• 0 or 1

Get vote kick threshold.

Returns:

• Votes required

Get a list of censored chat words.

Returns:

• List of profanities

Set inactivity auto-kick time.

Params:

• threshold (int) - Minutes, 0 to disable

Set latency auto-kick threshold.

Params:

• threshold (int) - Milliseconds, 0 to disable

Set team switch cooldown.

Params:

• cooldown (int) - Minutes

Enable/disable team auto-balance.

Params:

• bool (bool) - on or off

Set max player difference for auto-balance.

Params:

• threshold (int) - Threshold

Enable/disable vote kicking.

Params:

• bool (bool) - on or off

Set votes required for kick, varying by player count.

Params:

• threshold_pairs (str) - Comma-separated playercount & threshold pairs, starting with 0 players (e.g., 0,5,25,10 for 5 votes at 0+ players, 10 at 25+)

Reset vote kick thresholds set by setvotekickthreshold.

Add words to profanity list.

Params:

• profanities (str) - Comma-separated words

Returns:

• List of profanities

Remove words from profanity list.

Params:

• profanities (str) - Comma-separated words

Returns:

• List of profanities

Logs are obtained with Showlog, returned as text, oldest first, with each line prefixed by time elapsed and 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: BAN, KICK, and MESSAGE logs may include unescaped newlines, splitting into multiple 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!]

Escape newlines with Regex, replacing those not followed by a log timestamp:

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

NOTE: Some maps (e.g., hill400_warfare_night) are only available in PTEs.

^{* Appears in MATCH START and MATCH ENDED logs.
** Lowercase in Get Map and Get Gamestate outputs.
*** Only in PTEs.}

NOTE: The British melee weapon uses an "En Dash" (–) instead of a hyphen (-).

NOTE: If a vehicle is destroyed, post-destruction kills omit the vehicle name (e.g., COAXIAL M1919 [M8 Greyhound] becomes 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 (RUS)

Light Tank - Soviet Union (RUS)

Medium Tank - Soviet Union (RUS)

Heavy Tank - Soviet Union (RUS)

Recon Vehicle - Great Britain (GB)

Light Tank - Great Britain (GB)

Light Tank - Great Britain (GB)

Medium Tank - Great Britain (GB)

Medium Tank - Great Britain (GB)

Heavy Tank - Great Britain (GB)

Heavy Tank - Great Britain (GB)

Heavy Tank - Great Britain (GB)

Names are the same across factions.

^{* Kills with Katyusha Barrage show as "Unknown".}