# Permissions

Whisperstone checks five permission nodes. The four player nodes are allowed unless you set them to `false`. The admin node is not granted by default. Command syntax is on the [Commands](./commands) page.

## Permission nodes

| Permission | Default | Gates |
|------------|---------|-------|
| `ks.whisperstone.user.use` | allowed | Opening the stone (item and `/kswhisper`), the **Companions** and **Stone** runes, sending and accepting companion requests |
| `ks.whisperstone.user.message` | allowed | The **Raven** rune, writing messages and sharing positions |
| `ks.whisperstone.user.call` | allowed | The **Farcall** rune, starting farcalls and being called |
| `ks.whisperstone.user.map` | allowed | The **Star Map** rune and the stone's markers on the world map |
| `ks.whisperstone.admin` | not granted | `/kswhisper give`, `reload`, `demo` and `demo ring` |

The four player nodes are checked once when the first player joins after a server start, so they show up in permission plugins.

## What a denied node does

### ks.whisperstone.user.use

- Right-clicking the stone and `/kswhisper` answer `You may not use the Whisperstone.` and nothing opens.

### ks.whisperstone.user.message

- The **Raven** rune is hidden.
- In a conversation the text field and the share button are hidden, so conversations can only be read.
- The **New message** button in the Raven, the raven button next to each companion and **Share position** on the Star Map are hidden.
- The player still receives messages and notices.

### ks.whisperstone.user.call

- The **Farcall** rune, the call buttons and the **Accept farcalls** switch are hidden.
- Nobody can call this player. Callers see `<name> is not taking calls right now.`

### ks.whisperstone.user.map

- The **Star Map** rune is hidden.
- The player sees no shared positions and no companions from the stone on their world map. Shared positions still arrive as messages in the conversation.

## What the nodes do not cover

- **Declining requests, removing and blocking companions, unblocking and the five settings** have no node of their own. Everyone who can open the stone can do them.
- **Receiving.** Messages, notices and companion requests reach every player, whatever their nodes are.
- `/kslang` has no permission.

## Runes of other mods

Each rune in `runes.json` has its own `permission`. By default these are the player nodes of the other mods, for example `ks.bank.user.page` for the Treasury rune or `ks.voicehub.user.use` for the Voice Channels rune. A player who has that node set to `false` does not see the rune. The command the rune runs is then checked again by the other mod itself. See [Configuration](./configuration#runes-file) for the full list.

## LuckPerms examples

### Staff gets the admin commands

```
/lp group admin permission set ks.whisperstone.admin true
```

### Guests may write but not call or show up on the map

```
/lp group guest permission set ks.whisperstone.user.call false
/lp group guest permission set ks.whisperstone.user.map false
```

### Hide the Treasury rune for a group

```
/lp group guest permission set ks.bank.user.page false
```

This also takes `/ksbank page` away from that group in the Bank itself.