How to Create Custom Ranks on Your SCP: Secret Laboratory Server

Besides the default roles owner, admin and moderator, you can create as many custom roles as you like in the config_remoteadmin.txt file, e.g. a vip rank that only shows a badge or a supporter rank with selected Remote Admin rights. For each role you set the badge, color and kick power, and the permissions decide what its members are allowed to do. In the file, a rank is called a role – both mean the same thing.

The guide Assign Ranks shows you how to give players a rank. You can find the basics of editing the configuration files in the guide Edit Config Files.

Create a custom role

1. Find out the Game Port
   Open the dashboard of your server and note the Game Port shown under Overview.

2. Stop the server
   Stop your server via the dashboard.

3. Connect via SFTP
   Connect to your server via SFTP.

4. Open the configuration file
   Open the following file – replace <Port> with your Game Port:

   /.config/SCP Secret Laboratory/config/<Port>/config_remoteadmin.txt
   

5. Define the role
   Find the entries of the default roles (owner_badge, admin_badge, moderator_badge …). Add a block for your own role below them. The role name comes in front of every key, here using supporter as an example:

   supporter_badge: SUPPORTER
   supporter_color: cyan
   supporter_cover: true
   supporter_hidden: false
   supporter_kick_power: 0
   supporter_required_kick_power: 1
   

   Use a short role name without spaces, e.g. supporter or vip. You can find what each key means in the section The settings of a role.

6. Add the role to the role list
   Find the Roles: section and add your role using the same notation as the existing entries:

   Roles:
    - owner
    - admin
    - moderator
    - supporter
   

   The server only reads roles that are in this list.

7. Grant permissions
   Find the Permissions: section and add your role inside the square brackets of every permission it should get. More on this in the section Assign permissions.

8. Assign members
   Add the players to the Members: section with the name of your new role, e.g.:

   Members:
    - 76561198000000001@steam: supporter
   

   Make sure there is a space before and after the dash. You can find all details in the guide Assign Ranks.

9. Start the server
   Save the file and start your server via the dashboard.

The settings of a role

For comparison, the default values: owner has a kick power of 255 and a required kick power of 255, admin has 1 and 2, moderator has 0 and 1.

Allowed colors

You can use e.g. the following color names for <role>_color:

pink, red, default, brown, silver, light_green, crimson, cyan, aqua,
deep_pink, tomato, yellow, magenta, blue_green, orange, lime, green,
emerald, carmine, nickel, mint, army_green, pumpkin

Use none to hide the badge completely.

Assign permissions

In the Permissions: section every permission is on its own line, followed by the roles that have it in square brackets. To give a role a permission, add its name to the matching line:

 - KickingAndShortTermBanning: [owner, admin, moderator, supporter]

The game knows these permissions:

KickingAndShortTermBanning, BanningUpToDay, LongTermBanning,
ForceclassSelf, ForceclassToSpectator, ForceclassWithoutRestrictions,
GivingItems, WarheadEvents, RespawnEvents, RoundEvents, SetGroup,
GameplayData, Overwatch, FacilityManagement, PlayersManagement,
PermissionsManagement, ServerConsoleCommands, ViewHiddenBadges,
ServerConfigs, Broadcasting, PlayerSensitiveDataAccess, Noclip,
AFKImmunity, AdminChat, ViewHiddenGlobalBadges, Announcer, Effects,
FriendlyFireDetectorImmunity, FriendlyFireDetectorTempDisable,
ServerLogLiveFeed, ExecuteAs, Vanish

If one of these lines is missing from your file, add it in the same format, e.g. - Vanish: [owner].

An overview of some important permissions:

Example: VIP and supporter rank

The role definitions:

vip_badge: VIP
vip_color: yellow
vip_cover: false
vip_hidden: false
vip_kick_power: 0
vip_required_kick_power: 0

supporter_badge: SUPPORTER
supporter_color: cyan
supporter_cover: true
supporter_hidden: false
supporter_kick_power: 0
supporter_required_kick_power: 1

The role list:

Roles:
 - owner
 - admin
 - moderator
 - supporter
 - vip

The changed lines in the Permissions: section. The vip rank does not appear here, so it has no rights:

 - KickingAndShortTermBanning: [owner, admin, moderator, supporter]
 - ForceclassSelf: [owner, admin, moderator, supporter]
 - AdminChat: [owner, admin, moderator, supporter]

Leave all other lines unchanged.

Hidden badges

If <role>_hidden is set to true, a player's badge is invisible at first. The player then gets a notice in the game console that their role has been granted but is hidden.

Every player with a rank can show and hide their badge themselves. To do so, they enter one of these commands in the game console or in the text-based Remote Admin console:

Apply changes

The most reliable way to apply changes to config_remoteadmin.txt is to restart the server via the dashboard.

Alternatively, you can reload the file without a restart:

1. Reload the permissions file
   Enter the following command in the console of the dashboard:

   /pm reload
   

2. Find the player ID
   If a player is currently online and should get their new role right away, enter players in the console. You get a list of all players in the format - Name: UserID [PlayerID].

3. Set the role for online players
   Enter /setgroup, the player ID and the name of the role, e.g.:

   /setgroup 2 supporter
   

   Without this command, the player only gets their new role in the next round.