# FAQ

# Frequently Asked Questions

Quick answers to the most common questions about KyuubiSoft Hytale mods. Click the links for detailed guides.

---

## How do I create an NPC with a quest?

Follow the complete [Quest + NPC Workflow](https://wiki.kyuubisoft.com/hytale/guides/quest-npc-workflow/) guide. In short:

1. Create a quest in `mods/kyuubisoft_questbook/custom/custom_quests.json` (or in the Quests admin window)
2. Create a citizen in `mods/kyuubisoft_core/custom/custom_citizens.json` (or with `/kscitizen create <id>` and the NPC management window)
3. Create an NPC quest profile in `mods/kyuubisoft_questbook/quest_npc_profiles/`
4. Add localization entries
5. Reload with `/ksadmin reload`

---

## Where are the config files located?

Every mod has its own data folder inside the server's `mods/` folder (next to the mod JARs):

| Mod | Folder | Content |
|-----|--------|---------|
| Core | `mods/kyuubisoft_core/` | Citizens, Dialogs, NPC Shops, Lootbags, Dev Tools |
| Achievements | `mods/kyuubisoft_achievements/` | Achievements, Titles, Lootbags |
| Quest Book | `mods/kyuubisoft_questbook/` | Quests, Chapters, Pools, NPC Profiles |
| Info Hub | `mods/kyuubisoft_infohub/` | Info Hub pages |
| Season Pass | `mods/kyuubisoft_seasonpass/` | Season Pass tiers and rewards |
| ChatPlus | `mods/kyuubisoft_chatplus/` | Chat channels, mail settings |
| Weapon Mastery | `mods/kyuubisoft_weapon-mastery/` | Weapon mastery settings |
| All KS mods | `mods/kslang/` | Shared language choices (`prefs.json`) |

See the [Config Structure](https://wiki.kyuubisoft.com/hytale/guides/config-structure/) guide for full details.

---

## How do I add translations?

See the [Localization Guide](https://wiki.kyuubisoft.com/hytale/guides/localization-guide/). The short version:

1. Create `custom_en-US.json` (and optionally `custom_de-DE.json`) in the mod's `localization/` folder.
2. Add your keys following the naming conventions (e.g. `quest.<id>.name`, `achievements.name.<id>`).
3. Reload with `/ksadmin reload`.

Custom localization files are never overwritten by updates.

---

## How do I use the Mod Editor?

The Mod Editor is a visual web-based tool at **modeditor.kyuubisoft.com**. You can create quests, assign NPCs, manage translations, and export everything as a ZIP or quest pack. See the [Mod Editor Workflow](https://wiki.kyuubisoft.com/hytale/guides/mod-editor-workflow/) guide for a walkthrough.

---

## My NPC does not spawn

Check these common causes:

1. **citizens.json is invalid** — Validate your JSON syntax (missing commas, brackets).
2. **Wrong `worldName`** — Make sure the `worldName` field matches your actual world name exactly.
3. **Wrong position** — Verify the coordinates. `/kscitizen info <id>` shows the saved world and position, `/kscitizen tp <id>` takes you there.
4. **Citizen is disabled or hidden** — Check that the citizen ID is not listed in `disabled_base_ids`, and that it is not hidden in the NPC management window.
5. **NPC file locked** — If Core could not read an NPC file, it keeps the file untouched and shows it as locked in the `/ksadmin` Status tab. Fix the file, then run `/kscitizen reload`.
6. **Config not reloaded** — Run `/ksadmin reload` after any config change.
7. **Force respawn** — Run `/kscitizen respawnall` to respawn all NPCs, or `/kscitizen respawn <id>` for one.

---

## My quest does not start

Check these common causes:

1. **Prerequisites not met** — If your quest has a `prerequisites` field, make sure those quests are completed first.
2. **Trigger not configured** — If the quest uses a trigger (e.g. NPC interaction), verify the NPC quest profile links the correct quest ID.
3. **Quest not in a pool** — Daily and weekly quests must be listed in the corresponding pool config (`mods/kyuubisoft_questbook/configs/daily_pool.json` or `weekly_pool.json`).
4. **Quest is disabled** — Check that the quest ID is not in `disabled_base_ids`.
5. **Use debug mode** — Run `/ksquestadmin debugmode` to print live tracking output to the server console, or `/ksquestadmin debug` for your own quest state.

---

## How do I test quests ingame?

Use the quest admin commands:

```
/ksquestadmin debugmode          — Toggle live tracking output in the server console
/ksquestadmin start <player> <questId>    — Force-start a quest
/ksquestadmin complete <player> <questId> — Force-complete a quest
/ksquestadmin reset <player> <questId>    — Reset a quest for re-testing
/ksadmin reload                  — Reload all configs from disk
```

See the [Ingame Commands](https://wiki.kyuubisoft.com/hytale/guides/ingame-commands/) guide for a full admin testing workflow.

---

## What is the difference between base and custom configs?

KyuubiSoft mods use a **file-first pattern**:

- **Base configs** (in the mod's data folder and its `configs/` subfolder) — These are the default configs shipped with the mod. They **may be replaced** when the mod updates (a backup is kept).
- **Custom configs** (in the `custom/` subfolders) — These are your personal additions. They are **never overwritten** by updates.

Always put your custom content in the `custom/` folders. See the [Config Structure](https://wiki.kyuubisoft.com/hytale/guides/config-structure/) guide for details.

---

## How do I create a quest pack?

Quest packs are shareable bundles containing quests, NPC profiles, citizens, and localization. You can create them with:

1. **Mod Editor** — Use the Pack Wizard at modeditor.kyuubisoft.com to visually assemble a pack.
2. **Manual** — Organize your custom files into a ZIP following the standard folder structure.

See the [Mod Editor Workflow](https://wiki.kyuubisoft.com/hytale/guides/mod-editor-workflow/) guide for the visual approach.

---

## What commands are available?

There are commands for every KyuubiSoft mod. The most important ones:

- `/ksquest` — Open the quest book
- `/ksachievements` — Open the achievement book
- `/kstitles` — Open the titles tab of the achievement book
- `/kssettings` — Language, HUD and notification settings for all KS mods
- `/ksadmin` — The KyuubiSoft management hub (needs `ks.admin`); `/ksadmin reload` reloads all configs
- `/ksquestadmin` — Quest admin tools

See the full [Ingame Commands](https://wiki.kyuubisoft.com/hytale/guides/ingame-commands/) reference for all commands, aliases, and permissions.

---

## How do I change the language?

Players can set their preferred language with `/kssettings` (Language page) or with:

```
/kslang en-US    — English
/kslang de-DE    — German
/kslang auto     — Follow the game language again
```

The choice is one setting for **all** KS mods and persists across sessions. All UI text, quest descriptions and achievement names display in the selected language (if translations are available). Admins set a default language for players, or lock the language for everyone, in the **Language** tab of `/ksadmin`. See the [Localization Guide](https://wiki.kyuubisoft.com/hytale/guides/localization-guide/).