Getting Started
This guide walks you through installing Quests, the files it creates and a first test in game.
Installation
Section titled “Installation”- Put the Quests jar (
KyuubiSoftQuestBook-2.1.8.jar) and KyuubiSoft Core 2.9.9 or newer into the server’smods/folder. Quests needs Core; when you update, update Core first and remove the oldKyuubiSoftQuestBook-*.jar. - Start (or restart) the server.
- On the first start Quests creates its data folder with all default files. The log lists the loaded quests, pools, chapters and NPC profiles.
Optional: KyuubiSoft Achievements (achievement and title rewards and prerequisites), an economy plugin for economy mode, and leveling or skill plugins for XP rewards and level objectives.
Data folder
Section titled “Data folder”mods/kyuubisoft_questbook/├── config.json # Main configuration├── configs/ # Shipped content (updated with the mod, with backups)│ ├── quests.json # Daily, weekly and side quests│ ├── story_quests.json # Story quests│ ├── chapters.json # Story chapters│ ├── daily_pool.json # Daily pool│ ├── weekly_pool.json # Weekly pool│ └── quest_token_shop.json # The Quest Token Shop (a Core shop)├── custom/ # Your content (never overwritten)│ └── *.json.example # Templates├── quest_npc_profiles/ # NPC quest profiles├── localization/ # Language files (9 languages)├── backups/ # Backup sets of the admin window├── exports/ # Exports and import files├── players/ # Player data (file storage)└── server_stats.json # Server statistics:::info Base + Custom
Files in configs/ are shipped content. A newer version of the mod may replace them (the old file is kept as a backup). Your own content goes into custom/, which is never overwritten. The admin window writes your changes there for you. See Custom Content.
:::
Player data is stored as files, or in MySQL when KyuubiSoft Core is set up for MySQL.
Basic configuration
Section titled “Basic configuration”The most important settings, in config.json or in the General settings tab of the admin window:
| Field | Default | What it does |
|---|---|---|
timezone | Europe/Berlin | Time zone for the resets |
dailyResetTime | 04:00 | Time of the daily reset |
weeklyResetDay | MONDAY | Day of the weekly reset |
dailyQuestCount | 3 | Daily quests per player |
weeklyQuestCount | 5 | Weekly quests per player |
After editing the file by hand, run /ksquestadmin reload. Changes in the admin window apply at once. See Configuration for every option.
Permissions
Section titled “Permissions”Players can open the Questbook out of the box (ks.quest.user.use and ks.quest.user.settings are granted by default). Give your staff ks.quest.admin. Only people who may also edit console commands need ks.core.admin.dialog.console. See Permissions.
Your first test
Section titled “Your first test”- Open the Questbook with
/ksquest. You should see three daily quests, five weekly quests and the first story quest, which starts on its own for new players. - Pick a quest in the list. The detail panel shows its objectives, rewards and buttons.
- Track it with Track. It appears on the quest tracker HUD.
- Do the objectives — mine, craft, fight or explore. Progress updates in real time.
- Claim the reward with Claim reward, or at the quest giver NPC when the quest is turned in there.
Then open the admin window with /ksquestadmin panel and look around: every quest, chapter, pool, NPC profile and setting is there.
:::tip Quick commands
/ksquest— open the Questbook/ksquest settingsor/ksquestsettings— tracker settings/kssettings— the shared KS settings window, with a Quests page/ksquestadmin panel— the admin window :::
Verifying the installation
Section titled “Verifying the installation”Run /ksquestadmin debug to see your quest state: active and completed quests, facts, chapter progress, streak, and how many triggers and chapters are registered. If something does not load, the server console names the file and the problem.
Next steps
Section titled “Next steps”- Configuration — every option
- Admin Window — editing in game
- Quest Types — daily, weekly, story and side quests
- Commands — every command