> For the complete documentation index, see [llms.txt](https://voxel-inc.gitbook.io/voxel-inc-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://voxel-inc.gitbook.io/voxel-inc-docs/mechanics/set-permissions.md).

# ↳ Set permissions

Permissions help you organize effects, defining which ones can be used by players or letting you assign them in exchange of currency.

<figure><img src="https://2175010478-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FglWNFDJNGZfCxpNMetLw%2Fuploads%2Ff0fnKl24OS3qcufkkb8d%2FPermission.png?alt=media&amp;token=4276ec63-cf57-464e-9343-38a1e47031ef" alt="" width="128"><figcaption></figcaption></figure>

### How to lock an effect

When creating an effect, you can make its usage **exclusive** for players that own a **specific** <mark style="background-color:green;">permission</mark>. Once created, you'll be able to assign the *key* via plugins like **LuckPerms** or **PowerRanks**.

<figure><img src="https://2175010478-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FglWNFDJNGZfCxpNMetLw%2Fuploads%2FjeICHM5PxEsaVywWhUuA%2FSPR.png?alt=media&amp;token=c5f96c7d-04d5-4eb7-a49f-795d001682cb" alt="" width="370"><figcaption></figcaption></figure>

{% hint style="danger" %}
Currently, once the permission is set you won't be able to **remove** it. Use <mark style="background-color:green;">only</mark> when necessary!
{% endhint %}

***

### Use a correct format

When creating permission keys, be **sure** to keep in mind that:

* You may use only <mark style="background-color:green;">lowercase</mark> letters
* Spaces will **break** the permission
* <mark style="background-color:green;">Underscores</mark> (\_) and <mark style="background-color:green;">dots</mark> (.) are preferred
* You can type **EXIT** to cancel.

#### Example of permission

```yaml
# You're free to chose your favourite format for permissions

Example:
    effect_name: "&aReaper"
    effect_id: reaper1
    permission: [...]
    # Empty slot will result in no permission assigned
```

Permission example: **vk.effect.reaper** / ...

{% hint style="info" %}
You're free to follow our *suggested* template or write down a unique permission key **by yourself**
{% endhint %}

***

### Default permissions

<table><thead><tr><th width="374">Permission ID</th><th>Description</th></tr></thead><tbody><tr><td><strong>voxelkills.admin</strong></td><td>Allows access to all features</td></tr><tr><td><strong>voxelkills.command.execute</strong></td><td>Allows execution for all commands (bypass)</td></tr><tr><td><strong>voxelkills.commands.access</strong></td><td>Permission for command: /vkills</td></tr><tr><td><strong>voxelkills.panel.access</strong></td><td>Permission for command: /vkills create</td></tr><tr><td><strong>voxelkills.commands.effect</strong></td><td>Permission for command: /vkills effect</td></tr><tr><td><strong>voxelkills.commands.effect.clear</strong></td><td>Permission for command: /vkills effect clear</td></tr><tr><td><strong>voxelkills.commands.effect.equip</strong></td><td>Permission for command: /vkills effect equip</td></tr><tr><td><strong>voxelkills.commands.effect.apply</strong></td><td>Permission for command: /vkills effect apply</td></tr><tr><td><strong>voxelkills.commands.boost</strong></td><td>Permission for command: /vkills boost</td></tr><tr><td><strong>voxelkills.commands.languages</strong></td><td>Permission for command: /vkills languages</td></tr><tr><td><strong>voxelkills.commands.reload</strong></td><td>Permission for command: /vkills reload</td></tr><tr><td><strong>voxelkills.commands.set_cooldown</strong></td><td>Permission for command: /vkills set_cooldown</td></tr><tr><td><strong>voxelkills.commands.settings</strong></td><td>Permission for command: /vkills settings</td></tr></tbody></table>

{% hint style="warning" %}
Permissions work both on commands **and** GUI actions to avoid being **bypassed** from normal players
{% endhint %}

***