# Ingame Commands

# Ingame Commands

A complete reference of all KyuubiSoft commands, organized by mod. Includes aliases, permissions, and common workflows.

## Core Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksadmin` | — | `ks.admin` | Open the admin hub (Mods, Status, Language). Subcommands: `reload`, `testsound`, `cleanup nametags`, `migrate-storage`, `addxp`, `removexp`; see [Core](https://wiki.kyuubisoft.com/hytale/core/#ksadmin-subcommands) |
| `/kscitizen` | `npc` | `ks.citizen.admin` or `ks.admin` | Manage NPCs: `edit` (NPC window), `list`, `create`, `remove`, `tp`, `respawn`, `respawnall`, `reload`, `viewer`, ... |
| `/ksnpcshop` | — | `ks.core.shop.user.use` if set, else `ks.shop.user.use` (granted by default) | Core NPC shops: `open <shop>`, `sell <shop>`, `list` |
| `/kssettings` | — | `ks.core.user.settings` (granted by default) | KS settings window: language and per-mod options |
| `/kslang` | — | none | Show or set your language for all KS mods (`/kslang de-DE`, `/kslang auto`) |
| `/ksitemupdate` | `itemupdate` | `ks.itemupdate.user.use` (granted by default) | Update outdated items in your inventory |
| `/ksdev` | `dev` | `ks.admin.dev` (+ `dev.admin` in game) | Developer data export |

Core also registers `/ksshop` for its NPC shops, but with the Player Shops mod installed, `/ksshop` belongs to that mod. Use `/ksnpcshop` for Core's NPC shops.

## Quest Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksquest` | `questbook`, `qb`, `ksquests`, `ksquestbook`, `kqb` | `ks.quest.user.use` (granted by default) | Open the Questbook |
| `/ksquestadmin` | `qadmin` | `ks.quest.admin` | Quest admin: admin window (`panel`), start, complete, reset, claim, debug |
| `/ksquestsettings` | — | `ks.quest.user.settings` (granted by default) | Quest settings |

## Achievement Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksachievements` | `ac`, `achievement` | `ks.achievements.user.use` (granted by default) | Open the achievement book |
| `/kstitles` | `title` | `ks.achievements.user.titles` (granted by default) | Open the titles of the achievement book |
| `/ksrewards` | `reward`, `rw` | `ks.achievements.user.rewards` (granted by default) | Open the rewards of the achievement book |
| `/ksachievementadmin` | `acadmin` | `ks.achievements.admin` | Achievement admin: `panel`, `list`, `grant`, `revoke`, `simulate` |

## Info Hub Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksinfo` | `hub`, `hilfe`, `menu` (configurable) | `ks.info.user.use` (granted by default) | Open the Info Hub book |
| `/ksinfoitem` | `getinfo`, `infobuch` | `ks.info.user.use` (granted by default) | Get the Info Hub item |
| `/ksinfoadmin` | — | `ks.info.admin` (old `infohub.admin` works) | Info Hub admin: `panel`, `reload`, `browsebanners` |

## Season Pass Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksseasonpass` | `sp`, `seasonpass`, `battlepass` | `ks.seasonpass.user.use` (granted by default) | Open the season pass |
| `/ksseasonpassadmin` | `spadmin` | `ks.seasonpass.admin` | Season pass admin: panel, XP, tiers, premium, seasons |

## Bank Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksbank` | `banker` | `ks.bank.user.*` (granted by default) | Open your bank; `page`, `upgrade`, `history` |
| `/ksbank admin` | — | `ks.bank.admin` | Bank admin panel; also `give`, `adminupgrade`, `reset`, `log`, `reload` |

## Pet Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/kspet` | `pet`, `pets` | `ks.pet.user.use` (granted by default) | Open the pet compendium; summon, dismiss, rename, pickup filter |
| `/kscombatpet` | `combatpet`, `cpet` | `ks.pet.user.combat` (granted by default) | Combat pet commands (only when the combat module is enabled) |
| `/ksmount` | `mount` | `ks.pet.user.mount` (granted by default) | Mount commands (only when the mount module is enabled) |
| `/kspetadmin` | `petadmin` | `ks.pet.admin` | Pet admin window (create pets, loot luck blacklist, player pets) and admin commands |

See the [Pet System commands](https://wiki.kyuubisoft.com/hytale/pets/commands/) for every subcommand.

## Lootbag Commands (Standalone)

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/kslootbags` | `lb`, `lootbag` | `ks.lootbag.user.use` (granted by default) | Open the lootbag catalog |
| `/kslootbagsadmin` | `lbadmin` | `ks.lootbag.admin` | Lootbag admin panel, give, preview, reload |

## Graveyard Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksgraveyard` | `grave`, `gy` | `ks.graveyard.user.use` (granted by default) | `menu`, `list`, `locate` |
| `/ksgraveyard admin_...` | — | `ks.graveyard.admin` | Admin subcommands, designs, particles, reload |

## Player Shop Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksshop` | `shop`, `market` | `ks.shop.user.*` (granted by default) | Player shops: browse, create, edit, rentals |
| `/ksshopadmin` | `kssa` | `ks.shop.admin` | Shop admin window and commands |

See [Player Shops commands](https://wiki.kyuubisoft.com/hytale/player-shops/commands/).

## Item Control Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksitem` | `itemcontrol`, `ic` | `ks.item.admin` + `kyuubisoft.itemcontrol.admin` (admin tools); `browse` and `compare` are player commands | Item control: browser, recipes, drops, overrides, inventories |
| `/ksitem give <itemId> [--amount=<n>]` | — | `ks.item.give` + `kyuubisoft.itemcontrol.give` | Give yourself an item, one by default |
| `/ksitem inv ...` | — | `ks.item.admin` + `kyuubisoft.itemcontrol.inventory` | View, back up, restore and clear inventories |
| `/ksitem inv wipe <itemId>` | — | The same, plus `ks.item.admin.removeall` | Remove an item from everyone online |
| `/soulbound` | — | `ks.item.user.soulbound` (granted by default) | Check the soulbound state of your held item |

`ks.item.admin` does not include `ks.item.admin.removeall` or `ks.item.admin.clearslot`, which **Clear**, **Clear slot** and `/ksitem inv clear` need. See [Item Control commands](https://wiki.kyuubisoft.com/hytale/item-control/commands/) for all subcommands and [Item Control permissions](https://wiki.kyuubisoft.com/hytale/item-control/permissions/) for the node pairs.

## VoiceHub Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksvoice` | `vc`, `voicehub` | none (player commands) | Voice channels and the VoiceHub window |
| `/ksvoice admin`, `/ksvoice proximity` | — | `kyuubisoft.voicehub.admin` (configurable) | VoiceHub admin |

## Nameplate and Dungeon Commands (in development)

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksnameplate` | `nameplate`, `np`, `tag`, `tags` | `ks.nameplate.user.use` (granted by default) | Nameplates; `admin` needs `ks.nameplate.admin` + `kyuubisoft.nameplates.admin` |
| `/ksdungeon` | `dungeon`, `dg` | `ks.dungeon.user.use` (granted by default) | Dungeons; admin subcommands need `ks.dungeons.admin` |

## ChatPlus Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/kschat` | `ksc`, `chat` | `ks.chat.user.use` (granted by default) | Chat settings and channels |
| `/kschatadmin` | `ksca` | `ks.chat.admin` | Chat admin |
| `/ksmail` | `mail` | `ks.chat.user.msg` (granted by default) | Send and read mail |
| `/msg` | `m`, `tell` | `ks.chat.user.msg` (granted by default) | Send a private message |
| `/r` | `reply` | `ks.chat.user.msg` (granted by default) | Reply to the last private message |
| `/me`, `/do`, `/ooc`, `/whisper`, `/shout` | — | `ks.chat.user.rp` (granted by default) | Roleplay chat |

## Claims Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksclaim` | `claim`, `claims` | `ks.claims.user.<action>` (granted by default) | Claims window; `claim`, `unclaim`, `info`, `list`, `rename`, `home`, `sethome`, `trust`, `untrust`, `ban`, `unban`, `transfer`, `accept`, `delete`, `buychunks`, `border`, `help` |
| `/ksclaimadmin` | `claimadmin` | `ks.claims.admin` | Admin window; `bypass`, `claimfor`, `transfer`, `delete`, `quota`, `inspect`, `reload`, `zone create`, `zone delete`, `help` |

Since Claims 2.0.0 the aliases `/ksc` and `/ksca` belong to ChatPlus only. See [Claims commands](https://wiki.kyuubisoft.com/hytale/claims/commands/).

## Guild Commands (in development)

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksguild` | `guild`, `gilde` | `ks.guilds.user.<action>` (granted by default) | Guild window; `create`, `invite`, `accept`, `deny`, `join`, `request`, `withdraw`, `leave`, `kick`, `promote`, `demote`, `transfer`, `disband`, `info`, `contribute`, `help` |
| `/ksguild lock`, `unlock`, `lockinfo`, `autolock` | — | `ks.guilds.user.lock`, `.unlock`, `.lockinfo`, `.autolock` (granted by default) | Lock the chest or door you look at |
| `/ksguild home [1\|2]`, `/ksguild sethome [1\|2]` | — | `ks.guilds.user.home`, `ks.guilds.user.sethome` (granted by default) | Travel to or set the guild home |
| `/ksguild land add\|remove\|list` | — | `ks.guilds.user.land` (granted by default) | Guild land, only with Claims 2.0 |
| `/ksguild admin` | — | `ks.guilds.admin` | Guild admin window |
| `/gc [text]` | — | `ks.guilds.user.chat` (granted by default) | Guild chat; alone it switches the guild chat mode |

What a member may do inside a guild is set by the guild's rank rights. See [Guilds commands](https://wiki.kyuubisoft.com/hytale/guilds/commands/).

## Heirlooms Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksheirloom` | — | `ks.heirlooms.user.open` (granted by default) | Story window of the item in your hand |
| `/ksheirloom admin` | — | `ks.heirlooms.admin` | Heirlooms admin window |
| `/ksheirloom test [--level=<0-3>]`, `check`, `clear`, `wear` | — | `ks.heirlooms.admin` | Test tools for the item in your hand |
| `/ksheirloom reload` | — | `ks.heirlooms.admin` | Reload `config.json` and the language files |

See [Heirlooms commands](https://wiki.kyuubisoft.com/hytale/heirlooms/commands/).

## Whisperstone Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/kswhisper` | — | `ks.whisperstone.user.use` (granted by default) | Open your Whisperstone |
| `/kswhisper give <player>`, `reload`, `demo`, `demo ring` | — | `ks.whisperstone.admin` | Give a stone, reload config, runes and texts, add a test companion |

See [Whisperstone commands](https://wiki.kyuubisoft.com/hytale/whisperstone/commands/).

## Weapon Mastery Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksmastery` | `wm`, `mastery` | `ks.mastery.user.use` (granted by default) | View your weapon mastery progress |
| `/ksmasteryadmin` | `wmadmin` | `ks.mastery.admin` | Mastery admin: add XP, set level, reset, reload |

## Mob Control Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksmobcontrol` | `mobcontrol` | `ks.mobcontrol.admin` | Mob control: manage spawns and culling |

## Ore Regeneration Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/ksoreregen` | `oreregen` | `ks.oreregen.admin` | Ore regeneration: manage ore respawn settings |

## Web Editor Commands

| Command | Aliases | Permission | Description |
|---------|---------|------------|-------------|
| `/kseditor` | — | `ks.admin.editor` (+ `kyuubisoft.editor` in game) | Start a web editor session |
| `/kstrusteditor <code>` | — | `ks.admin.editor` (+ `kyuubisoft.editor` in game) | Confirm your editor session with the code shown in the browser |
| `/ksapplyconfig <code>` | — | `ks.admin.editor` + `kyuubisoft.editor` | Apply changes of your own confirmed session manually |

These commands only exist while the web editor module is on (`modules.webEditor` in Core's `config.json`).

---

## Admin Testing Workflow

A step-by-step workflow for testing new quest content as an admin:

### 1. Reload Configs
```
/ksadmin reload
```
Reloads all config files from disk. Always do this after editing any JSON file.

### 2. Respawn NPCs
```
/kscitizen respawnall
```
Forces all citizens to despawn and respawn. Required after changing citizen configs. Use `/kscitizen respawn <id>` to respawn a single citizen.

### 3. Enable Debug Mode
```
/ksquestadmin debugmode
```
Toggles live tracking debug output for your player. The output goes to the **server console** (it is not shown in game): tracking events as they fire and how they progress your quests.

### 4. Start a Quest Manually
```
/ksquestadmin start <player> <questId>
```
Bypasses NPC interaction and prerequisites. Useful for testing specific quests directly.

### 5. Complete a Quest Manually
```
/ksquestadmin complete <player> <questId>
```
Force-completes a quest, granting all rewards. Use this to test reward delivery.

### 6. Reset a Quest
```
/ksquestadmin reset <player> <questId>
```
Resets the quest to its initial state so you can test it again from the beginning.

### Full Test Cycle Example
```
/ksadmin reload
/kscitizen respawnall
/ksquestadmin debugmode
— Walk to NPC, accept quest, complete objectives, turn in —
/ksquestadmin reset YourName my_quest_id
— Test again —
/ksquestadmin debugmode
```

## Player Workflow

How players typically interact with KyuubiSoft mods:

### Quest Flow
1. **Discover** — Walk up to an NPC with a quest marker above their head.
2. **Accept** — Read the dialog and click "Accept".
3. **Progress** — Complete objectives (collect items, defeat enemies, visit locations).
4. **Track** — Use `/ksquest` to open the quest book and track progress.
5. **Turn in** — Return to the NPC and complete the quest for rewards.

### Achievements
1. **Earn** — Achievements unlock automatically as you play (kill enemies, craft items, explore).
2. **View** — Use `/ksachievements` to browse all achievements and your progress.
3. **Claim** — Some achievements grant rewards. Use `/ksrewards` to claim pending rewards.
4. **Titles** — Unlock titles through achievements. Use `/kstitles` to equip a title.

### Info Hub
1. **Open** — Use `/ksinfo` or interact with the info hub item.
2. **Browse** — Read guides, server rules, and announcements.

## Debug Mode

The quest debug mode (`/ksquestadmin debugmode`) writes live tracking output for the player who switched it on to the server console: which tracking events fire and how they progress quests. Use it together with the Quests admin window (`/ksquestadmin panel`) to look at a player's quest states. Other players are not affected.

## Common Issues

### "Command not found"

- **Check permissions** — Most admin commands require specific permission nodes (e.g. `ks.admin`, `ks.quest.admin`). Make sure your player or rank has the required permission. See [Permissions](https://wiki.kyuubisoft.com/hytale/permissions/).
- **Check spelling** — Commands use the `ks` prefix. It is `/ksadmin`, not `/admin`.
- **Check aliases** — You can use aliases like `qadmin` instead of `ksquestadmin`.

### "NPC won't respond"

- **Check citizenId** — The `citizenId` in the quest NPC profile must exactly match the `id` in the citizen config.
- **Check quest availability** — The quest may have prerequisites that are not met.
- **Reload** — Run `/ksadmin reload` and `/kscitizen respawn <id>`.

### "Quest stuck in progress"

- **Check objectives** — Use `/ksquestadmin debugmode` to see which objective is not progressing.
- **Check target spelling** — Objective `target` must exactly match the item/entity ID.
- **Reset** — Use `/ksquestadmin reset <player> <questId>` to start over.

### "Rewards not received"

- **Check rewards config** — Verify item IDs and amounts in the quest config.
- **Check pending rewards** — Use `/ksrewards` to see if rewards are pending claim.
- **Check inventory space** — Item rewards require inventory space.

### "Config not loading"

- **Validate JSON** — Use a JSON validator to check for syntax errors (missing commas, unclosed brackets).
- **Check server logs** — The console shows detailed error messages with file paths and line numbers.
- **Check file location** — Custom files must be in the `custom/` subfolder with the `custom_` prefix.