Skip to main content

Getting Started

This guide walks you through installing the Quest System, understanding the folder structure and running your first quest in-game.

Installation​

  1. Download the latest kyuubisoft_questbook.jar from the releases page.
  2. Place the JAR file in your Hytale server's mods/ folder.
  3. Start (or restart) your server.

On first start the plugin automatically creates its data folder with all default configuration files. You will see log output confirming the loaded quests, pools and chapters.

tip

The Quest System depends on the KyuubiSoft Core mod. Make sure kyuubisoft_core.jar is also in your mods/ folder before starting.

Folder Structure​

After the first start, the following folder structure is generated inside your server's data directory:

configs/kyuubisoft_questbook/
├── config.json                # Main configuration (reset times, economy, streaks, etc.)
├── configs/                   # Base content files (auto-updated on plugin updates)
│   ├── quests.json            # Daily, weekly and side quest definitions
│   ├── story_quests.json      # Story quest definitions
│   ├── chapters.json          # Story chapter ordering
│   ├── daily_pool.json        # Daily quest rotation pool
│   ├── weekly_pool.json       # Weekly quest rotation pool
│   ├── triggers.json          # Automatic quest triggers
│   └── quest_token_shop.json  # Token shop inventory
├── custom/                    # Your custom content (never overwritten on updates)
│   ├── custom_quests.json.example
│   ├── custom_story_quests.json.example
│   └── custom_chapters.json.example
├── localization/              # Translation files
│   ├── en-US.json
│   └── de-DE.json
└── players/                   # Per-player progress data (auto-managed)
Base + Custom System

Files inside configs/ are base content managed by the plugin. They may be updated when you install a new plugin version (a backup is created automatically). Your own additions go into the custom/ folder, which is never overwritten. See the Configuration page for details.

Basic Configuration​

Open config.json in the root of the quest data folder. The most important settings for a first setup are:

{
  "language": "en-US",
  "timezone": "Europe/Berlin",
  "dailyResetTime": "04:00",
  "weeklyResetDay": "MONDAY",
  "dailyQuestCount": 3,
  "weeklyQuestCount": 5,
  "debug": false
}
FieldWhat it does
languageUI language (en-US or de-DE)
timezoneTimezone for daily/weekly reset calculations
dailyResetTimeTime of day when daily quests rotate (24h format)
weeklyResetDayDay of the week when weekly quests rotate
dailyQuestCountHow many daily quests each player receives
weeklyQuestCountHow many weekly quests each player receives
debugEnable verbose logging to the server console

After editing, reload in-game with /ksquestadmin reload.

Your First Quest Test​

Once the server is running with the Quest System installed:

  1. Open the Quest Book -- Type /ksquest in chat. This opens the full quest book UI.
  2. Check your quests -- You should see daily quests, weekly quests and the first story quest ("Awakening") which auto-starts for new players.
  3. Track a quest -- Click the pin/track icon on any quest to display it on your HUD tracker.
  4. Complete objectives -- Go out and mine, craft, fight or explore as the quest requires. Progress updates in real time on the HUD.
  5. Claim rewards -- Once all objectives are done, the quest auto-completes (for daily/weekly) or can be turned in via the quest book.
Quick Commands
  • /ksquest -- Open the quest book
  • /ksquest settings -- Open your personal quest tracker settings
  • /ksquestsettings -- Same as above, direct shortcut

Verifying the Installation​

Run /ksquestadmin debug to see detailed information about your quest state:

  • Active quests and their progress
  • Completed quests
  • Story facts and chapter progress
  • Current streak status
  • Registered triggers and chapters

If you see "No player data found", your plugin may not be loading correctly. Check the server console for error messages.

Permissions

Admin commands like /ksquestadmin require the questbook.admin permission. Make sure your admin users have this permission configured in your server's permission system.

Next Steps​