Skip to main content

Quest System

kyuubisoft

A full-featured quest book plugin for Hytale servers, featuring 213 quests across story, side, daily, and weekly categories with NPC integration, an in-game admin panel, and cross-mod API support.

Features​

213 Quests​

  • 31 Story Quests across 6 chapters with branching NPC dialogs and sequential progression
  • 14 Side Quests with unique objectives and standalone rewards
  • 120 Daily Quests from 10 weighted random pools in 4 tiers (Common, Uncommon, Rare, Legendary)
  • 48 Weekly Quests across 3 categories in 4 tiers with higher token payouts
Daily/Weekly Pools

Quests are drawn from weighted random pools. Higher tiers give better rewards but appear less frequently. Players can reroll quests using quest tokens or gold.

NPC Quest Profiles​

  • 17 NPC profiles with priority-based quest selection
  • NPCs offer, track, and accept quest turn-ins with unique dialog per quest phase
  • Quest chains via requires field for sequential progression
  • Multi-NPC phases: start a quest at one NPC, turn in at another
  • World map markers auto-update based on quest status (available, in-progress, turn-in)
  • Proximity whisper messages when players approach quest NPCs

Quest Book UI​

  • 5 quest slots per page with pagination
  • Per-objective status display (completed, in-progress, locked)
  • Tracking toggle, accept, drop, claim, and reroll buttons
  • Turn-in location with NPC name and coordinates
  • Settings page for player preferences
  • Quest Token Shop access directly from the book

Quest Token Shop​

  • 17 items across 5 categories purchasable with quest tokens
  • Extensible via custom/custom_quest_token_shop.json
  • Supports economy mode for external currency integration

Admin Panel​

A full in-game admin interface with 8 tabs:

TabDescription
GeneralCore plugin settings and toggles
SystemsTracking and objective configuration
PlayerPer-player quest data inspection and management
EconomyToken/gold settings, exchange rates, reroll costs
ContentCRUD editors for quests with search and filter
ChaptersStory chapter management and ordering
ShopToken shop item configuration
StatsServer-wide and per-player statistics

Economy Mode​

  • Configure rewardCurrency = "economy" to use external currency (e.g. Gold) instead of quest tokens
  • Automatic conversion via tokenExchangeRate
  • Gold-based rerolls as alternative to token rerolls
  • Dynamic UI adapts labels and icons to the active currency

MySQL Support​

  • Optional MySQL backend for cross-server player data (ks_quest_players table)
  • Automatic migration from legacy file-based storage on first load
  • Falls back to file-based storage if MySQL is unavailable

QuestAPI​

Cross-mod integration API for other plugins:

  • Event Listeners: onQuestStarted, onQuestCompleted, onQuestAbandoned
  • Query Methods: getAllQuestIds, getQuestsByType
  • Facts API: getPlayerFact, setPlayerFact, checkFactConditions

HUD Tracker​

  • Tracks up to 5 objectives per active quest
  • Turn-in indicator shows NPC name or "Open Quest Book" when objectives are complete
  • Proximity toasts with NPC skin icons and compass direction
  • MHUD-compatible with configurable position

Toast Notifications​

  • On-screen popups for quest start, ready, complete, and chapter complete
  • Login notifications for pending quests and undelivered rewards
  • Proximity toasts when approaching quest NPCs

Localization​

  • Full i18n support for English (en-US) and German (de-DE)
  • Per-player language selection via /kslang
  • 300+ localization keys covering all UI, dialogs, and notifications

Commands​

CommandAliasDescription
/ksquest—Open the Quest Book
/ksquestadminqadminAdmin panel and management commands
/ksquestsettings—Player quest settings
Custom Content

Place additional quest files in the custom/ folder. They are auto-loaded and merged with base content. Use disabled_base_ids to deactivate specific base quests.

Requirements​

  • Hytale Server with plugin support
  • KyuubiSoft Core (recommended, for TrackingService, Shop, and economy integration)
  • MySQL (optional, for cross-server data)

Configuration​

All configuration files are located in the plugin's data folder:

  • config.json — Main plugin settings (economy, reroll costs, tracking)
  • quests/ — Base quest definitions (213 files)
  • custom/ — Custom quest overrides and additions
  • npc_profiles/ — NPC quest profile definitions
  • quest_token_shop.json — Token shop items