> For the complete documentation index, see [llms.txt](https://docs.rainmad.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rainmad.com/resources/watch-admin-menu/permissions/roles-and-groups.md).

# Roles and groups

Every action in rm\_watch, in game, on the web panel or from Discord, goes through one role check. There are three built-in roles, and on top of them custom groups you build yourself. The game and the web panel share the same groups.

| Role         | Rank    | For                                                          |
| ------------ | ------- | ------------------------------------------------------------ |
| `owner`      | 100     | You. Everything, including staff management and the console. |
| `admin`      | 80      | Senior staff. Bans, server tools, most things.               |
| `moderator`  | 40      | Day to day moderation. Kick, warn, jail, tickets.            |
| custom group | 1 to 99 | Whatever you switch on for it.                               |

A player gets the **highest** role they qualify for from any of the sources below.

## Where a role comes from

{% tabs %}
{% tab title="Ace (recommended)" %}
In `server.cfg`, give an identifier or a whole group one of the objects in `cfg.admin.aces`:

```cfg
# one person as owner
add_ace group.rm_watch_owner rm_watch.owner allow
add_principal identifier.license:YOUR_LICENSE group.rm_watch_owner

# a whole existing group as moderators
add_ace group.mod rm_watch.moderator allow

# a custom group by ace: rm_watch.<group name>
add_ace group.support rm_watch.support allow
```

Any identifier works as the principal: `license:`, `discord:`, `steam:`, `fivem:`.

{% hint style="danger" %}
Grant one exact object, such as `rm_watch.moderator`. Never the bare `rm_watch`: aces are hierarchical, so that line gives every role and every custom group.
{% endhint %}
{% endtab %}

{% tab title="In the menu" %}
**Staff** tab in game, or **Staff and roles** on the web panel. Give a group to a player who is online (by server id) or offline (by identifier). A Discord account can hold a group too (`discord:<user id>`), which is how a web panel member gets the same group in game.
{% endtab %}

{% tab title="Discord role" %}
Map a Discord role to a group and everyone holding it gets that group. See [Discord roles](https://docs.rainmad.com/resources/watch-admin-menu/permissions/discord-roles).
{% endtab %}

{% tab title="Framework admins" %}
Admins of your framework (Qbox and QBCore `admin` or `god`, ESX `admin` or `superadmin`) get the role in `cfg.admin.frameworkAdmins`: `'admin'` by default, `'moderator'`, or `false` to ignore them.
{% endtab %}
{% endtabs %}

## Custom groups

Open **Staff** in the menu (or **Staff and roles** on the web panel) and create a group: a name, a colour, a rank from 1 to 99, and its rights.

A right is decided in this order:

1. The action's own switch, if the group has one.
2. Otherwise the switch of the action's **category**.
3. Otherwise the rank: the action is on when the group's rank reaches what the action needs (40 for moderator actions, 80 for admin, 100 for owner).

So a group of rank 50 with no switches can do everything a moderator can. Switch the **Moderation** category off and it loses all of it at once; switch `kick` back on and it keeps that one.

The categories in the group editor:

| Category                | Covers                                                                                                      |
| ----------------------- | ----------------------------------------------------------------------------------------------------------- |
| Players                 | Go to, bring, heal, revive, freeze, slap, cuff, spectate and the other player tools                         |
| Moderation              | Warn, kick, jail, ban, notes, records, mute, community service, whitelist, blacklist, appeals               |
| Economy and items       | Money, jobs, items, weapons, ped model, routing bucket, clothing menu, screenshots, the rich list, invoices |
| Self tools              | Noclip, godmode, invisible, names, your own settings                                                        |
| Vehicle tools           | Spawning, repair, the owned vehicle list and its edits                                                      |
| Server                  | Announcements, weather, time, cleanup, blips, zones, duty, the console and resources                        |
| Staff management        | Groups, members, Discord role mapping, character delete                                                     |
| Staff chat              | Chat, voice notes, the staff voice channel                                                                  |
| Tickets                 | Every ticket action                                                                                         |
| Data and export         | The Data pages of the web panel                                                                             |
| Events, polls and teams | The Community tab and pages                                                                                 |
| Replays, Live view      | Auto replay and live view                                                                                   |
| Server metrics          | Dashboard numbers, profiling, restart                                                                       |
| Other                   | Anything that fits nowhere else                                                                             |

The built-in `admin` and `moderator` groups can be edited the same way (rights, label, colour, never their rank) and reset to their defaults. `owner` always holds everything and cannot be edited or handed out from a panel: only an ace or `cfg.admin.discord.roles.owner` makes someone owner.

## Safety rules

These hold in the menu, on the web and in Discord:

* You only create, edit or delete a group ranked **below** your own.
* A group you save can never do something you cannot do yourself.
* You only give a group that is below you, and you never change yourself or someone at or above your rank.
* With `cfg.admin.protectStaff = true` (the default), staff cannot kick, ban, jail or otherwise act on staff of the **same or higher** rank.

Every change is written to the staff log with who made it and what changed.

## Lowering one action

To move one action without touching anyone's role, use `cfg.admin.permissions`. The key is the action name:

```lua
cfg.admin.permissions = {
    ban = 'moderator',              -- moderators may ban
    ['vehicle:spawn'] = 'moderator',
    kill = 'admin',
}
```

Action names are listed on each feature page under **Permissions**.

## Duty

With `cfg.admin.duty.required = true`, staff must be on duty (`/duty`) before any action works. Some actions still work off duty, such as your own settings, the staff chat and reading tickets.
