# Permissions

# Permissions

All KyuubiSoft mods use a consistent permission system. Player commands are **allowed by default** — you only need to configure permissions if you want to **restrict** access for specific groups.

Admin commands are **blocked by default** and must be explicitly granted.

:::tip Compatible with LuckPerms & HyperPerms
All permission nodes are automatically registered on first player join and immediately visible in your permission plugin. Use your permission plugin to deny specific nodes for groups.

Example (LuckPerms): `/lp group default permission set ks.bank.user.upgrade false`
Example (HyperPerms): `/hp group setperm default ks.bank.user.upgrade false`
:::

---

## How It Works

| Type | Method | Default | Description |
|------|--------|---------|-------------|
| **Player** | `hasPermission(node, true)` | Allowed | Everyone can use it. Set to `false` to block. |
| **Admin** | `requirePermission(node)` | Blocked | Must be explicitly granted to use. |

---

## Core System

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.core.user.settings` | Player | `/kssettings` | KS settings window |
| `ks.itemupdate.user.use` | Player | `/ksitemupdate` | Item update window |
| `ks.core.shop.user.use` | Player | `/ksnpcshop open/sell/list` | Core NPC shops; decides when an admin set it |
| `ks.shop.user.use` | Player | `/ksnpcshop open/sell/list` | Core NPC shops while `ks.core.shop.user.use` is not set |
| `ks.citizen.user.repair` | Player | `/kscitizen repair` | Item repair window |
| `ks.admin` | Admin | `/ksadmin`, `/ksadmin reload`, `testsound` | Admin hub, NPC shop editor; also accepted for NPC tools |
| `ks.admin.cleanup` | Admin | `/ksadmin cleanup nametags` | Plus `kyuubisoft.admin` in game |
| `ks.admin.migrate` | Admin | `/ksadmin migrate-storage` | Plus `kyuubisoft.admin` in game |
| `ks.admin.xp` | Admin | `/ksadmin addxp/removexp` | Plus `kyuubisoft.admin` in game |
| `ks.admin.editor` | Admin | `/kseditor`, `/kstrusteditor`, `/ksapplyconfig` | Web editor; plus `kyuubisoft.editor` in game |
| `ks.admin.dev` | Admin | `/ksdev` | Developer tools; plus `dev.admin` in game |
| `ks.citizen` | Admin | `/kscitizen` | Only the bare usage list |
| `ks.citizen.admin` | Admin | `/kscitizen` subcommands | NPC management, skin editor, NPC viewer, dialog editor (`ks.admin` or the old `citizen.admin` work too) |
| `ks.core.admin.dialog.console` | Admin | NPC, dialog and shop editors, web editor imports | Add, change or remove anything that runs as the server console |

:::caution[Console commands]
`ks.core.admin.dialog.console` is needed on top of a mod's admin node for everything that runs as the server console: NPC and dialog commands, Core shop entries, quest rewards and NPC profiles, achievement rewards, Info Hub quick tiles, Season Pass rewards and Item Control command blocks. It is not granted to anyone by default, also not with `ks.admin`. See [Console Commands](https://wiki.kyuubisoft.com/hytale/permissions/#console-commands).
:::

---

## Item & Economy Bank

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.bank.user.open` | Player | `/ksbank`, `/ksbank open` | Open your bank |
| `ks.bank.user.page` | Player | `/ksbank page <nr>` | Switch bank page |
| `ks.bank.user.upgrade` | Player | `/ksbank upgrade` | Unlock next page |
| `ks.bank.user.history` | Player | `/ksbank history` | View transaction history |
| `ks.bank.admin` | Admin | `/ksbank give/reset/log/reload/admin` | Bank administration |

---

## Full Item Control

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.item.user.browse` | Player | `/ksitem browse` | Browse items |
| `ks.item.user.compare` | Player | `/ksitem compare` | Compare items |
| `ks.item.user.soulbound` | Player | `/soulbound` | View soulbound info of your held item |
| `ks.item.admin` | Admin | `/ksitem admin/reload/module/...` | Item Control administration, together with `kyuubisoft.itemcontrol.admin` (`/ksitem inv`: `kyuubisoft.itemcontrol.inventory`) |
| `ks.item.admin.clearslot` | Admin | **Clear**, **Clear slot**, `/ksitem inv clear` | Clear a whole inventory or a single slot. Not part of `ks.item.admin`, but part of `ks.item.admin.*` |
| `ks.item.admin.removeall` | Admin | `/ksitem inv wipe`, **Remove item from everyone** | Remove an item from everyone online. Not part of `ks.item.admin`, but part of `ks.item.admin.*` |
| `ks.item.give` | Admin | `/ksitem give` | Give items to yourself, together with `kyuubisoft.itemcontrol.give`. **Give Item** in the Item Browser needs both, and the `admin-give` module |

---

## Companions (Pets)

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.pet.user.use` | Player | `/kspet` | Open pet menu |
| `ks.pet.user.combat` | Player | `/kscombatpet` | Combat pet commands |
| `ks.pet.user.mount` | Player | `/ksmount` | Mount commands |
| `ks.pet.admin` | Admin | `/kspetadmin` | Pet administration |

---

## Quest System

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.quest.user.use` | Player | `/ksquest` | Open quest book |
| `ks.quest.user.settings` | Player | `/ksquestsettings` | Quest HUD settings |
| `ks.quest.admin` | Admin | `/ksquestadmin` | Quest administration and the Quests admin window |

---

## Achievements

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.achievements.user.use` | Player | `/ksachievements` | View achievements |
| `ks.achievements.user.titles` | Player | `/kstitles` | Manage titles |
| `ks.achievements.user.rewards` | Player | `/ksrewards` | Claim rewards |
| `ks.achievements.admin` | Admin | `/ksachievementadmin` | Achievement administration and the admin window |

---

## Season Pass

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.seasonpass.user.use` | Player | `/ksseasonpass` | Open season pass |
| `ks.seasonpass.admin` | Admin | `/ksseasonpassadmin` | Season pass administration |

---

## Claims

Every `/ksclaim` subcommand has its own player node, allowed by default. What a player may do inside a claim comes from their role there, not from a node.

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.claims.user.<action>` | Player | `/ksclaim` and its subcommands | One node per action (`open`, `claim`, `trust`, `home`, `border`, ...); set one to `false` to take that command away |
| `ks.claims.admin` | Admin | `/ksclaimadmin` | Claims administration and the admin window |
| `ks.claims.admin.bypass` | Admin | – | Ignores the protection of every claim and server zone |
| `ks.claims.chunks.<n>`, `ks.claims.claims.<n>` | Player | – | Quota tiers, not granted by default; `.unlimited` removes the limit |

See [Claims permissions](https://wiki.kyuubisoft.com/hytale/claims/permissions/).

---

## VoiceHub

VoiceHub's player commands have **no permission nodes**; every player may use them.

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `kyuubisoft.voicehub.admin` | Admin | `/ksvoice admin`, `/ksvoice proximity` | VoiceHub administration (node name configurable) |
| `kyuubisoft.voicehub.create` | Player | `/ksvoice create` | Only checked when `allowPlayerCreatedChannels` is `false` |

See [VoiceHub permissions](https://wiki.kyuubisoft.com/hytale/voicehub/permissions/).

---

## Graveyard

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.graveyard.user.use` | Player | `/ksgraveyard menu/list/locate` | Gravestone management |
| `ks.graveyard.admin` | Admin | `/ksgraveyard admin_list/admin_clear/admin_remove/admin_tp/admin_stats`, designs, particles, `reload` | Graveyard administration |

---

## Info Hub

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.info.user.use` | Player | Section pages, info commands | Access info pages |
| `ks.info.admin` | Admin | `/ksinfoadmin` | Info Hub administration and admin window (the old `infohub.admin` still works) |

---

## Lootbags

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.lootbag.user.use` | Player | `/kslootbags` | Open lootbags |
| `ks.lootbag.admin` | Admin | `/kslootbagsadmin` | Lootbag administration |

---

## Player Shops

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.shop.user.browse` | Player | `/ksshop` | Browse player shops |
| `ks.shop.user.create` | Player | `/ksshop` | Create your own shop |
| `ks.shop.user.edit` | Player | `/ksshop edit` | Edit your own shop |
| `ks.shop.user.collect` | Player | `/ksshop` | Collect sold items and coins |
| `ks.shop.user.delete` | Player | `/ksshop` | Delete your own shop |
| `ks.shop.user.rate` | Player | `/ksshop rate` | Rate shops |
| `ks.rental.rent`, `ks.rental.bid` | Player | Rental stations | Rent shops, bid on rentals |
| `ks.shop.admin` | Admin | `/ksshopadmin` | Shop administration (`ks.admin` alone is not enough) |

See [Player Shops permissions](https://wiki.kyuubisoft.com/hytale/player-shops/permissions/) for listing perks and limits.

---

## KS Nameplates

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.nameplate.user.use` | Player | `/ksnameplate` | Manage your nameplate |
| `ks.nameplate.admin` | Admin | `/ksnameplate admin` | Nameplate administration, together with `kyuubisoft.nameplates.admin` (configurable) |

---

## ChatPlus

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.chat.user.use` | Player | `/kschat` | Chat settings |
| `ks.chat.user.msg` | Player | `/msg`, `/r`, `/ignore`, `/ksmail` | Private messaging |
| `ks.chat.user.rp` | Player | `/me`, `/do`, `/ooc`, `/whisper`, `/shout` | Roleplay commands |
| `ks.chat.admin` | Admin | `/kschatadmin` | Chat administration |

---

## Weapon Mastery

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.mastery.user.use` | Player | `/ksmastery` | View weapon mastery |
| `ks.mastery.admin` | Admin | `/ksmasteryadmin` | Mastery administration |

---

## KS Dungeons

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.dungeon.user.use` | Player | `/ksdungeon open/play/leave/party` | Dungeon access |
| `ks.dungeon.user.map.use` | Player | `/ksdungeon maps/mapinfo`, using maps | Dungeon maps |
| `ks.dungeon.user.stone.use` | Player | Using dungeon stones | Dungeon stones |
| `ks.dungeons.admin` | Admin | `/ksdungeon givemap/givestone/testmap/browseprefabs` | Dungeon administration |

---

## Showcase

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.showcase.user.use` | Player | `/ksshowcase` | Showcase features |
| `ks.showcase.admin` | Admin | `/ksshowcase savepack` | Save into an asset pack |

---

## Other

| Permission | Type | Command | Description |
|-----------|------|---------|-------------|
| `ks.mobcontrol.admin` | Admin | `/ksmobcontrol` | Mob control administration |
| `ks.oreregen.admin` | Admin | `/ksoreregen` | Ore regeneration administration |

---

## Language Selection

The `/kslang` command has **no permission requirement** — it is always accessible to all players.

---

## Quick Setup

:::info Automatic Registration
All player permission nodes are **automatically registered** when the first player joins the server. You don't need to create them manually — they will appear in your permission plugin immediately.
:::

### LuckPerms

To deny a specific permission for a group:
```
/lp group default permission set ks.bank.user.upgrade false
```

To grant an admin permission:
```
/lp group admin permission set ks.bank.admin true
```

### HyperPerms

To deny a specific permission for a group:
```
/hp group setperm default ks.bank.user.upgrade false
```

To grant an admin permission:
```
/hp group setperm admin ks.bank.admin true
```

Or use the visual editor:
```
/hp editor
```