Getting Started

Questborn loads quest types and quests from YAML files. You create quest pools (daily/weekly), set objectives, rewards, and optional effects without writing code.

Compatibility Questborn is built for Paper 1.21 and also works on other Paper-based forks (for example Purpur and similar forks).

  1. Install and first launch Put Questborn.jar into the plugins folder Start the server once Open plugins/Questborn (the plugin generates folders and configs after the first run)

  2. How it works Quest Type defines a menu category (for example Daily Quests), its icon, slot, cooldown, and the folder where quests are loaded from Quest is a single quest file with a name, description, reward text, real rewards, and one objective

  3. File structure You will mostly work with these folders and files types contains quest type files (daily.yml, weekly.yml, etc.) quests contains quests stored inside type folders (quests/daily, quests/weekly, etc.) quest-effects.yml contains effect presets that quests can reference

  4. Create a quest type Create a type file inside types (for example daily.yml) Set folder to the path where this type should load quests from (for example quests/daily) Configure display-name, lore, material, slot, cooldown-seconds, engine (usually default), enabled

  5. Create your first quest Create a quest file inside the folder you set in the type (for example quests/daily) Fill in id, name, description (up to 3 short lines), rewards-description (GUI text only), objective (type, amount, targets), rewards (real rewards), quest-effects (optional)

  6. Reload and test Run /quest reload after editing files Open the menu with /quest For quick testing, activate a quest by id if your build includes an activation command

  7. Common dependencies Money rewards usually require Vault and an economy plugin Region-based objectives may require WorldGuard

The documentation may contain errors! If you find an error, report it on Discord: woody7574

Last updated