Getting Started

Questborn loads quest types and quests from YAML files. You can create quest pools (daily/weekly), set objectives, chain them together, configure rewards, and trigger optional effects—all without writ

---

Compatibility

Questborn is built for Paper 1.16+ and is also fully functional on other Paper-based forks (like Purpur and similar optimized forks).

---

1. Install and first launch

1. Download Questborn.jar and place it into your server's plugins/ folder.

2. Start the server once to generate the default configurations.

3. Open plugins/Questborn (the plugin generates folders, types, default quests, and configs after the first run).

2. How it works

• Quest Type defines a menu category (e.g., Daily Quests or Weekly Challenges), its icon, slot, engine mode (DEFAULT, CHAIN, or ROTATION), refresh period, and the folder where its quests are loaded from.

• Quest is a single file representing a task with a name, description, visual rewards, actual rewards, objective(s) or required items, and optional quest effects.

3. File structure

You will mostly work with these folders and files:

• /types/ contains quest type configurations (e.g., daily.yml, weekly.yml).

• /quests/ contains the actual quests, categorized into type folders (e.g., quests/daily/, quests/weekly/).

• quest-effects.yml contains effect presets (commands, titles, particles, potion effects) that quests can reference upon activation, stage changes, or completion.

• config.yml and /language/ contain core plugin settings and translation files.

4. Create a quest type

1. Create a type file inside types/ (for example daily.yml).

2. Set folder to the path where this type should load quests from (for example quests/daily).

3. Configure display-name, lore, material, slot, engine (DEFAULT, CHAIN, or ROTATION).

4. (Optional) Setup cooldown for default quests or reset-period / rotation-slots for the ROTATION engine.

5. Create your first quest

1. Create a quest file inside the folder you set in your type (for example quests/daily/my_quest.yml).

2. Structure the quest using multiple stages or a single stage path.

3. Define the requirements (objective like breaking 16 stones, or required-materials).

4. Set the rewards section to give money, XP, items, or attributes.

5. If using the ROTATION engine, ensure your quest includes a rotation-pool identifier.

6. Reload and test

1. Run /quest reload in-game or via console after editing any files.

2. Open the main menu with /quest.

3. (Optional) For quick testing, admins can activate or complete quests manually via proxy commands if necessary.

7. Common dependencies

• Money rewards usually require Vault and an economy plugin (like EssentialsX).

• Support for physical indicators may use features from armor stands or interaction entities.

Note: The documentation may contain errors or be outdated! If you find an issue, report it on Discord: woody7574