Knowledgebase

Server Roles Configuration Print

  • 0

Overview

User Groups define what actions players are allowed to perform. Players gain these permissions by entering the group's password in-game. A single player can be a member of multiple groups, inheriting the combined permissions.

Location of the Configuration

This setting is located in your server's main configuration file:
enshrouded_server.json

Explanation of User Group Options

Each object in the userGroups array represents a distinct permission set. Below is a breakdown of all available options.

 
Option Type Description
name string Required. The display name for this user group. This is for your administrative
reference (e.g., "Admins", "Builders", "Friends").
password string Required. The password that players must enter in-game to join this group
and receive its permissions.
canAccessInventories boolean If true, members can open and use all shared storage containers
(chests, etc.) within the server's flame altars.
canEditBase boolean If true, members can build, place, and destroy blocks/objects within the server's
flame altars. This is essential for construction.
canExtendBase boolean If true, members can build new Flame Altars, which claim land and extend the
buildable area.
canKickBan boolean If true, members have access to server administration commands to kick or ban
other players. Use this privilege sparingly.
reservedSlots integer Not yet fully implemented. This is intended to reserve a number of server slots
for members of this group. Currently, setting this has no effect.

Practical Example & Use Case

Let's create a multi-layered permission structure for a server with Admins, Trusted Builders, and General Members.

 
"userGroups": [
    {
        "name": "Admins",
        "password": "admin123",
        "canAccessInventories": true,
        "canEditBase": true,
        "canExtendBase": true,
        "canKickBan": true,
        "reservedSlots": 2
    },
    {
        "name": "Builders",
        "password": "build456",
        "canAccessInventories": true,
        "canEditBase": true,
        "canExtendBase": true,
        "canKickBan": false,
        "reservedSlots": 0
    },
    {
        "name": "Members",
        "password": "friend789",
        "canAccessInventories": true,
        "canEditBase": false,
        "canExtendBase": false,
        "canKickBan": false,
        "reservedSlots": 0
    }
]
  • Admins: Have full control, including player management.

  • Builders: Can build and expand bases and use storage, but cannot kick players.

  • Members: Can only access shared storage but cannot build or alter the world.

 

How Players Join a Group

  1. In-game, the player must open the Game Menu (default key: ESC).

  2. Click on Server Settings.

  3. Select the Groups tab.

  4. Enter the password for the desired group and click "Join Group".

Once joined, the player will immediately have the permissions associated with that group.

You can also join the password-protected server by entering the password associated with the group.
You will join the server with the group directly.

Important Notes

  • Restart Required: You must stop and restart your dedicated server for changes to the enshrouded_server.json file to take effect.

  • Default Permissions: Players who are not in any group have the most basic permissions and typically cannot build or access storage.

  • Permission Stacking: If a player joins multiple groups, they get the highest level of permission from any of them. If one group has canKickBan: false but another has canKickBan: true, the player will be able to kick and ban.


Was this answer helpful?
Back