How to Set Up Custom Roles in Enshrouded

In this guide, you will learn how to configure custom permissions and groups for your Enshrouded server. This is designed for advanced users who need granular control over their server.

Danger

If you only need to add admins to your server, the GhostCap panel will handle that for you. You can read how to add admins to Enshrouded in our admin guide.

Setting Up Custom Roles

1. Log in to the GhostCap panel and select your Enshrouded server.
2. Go to File Manager and open the file enshrouded_server.json.
3. Under the userGroups section, add the roles you require.

Below is an example configuration showing multiple role groups. Our panel automatically creates Admin and Everyone groups by default. To remove the admin group, navigate to Startup Parameters and clear the Admin Password field.

Example Configuration

File: enshrouded_server.json

{
    "name": "Enshrouded Server",
    "ip": "0.0.0.0",
    "userGroups": [
        // Admin Group - Full permissions
        {
            "name": "Admin",
            "password": "YourSecureAdminPassword123",
            "canKickBan": true,              // Can kick/ban players
            "canAccessInventories": true,    // Can access all chests
            "canEditBase": true,              // Can edit bases
            "canExtendBase": true,            // Can extend bases
            "reservedSlots": 1                // 1 reserved slot
        },
        // Friend Group - Limited admin permissions
        {
            "name": "Friend",
            "password": "YourSecureFriendPassword456",
            "canKickBan": false,              // Cannot kick/ban
            "canAccessInventories": true,    // Can access chests
            "canEditBase": true,              // Can edit bases
            "canExtendBase": true,            // Can extend bases
            "reservedSlots": 3                // 3 reserved slots
        },
        // Everyone Group - Basic permissions
        {
            "name": "Everyone",
            "password": "YourSecureEveryonePassword789",
            "canKickBan": false,              // Cannot kick/ban
            "canAccessInventories": false,    // Cannot access chests
            "canEditBase": false,              // Cannot edit bases
            "canExtendBase": false,            // Cannot extend bases
            "reservedSlots": 0                // No reserved slots
        }
    ]
}

Danger

Passwords must be unique for each group; otherwise, your server will crash when it starts up.

Permissions and Descriptions

Below are all available role permissions and their functions. Each permission accepts true or false values, with the exception of reservedSlots which requires a number.

If you get stuck at any time, you can reach out to us on Discord.