Getting Started

Getting Started

The Mod Editor is a browser-based visual tool built with SvelteKit. It runs entirely in your browser — no data is ever uploaded to a server. You can use it online or run it locally.

Accessing the Editor

Online (Recommended)

Open the Mod Editor directly in your browser:

modeditor.kyuubisoft.com

No installation required. Works in all modern browsers.

Local Setup

If you prefer to run the editor locally (e.g. for offline use), you need Node.js 18+ and pnpm:

cd tools/mod-editor
pnpm install
pnpm dev

The editor will start at http://localhost:5173. Open this URL in your browser.

:::tip Available Scripts

Command	Description
pnpm dev	Start local dev server
pnpm build	Build for production
pnpm preview	Preview production build
:::

Browser Requirements

The editor works in all modern browsers (Chrome, Firefox, Edge, Safari).

Some features have browser-specific notes:

Feature	Chrome/Edge	Firefox/Safari
Drag & drop files	Full support	Full support
Drag & drop folders	Full support	Full support
”Select Mods Folder” button	Full support	Not available

:::info Folder Selection The “Select Mods Folder” button uses the File System Access API, which is currently only available in Chromium-based browsers (Chrome, Edge). In Firefox and Safari, use drag & drop or the “Individual Files” button instead. :::

First Launch

When you first open the editor, two things happen automatically:

1. Reference data loads — The editor loads its built-in database of valid item IDs, entity IDs, and block IDs. These power the autocomplete and validation features.
2. Base configs load — The default server quest data is pre-loaded so you can browse existing content immediately.

You will see the onboarding screen with a summary of loaded base data (quests, story quests, chapters, NPCs, achievements, citizens) and a drop zone to import your own files.

UI Layout

The editor uses a two-panel layout:

Sidebar (Left)

The sidebar contains navigation links to all editor pages, plus action buttons at the bottom:

Section	What it does
Quests	Side, story, and daily quest editor
NPCs	NPC profiles and dialog trees
Chapters	Story chapter ordering
Pools	Daily and weekly quest rotation
Shop	Token shop items and prices
Achievements	Achievement triggers and rewards
Citizens	NPC spawn data and roles
Lootbags	Loot tables and drop pools
Localization	EN/DE translation keys side-by-side
Packs	Self-contained quest packs
Quest Setup	Guided step-by-step quest creation wizard

Each navigation entry shows a count badge with the number of loaded items.

At the bottom of the sidebar you will find:

• Validation indicator — Shows the number of errors (if any). Click to view details.
• Preview Export — Opens a diff view showing what changed.
• Export ZIP — Downloads a ZIP file containing only your custom/changed files.
• Back to Wiki — Returns to the main wiki.

Main Content (Right)

The main area changes based on which page you selected in the sidebar. Most pages follow the same pattern: a list panel on the left for browsing and filtering, and an editor panel on the right for editing the selected item.

Auto-Save

The editor automatically saves your work to the browser’s IndexedDB storage. When you reopen the editor, your previous session is restored automatically. No manual saving required.

Caution

Auto-save is per-browser. If you switch browsers or clear your browser data, your session is lost. Use Export ZIP to save your work as a file.

Keyboard Shortcuts

Shortcut	Action
Ctrl+Z	Undo
Ctrl+Y or Ctrl+Shift+Z	Redo

Next Steps

• Importing Data — Load your server configs into the editor
• Quest Editing — Create and edit quests
• Objectives & Rewards — Configure quest objectives and rewards
• Tier Generator — Create difficulty variants