Getting Started

Install SoapsQuest 1.0.7 (Free or Premium) and confirm it loads.

Requirements

Requirement	Details
Plugins (depend)	SoapsCommon
Server	Paper / Spigot 26.1, 26.2, 26.3 · Folia not supported
Java	21+ (Java 25 recommended)

Downloads are ZIPs. Extract the Free or Premium .jar into plugins/.

Free or Premium?

You need	Install
Papers, YAML quests, browser, objectives	Free jar
Generator, contracts, dailies, loot, in-game editor	Premium jar

Do not run both jars. Upgrading Free → Premium keeps your configs and adds missing Premium defaults. Matrix: Introduction.

Installation

1. Download SoapsCommon and the SoapsQuest Free or Premium ZIP; extract both jars.
2. Put jars in plugins/ and fully restart (not /reload).
3. Confirm SoapsQuest is green and plugins/SoapsQuest/ exists.
4. Optional soft deps (Vault, Citizens, MythicMobs, …): Integrations.

Symptom	Fix
Red plugin, no data folder	JAR still inside a ZIP, or SoapsCommon missing
Premium commands missing	You installed the Free jar

First-run files

Both editions

plugins/SoapsQuest/
  config.yml
  quests.yml
  messages.yml
  gui.yml
  tiers.yml
  difficulties.yml
  sigils.yml          # balances (auto-managed)
  data/players/       # optional shards

Premium also creates

  daily.yml
  random-generator.yml
  contract-request.yml
  quest-loot.yml
  generated.yml       # generator output (auto-managed)

Full defaults: Config Reference

Admin path

1. YAML — write quests in quests.yml (both editions)
2. /sq browse / /sq give — hand out papers
3. Premium — /sq editor, /sq generate, /sq contract, dailies, loot
4. /sq reload — after YAML edits

Reload policy

Change	What to run
Most GUI / paper play	Runtime
YAML file edits	/sq reload
Free ↔ Premium jar swap	Full server restart
Jar upgrade / first install	Full server restart (not /reload)

Verify

Check	Passes when
Enable	SoapsQuest green; folder exists
Commands	/sq help, /sq browse work
Loop	/sq give <you> <quest> → progress on lore → right-click claim
Premium	/sq generate or /sq editor work only on Premium
Empty	Browser with no claimable quests feels empty, not broken

/sq help
/sq browse
/sq list

Common goals

Goal	Page
Give a paper	Want give a quest
Write a quest	Want write a quest
Generate (Premium)	Want generate quests
Contracts (Premium)	Want contracts
Dailies (Premium)	Want dailies

Next: Creating Quests · Upgrading to 1.0.7