Installation

Requirements

• Java 21 or higher
• Paper 1.21 or compatible fork (Purpur, etc.)
• Maven (only needed if building from source)

Steps

1. Download the latest SpContentQuests.jar from the Releases page.

2. Place the JAR file into your server's plugins/ folder.

3. Restart your server (or use a reload manager like PlugManX — though a restart is recommended).

4. Configure the plugin:

   • Edit plugins/SpContentQuests/config.yml for general settings, database, and messages
   • Add category files in plugins/SpContentQuests/category/
   • Add quest files in plugins/SpContentQuests/quests/

5. Give yourself the quest book:

   /questbook
   

   Or open any category directly:

   /spcontentquests open introduction
   

First-Time Setup

When you first run the plugin, it will generate default files:

• config.yml — Main configuration
• gui-objective.yml — Objective GUI settings
• category/introduction.yml — Example category
• category/overworld.yml — Example category
• quests/example-quests.yml — Example quests

You can edit, delete, or add new files at any time. After making changes, run:

/spcontentquests reload

Tip: Start by editing the example files to understand the structure before creating your own.

Building from Source

If you want to build the plugin yourself:

git clone https://github.com/DetraisMC/SpContentQuests.git
cd SpContentQuests
mvn clean package

The compiled JAR will be in the target/ directory.