Skip to main content

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 guide. In short:

  1. Create a quest in configs/kyuubisoft_questbook/custom/custom_quests.json
  2. Create a citizen in configs/kyuubisoft_core/custom/custom_citizens.json
  3. Create an NPC quest profile in configs/kyuubisoft_questbook/quest_npc_profiles/
  4. Add localization entries
  5. Reload with /ksadmin reload

Where are the config files located?​

All config files are in your server's configs/ folder, organized by mod:

ModFolderContent
Coreconfigs/kyuubisoft_core/Citizens, Shops, Tracking, Dev Tools
Achievementsconfigs/kyuubisoft_achievements/Achievements, Titles, Lootbags
Quest Bookconfigs/kyuubisoft_questbook/Quests, Chapters, Pools, NPC Profiles
Info Hubconfigs/kyuubisoft_infohub/Info Hub sections
Season Passconfigs/kyuubisoft_seasonpass/Season Pass tiers and rewards
ChatPlusconfigs/kyuubisoft_chatplus/Chat channels, mail settings
Weapon Masteryconfigs/kyuubisoft_weapon-mastery/Weapon mastery settings

See the Config Structure guide for full details.

How do I add translations?​

See the 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.name.<id>, achievement.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 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 coordinates. Use /ksdev pos ingame to get your current position.
  4. Citizen is disabled — Check that the citizen ID is not listed in disabled_base_ids.
  5. Config not reloaded — Run /ksadmin reload after any config change.
  6. Force respawn — Run /kscitizen respawn to force all NPCs to respawn.

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 (configs/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 see live quest state information.

How do I test quests ingame?​

Use the quest admin commands:

/ksquestadmin debugmode          — Toggle live debug overlay
/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 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 configs/ root folders) — These are the default configs shipped with the mod. They may be overwritten when the mod updates.
  • 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?​

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 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 gallery
  • /kstitles — Open title selection
  • /ksadmin reload — Reload all configs
  • /ksquestadmin — Quest admin tools

See the full Ingame Commands reference for all commands, aliases, and permissions.

How do I change the language?​

Players can set their preferred language with:

/kslang en-US    — English
/kslang de-DE    — German

The language setting is stored per player and persists across sessions. All UI text, quest descriptions, and achievement names will display in the selected language (if translations are available).