FAQ
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?
Section titled “How do I create an NPC with a quest?”Follow the complete Quest + NPC Workflow guide. In short:
- Create a quest in
mods/kyuubisoft_questbook/custom/custom_quests.json(or in the Quests admin window) - Create a citizen in
mods/kyuubisoft_core/custom/custom_citizens.json(or with/kscitizen create <id>and the NPC management window) - Create an NPC quest profile in
mods/kyuubisoft_questbook/quest_npc_profiles/ - Add localization entries
- Reload with
/ksadmin reload
Where are the config files located?
Section titled “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 guide for full details.
How do I add translations?
Section titled “How do I add translations?”See the Localization Guide. The short version:
- Create
custom_en-US.json(and optionallycustom_de-DE.json) in the mod’slocalization/folder. - Add your keys following the naming conventions (e.g.
quest.<id>.name,achievements.name.<id>). - Reload with
/ksadmin reload.
Custom localization files are never overwritten by updates.
How do I use the Mod Editor?
Section titled “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 guide for a walkthrough.
My NPC does not spawn
Section titled “My NPC does not spawn”Check these common causes:
- citizens.json is invalid — Validate your JSON syntax (missing commas, brackets).
- Wrong
worldName— Make sure theworldNamefield matches your actual world name exactly. - Wrong position — Verify the coordinates.
/kscitizen info <id>shows the saved world and position,/kscitizen tp <id>takes you there. - 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. - NPC file locked — If Core could not read an NPC file, it keeps the file untouched and shows it as locked in the
/ksadminStatus tab. Fix the file, then run/kscitizen reload. - Config not reloaded — Run
/ksadmin reloadafter any config change. - Force respawn — Run
/kscitizen respawnallto respawn all NPCs, or/kscitizen respawn <id>for one.
My quest does not start
Section titled “My quest does not start”Check these common causes:
- Prerequisites not met — If your quest has a
prerequisitesfield, make sure those quests are completed first. - Trigger not configured — If the quest uses a trigger (e.g. NPC interaction), verify the NPC quest profile links the correct quest ID.
- Quest not in a pool — Daily and weekly quests must be listed in the corresponding pool config (
mods/kyuubisoft_questbook/configs/daily_pool.jsonorweekly_pool.json). - Quest is disabled — Check that the quest ID is not in
disabled_base_ids. - Use debug mode — Run
/ksquestadmin debugmodeto print live tracking output to the server console, or/ksquestadmin debugfor your own quest state.
How do I test quests ingame?
Section titled “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 diskSee the Ingame Commands guide for a full admin testing workflow.
What is the difference between base and custom configs?
Section titled “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 guide for details.
How do I create a quest pack?
Section titled “How do I create a quest pack?”Quest packs are shareable bundles containing quests, NPC profiles, citizens, and localization. You can create them with:
- Mod Editor — Use the Pack Wizard at modeditor.kyuubisoft.com to visually assemble a pack.
- Manual — Organize your custom files into a ZIP following the standard folder structure.
See the Mod Editor Workflow guide for the visual approach.
What commands are available?
Section titled “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 (needsks.admin);/ksadmin reloadreloads all configs/ksquestadmin— Quest admin tools
See the full Ingame Commands reference for all commands, aliases, and permissions.
How do I change the language?
Section titled “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 againThe 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.