Installing

Adding the mod

Once it's released, the mod is added to a server like any other Workshop mod, through your server config or your host's mod list. It has to be on the server. Players download it automatically when they join.

It doesn't need any other mods.

First start

Start the server once with the mod loaded. It creates its folder in the server's profile directory and writes an empty staff list:

$profile:HousoMods/Reforgedmin/PermissionSystem/admins.json

The server log will say so:

[HSM] no admins.json yet - created an empty one at ... Add yourself as owner (ids are logged when you join).

Nobody has access at this point, not even you. That's on purpose. The first owner is always added by hand.

Making yourself owner

Join the server, then look in the server console or log for a line like this:

[HSM] player joined: ozzie | steamId 7656119... | guid a1b2c3d4-... | role none

Copy your Steam ID and GUID into admins.json:

{
  "version": 1,
  "allowVanillaAdmins": false,
  "admins": [
    {
      "name": "ozzie",
      "role": "owner",
      "steamId": "76561190000000000",
      "guid": "a1b2c3d4-0000-0000-0000-000000000000"
    }
  ]
}

You only need one of the two IDs, but filling in both doesn't hurt. Save the file and restart the server. The next time you open the pause menu there'll be an Admin Tools button.

You don't need to write out a permissions block. An entry without one gets its rank's starting set, and the mod writes every permission into the file for you the next time it saves, so you can see what there is to switch.

Adding other staff

After the first owner, you don't have to touch the file again. Staff are added from the Admin Permissions tab in the panel, either picked from the players online or added by ID for someone who isn't on right now. See Roles and permissions.

Testing on a local server

A dedicated server started locally from Workbench isn't connected to Bohemia's backend, so every player shows up with an empty GUID and no Steam ID, and nobody can match an entry. For testing only, add this to admins.json:

"matchNamesWhenNoIds": true

Players with no IDs are then matched by name instead. Players who do have IDs are never matched by name, but leave this off on a real server anyway.