Skip to main content

Mod Editor Workflow

The KyuubiSoft Mod Editor is a visual web-based tool for creating and managing quests, NPCs, shops, achievements, and more — without editing JSON by hand.

What is the Mod Editor?​

The Mod Editor is available at modeditor.kyuubisoft.com. It provides:

  • A visual quest builder with drag-and-drop objectives
  • An NPC/citizen configurator
  • Shop editor with item search
  • Localization manager for all languages
  • Built-in validation for common errors
  • Export as ZIP or shareable quest pack

No installation required — it runs entirely in your browser.

Import Data​

To work with your existing server content:

  1. Open the Mod Editor in your browser.
  2. Click Import in the top menu.
  3. Select your server's configs/ folder (or upload a ZIP of it).
  4. The editor loads all quests, citizens, shops, achievements, and localization.

You can now browse and edit everything visually.

tip

You can also start from scratch without importing. The editor will create all necessary files for you.

Edit Quests​

The quest editor lets you:

  1. Create a new quest — Click "New Quest" and fill in the basic info (ID, type, category, icon).
  2. Add objectives — Drag objective types from the palette (collect, kill, talk, visit, craft) and configure their targets and amounts.
  3. Set rewards — Add item rewards, XP rewards, or quest tokens.
  4. Configure prerequisites — Link quests that must be completed first.
  5. Preview — See how the quest will appear in the quest book.

The editor automatically generates the correct JSON structure and localization keys.

Assign NPCs​

To link a citizen to a quest:

  1. Go to the Citizens tab.
  2. Create or select a citizen.
  3. Open the Quest Profile section.
  4. Assign quests and write dialog for each phase (offer, active, complete).
  5. The editor generates the NPC quest profile JSON automatically.

You can also set the NPC's position by entering coordinates or using the coordinate helper.

Edit Localization​

The Localization tab shows all translation keys side by side:

  • View English and German translations in columns.
  • Missing translations are highlighted in red.
  • Click any cell to edit the translation directly.
  • Add new languages as needed.

The editor ensures all required keys exist for every quest, achievement, and NPC.

Validation​

Before exporting, run the built-in Validate check:

  • Missing localization keys
  • Invalid quest references (e.g. prerequisites pointing to non-existent quests)
  • Citizen IDs that do not match quest profiles
  • Duplicate IDs across base and custom content
  • Invalid item IDs in rewards

Fix any errors before exporting to avoid ingame issues.

Export​

When your content is ready:

  1. Click Export in the top menu.
  2. Choose ZIP for a standard export or Quest Pack for a shareable bundle.
  3. Download the file.

The ZIP contains the complete custom/ and localization/ file structure, ready to upload.

Upload to Server​

To deploy your exported content:

  1. Stop the server (recommended for large changes) or prepare to reload.
  2. Unzip the exported file into your server's configs/ folder. The folder structure inside the ZIP matches the server's layout, so files land in the correct locations.
  3. Start the server, or if it is already running:
/ksadmin reload
/kscitizen respawn

Your new content is now live.

Quest Packs​

Quest packs are shareable bundles that contain everything needed for a set of quests:

  • Quest definitions
  • NPC profiles
  • Citizen configs
  • Localization for all languages
  • A manifest describing the pack

Creating a Pack​

  1. In the Mod Editor, click Pack Wizard in the export menu.
  2. Select which quests and citizens to include.
  3. Add pack metadata (name, description, author, version).
  4. Export as .questpack file.

Installing a Pack​

  1. Open the Mod Editor.
  2. Click Import Pack.
  3. Select the .questpack file.
  4. Review the contents and click Install.
  5. Export and upload to your server as usual.

Packs make it easy to share quest content with other server operators or distribute content updates.

Tips​

  • Save often — The editor auto-saves to your browser, but you can also manually export at any time.
  • Use validation — Always run validation before exporting. It catches issues that are hard to spot in JSON.
  • Version your exports — Keep a copy of each exported ZIP with a date or version number, so you can roll back if needed.
  • Combine with manual editing — The editor and manual JSON editing are fully compatible. You can import, edit in the tool, export, and then fine-tune JSON by hand.