# Commands

Quests has two player commands and one admin command collection. Most admin work is easier in the [admin window](./admin-panel) (`/ksquestadmin panel`); the subcommands below are useful for the console, NPC dialogs and quick tests.

---

## Player commands

### /ksquest

Opens the [Questbook](./quest-book-ui).

```
/ksquest
/ksquest settings
```

| Usage | What it does | Permission |
|-------|--------------|------------|
| `/ksquest` | Opens the Questbook | `ks.quest.user.use` |
| `/ksquest settings` (or `config`) | Opens the Questbook on its settings window | `ks.quest.user.settings` |

**Aliases:** `ksquests`, `ksquestbook`, `kqb`, `questbook`, `qb`

### /ksquestsettings

Opens the Questbook on its settings window directly, same as `/ksquest settings`. Needs `ks.quest.user.settings`.

Both player nodes are granted by default. Tracker options are also on the Quests page of `/kssettings`, and the language for all KS mods is set with `/kslang` (both commands come from KyuubiSoft Core).

---

## Admin commands

`/ksquestadmin` (alias `qadmin`). The collection and every subcommand need **`ks.quest.admin`**. Commands that write data are refused for showcase accounts on a showcase server. The server console may run every subcommand that does not need a player of its own.

```
/ksquestadmin <subcommand> [arguments]
```

### Windows

| Subcommand | What it does |
|------------|--------------|
| `panel` | Opens the [admin window](./admin-panel) |
| `npcprofile [citizenId]` | Opens the admin window on the NPC profiles tab, optionally on that NPC |

### Content

| Subcommand | What it does |
|------------|--------------|
| `reload` | Reloads `config.json`, quests, chapters, pools, triggers, NPC profiles and languages from disk and plans the resets again. It does not extract the shipped defaults again |
| `export <quest\|chapter\|all> [id]` | Writes quest data as JSON to `exports/` |
| `import <filename\|list> [overwrite]` | `list` shows the files in `exports/`; a file name imports that file (only files inside `exports/`). With `overwrite`, quests with the same ID are replaced |

Imports follow the console rule: without `ks.core.admin.dialog.console` an import cannot add command rewards that run as the console. The real server console has every right.

### Player quests

| Subcommand | What it does |
|------------|--------------|
| `start <player> <questId>` | Starts a quest for an online player. All requirements apply |
| `claim <player> <questId>` | Claims a finished quest for a player like the **Claim** button: objectives are checked and consumed items are verified. NPC dialogs use this |
| `complete <player> <questId>` | Force-completes an active quest: every objective is set to done and the rewards are paid |
| `reset <player> <questId>` | Removes the quest from the player's active and completed lists |
| `setstreak <player> <days>` | Sets the player's quest streak (no milestone rewards are paid) |
| `resetdaily` | Runs the daily reset now for all online players |
| `resetweekly` | Runs the weekly reset now for all online players |

`<player>` is the name of an online player. For offline players use the **Players** tool of the admin window; its actions are queued until the next login.

:::warning
`complete` skips the objectives and pays the rewards. Use `claim` when the player really finished the quest.
:::

### Testing

These commands act on yourself and need you to be in game.

| Subcommand | What it does |
|------------|--------------|
| `test <questId> [player]` | Starts a quest in test mode, for you or another online player: prerequisites are skipped and every objective is set one step before its target |
| `teststart` | Starts `tutorial_welcome` for you |
| `testfirstjoin` | Runs the first-join triggers for you again, even if you already finished quests |
| `testzone <zoneName>` | Simulates entering a zone |
| `testnpc <npcId>` | Simulates talking to an NPC |
| `resetme` | Resets **all** your quest data (active and completed quests, facts, chapters, streak, first-join state). There is no undo |
| `tokens [amount]` | Gives you quest tokens (default 100). The amount must be a whole number from 1 to 1,000,000 |
| `debug` | Shows your active and completed quests, facts, chapters, streak and the number of triggers and chapters |
| `debugmode` | Toggles live tracking output for you in the server console |
| `spawnmerchant [npcType]` | Spawns an NPC at your position (default `Kweebec_Merchant`) |
| `spawntemplemerchant [npcType]` | Spawns an NPC at the fixed Forgotten Temple position (default `Kweebec_Merchant`) |

The admin window's quest editor has **Test for me** (start, nearly done, reset), which does the same for a single quest without commands.

---

## Quick reference

| Command | Usage | Permission |
|---------|-------|------------|
| Open the Questbook | `/ksquest` | `ks.quest.user.use` |
| Tracker settings | `/ksquest settings`, `/ksquestsettings` | `ks.quest.user.settings` |
| Admin window | `/qadmin panel` | `ks.quest.admin` |
| NPC profiles | `/qadmin npcprofile [citizenId]` | `ks.quest.admin` |
| Reload | `/qadmin reload` | `ks.quest.admin` |
| Start / claim / complete / reset | `/qadmin start\|claim\|complete\|reset <player> <quest>` | `ks.quest.admin` |
| Set streak | `/qadmin setstreak <player> <days>` | `ks.quest.admin` |
| Force resets | `/qadmin resetdaily`, `/qadmin resetweekly` | `ks.quest.admin` |
| Export / import | `/qadmin export <type> [id]`, `/qadmin import <file> [overwrite]` | `ks.quest.admin` (+ console node for command rewards) |
| Test mode | `/qadmin test <quest> [player]` | `ks.quest.admin` |

`/ksquestadmin browseitems` was removed in 2.0.0.