Getting Started

Quick setup for SoapsQuest on Paper 26.2 or Spigot 26.2 (Java 21+; Folia not supported).

---

1. Install

1. Install SoapsCommon on your server.
2. Place SoapsQuest-1.0.5-Free.jar or SoapsQuest-1.0.5-Premium.jar in plugins/.
3. Restart the server (not /reload for first install).
4. Confirm the console shows SoapsQuest enabled and SoapsCommon loaded.

---

2. First reload

SoapsQuest creates default configs in plugins/SoapsQuest/ on first run.

/sq reload

If quests.yml has syntax errors, reload aborts and keeps the previous config. Fix the reported lines and reload again.

---

3. Give a test quest

/sq give YourName lumberjack

Open your inventory. You should see a quest paper with lore showing the objective.

Break oak logs to progress. Right-click the paper when complete to claim rewards.

---

4. Open the browser

/sq browse

Players with soapsquest.gui.browser can pick up quests from the browser GUI instead of staff /sq give.

---

5. Next steps

• Edit or add quests in Creating Quests or /sq editor (Premium).
• Tune Default Configs (progress display, anti-cheat, timer HUD).
• Link a Citizens NPC: /sq npc link <npc> lumberjack.
• Premium: enable the Random Quest Generator or Contract Request.

---

Permissions for players

Most servers grant these to everyone by default:

• soapsquest.use
• soapsquest.gui.browser
• soapsquest.gui.myquests
• soapsquest.list and soapsquest.list.click
• soapsquest.progress
• soapsquest.statistic

See Commands and Permissions for the full list.

---

Version 1.0.5