Admins on a Ground Branch server are managed through the file Admin.ini. The fastest way, however, is the admin setup password: it makes you a SuperAdmin directly in the game without having to look up any SteamID first.
Method 1: Using the admin setup password
This is the fastest route and works entirely in the game.
-
Start the server
Start your server once via the dashboard so the configuration files get created. -
Connect via SFTP
Connect to your server via SFTP. -
Read the password
Open the following file and note down the password it contains:/GroundBranch/ServerConfig/AdminSetupPassword.txt -
Join the server
Launch Ground Branch and join your server – see Join Server. -
Open the console
Press the`key (backtick, left of the1) in the game to open the console. -
Run the command
Enter the following command and replace<password>with the value from the file:admin setup <password>You immediately become SuperAdmin on that server.
Method 2: Editing Admin.ini
Alternatively you can add admins directly in the configuration file. For that you need the player's SteamID64 – a 17-digit number starting with 7656.
-
Stop the server
Stop your server via the dashboard. The file is only read on server start. -
Connect via SFTP
Connect to your server via SFTP. -
Open Admin.ini
Open the following file:/GroundBranch/ServerConfig/Admin.ini -
Add the admin
Add one line per admin inside the section[/Script/RBZooKeeper.ZKAdmin]:[/Script/RBZooKeeper.ZKAdmin] Admins=(Name="JoeBlow",UniqueId="76561198012345678",ContactInfo="",Group="SuperAdmin")Field Meaning NameFreely chosen display name, only for your own overview UniqueIdThe player's SteamID64 (17 digits) ContactInfoOptional note field, may stay empty GroupThe admin group whose permissions the player receives -
Start the server
Save the file and start your server.
Admin groups
Which commands a group may use is also defined in the Admin.ini. Every group gets its own AdminGroups= line, placed above the admins:
AdminGroups=(Name="SuperAdmin",Commands=("all"))
AdminGroups=(Name="Moderator",Commands=("kick","ban","changemap"))
| Field | Meaning |
|---|---|
Name |
Name of the group that you enter under Group for your admins |
Commands |
List of allowed commands, "all" allows every command |
Open the admin menu
Once you are an admin, there are three ways to reach the admin menu in the game:
- The
F8key - The ESC menu and the admin button there
- The console (
`) and the commandadmin
In the admin menu you manage players (kick and ban), the map change and map list as well as the admin list itself.
Further admin commands
| Command | Description |
|---|---|
admin setup <password> |
One-time setup of the first admin via the console |
admin |
Opens the admin menu |
kick |
Removes a player from the server, with an optional reason |
ban |
Bans a player temporarily or permanently, with an optional reason |
unban |
Lifts a ban using the player's unique ID |
say |
Sends a message to everyone on the server |
motd |
Shows the message of the day to all players |
changemap / nextmap |
Changes the map or jumps to the next map in the map list |
resurrect (res) |
Revives a fallen player at the spot where they died |
resurrectnear (resnear) |
Revives a fallen player at the nearest living player |
restartserver |
Restarts the server |
