> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.sparkedhost.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# How to setup OpenMod Permission System

### How to setup OpenMod Permission System

1. The first thing you will want to do is navigate to `/Servers/unturned/Openmod`.

2. Once you get there you should see a file called `openmod.roles.yaml`.

3. So once you get there you will see the default roles for Openmod.

4. You will most likely want to edit these roles to add Staff Roles, Donator Roles, and regular players roles.

### Example of adding a new role

You can copy and paste this and just change the names of each role. 

|| Note: Keep in mind the YAML syntax **must** be correct or the hot reloading of the file will fail!

```
id: ExampleRole
priority: 1
parents:
- default
permissions:
displayName: ExampleRole
data: {}
isAutoAssigned: false
```

### Example of adding permissions to a role

You will keep adding permissions like so for each role that you want to have the permission.

```
- id: ExampleRole
priority: 1
parents:
- default
permissions:
- examplepermission
- examplepermission
displayName: ExampleRole
data: {}
isAutoAssigned: false
```

### Command to add people to roles

`openmod role add player playername rolename` **or** `om role add player playername rolename`

### Command to remove people from roles

`openmod role remove player playername rolename` **or** `om role remove player playername rolename`

---

If you require any further assistance, please create a ticket [here](https://billing.sparkedhost.com/submitticket.php).

---

Created By: Griffin H.