SoapsUniverse
SoapsQuest
SoapsQuest

Getting Started

Home

Pages

Creating QuestsFAQObjectivesRewardsCommands and PermissionsConditionsGetting StartedConfigurationDefault Config FilesIntroductionGUI SystemPlaceholdersQuest Loot System (Premium)Tiers and DifficultiesSet up a contract NPC (Premium)Random Quest Generator (Premium)Contract Request (Premium)ExamplesDaily and Weekly Quests (Premium)ChangelogIntegrations

Configuration

Last updated Sep 21, 2026

Configuration

Files live in plugins/SoapsQuest/. Full shipped YAML: Default Config Files.

Apply config edits with /sq reload (soapsquest.reload) or a full server restart.

File map

File Purpose Edition
config.yml Core settings, progress display, sounds, anti-cheat, performance, integration toggles Free + Premium
quests.yml Quest definitions, showcase quests, citizens-npcs: links Free + Premium
messages.yml Player-facing MiniMessage text Free + Premium
gui.yml Browser, editor, and active quest menu layouts Free + Premium
tiers.yml Rarity tiers (common through mythic) Free + Premium
difficulties.yml Difficulty scaling multipliers Free + Premium
daily.yml Daily and weekly recurring quest schedules Premium
random-generator.yml Random quest generator templates and reward pools Premium
contract-request.yml Random contracts (NPC / command / browser) Premium
quest-loot.yml Chest and mob quest paper drops Premium

plugin.yml is jar metadata only — see Commands and Permissions.

Data (runtime)

Created while the server runs. Do not hand-edit while the server is online.

Path Contents
playerdata.yml Progress index when sharded; legacy single-file mode
data/players/*.yml Per-player progress shards when data.per-player-files: true
statistics.yml Historical completion stats
sigils.yml Sigil balances
generated.yml Storage for generated quest IDs (Premium; created on first generate)

Autosave interval: autosave-interval in config.yml (minutes). Data also flushes on /sq reload and shutdown.

Reload

Command Permission Effect
/sq reload soapsquest.reload Reloads all editable configs (and Premium services when present)

Reload order

  1. Merge missing keys into config.yml, messages.yml, and gui.yml (existing values kept)
  2. Ensure Premium default files exist (Premium JAR only)
  3. Validate quests.yml syntax and required fields (display, objectives) — abort keeps the old config active
  4. Flush and reload player data
  5. config.yml + logging settings
  6. messages.yml
  7. Progress display settings
  8. difficulties.yml, tiers.yml
  9. Integration bridges re-probed (WorldGuard, Lands, Citizens, mcMMO, Denizen)
  10. quests.yml (with validation)
  11. Rewards
  12. daily.yml (Premium)
  13. Async task / performance settings
  14. quest-loot.yml (Premium)
  15. Random generator config (Premium)
  16. contract-request.yml (Premium)
  17. gui.yml
  18. Refresh online players (queues, timed quest HUD, paper lore)

Free → Premium upgrade

Replace the Free jar with Premium and restart. Existing configs and player data are never overwritten. Missing Premium files are created automatically. New default keys are merged into existing config.yml, messages.yml, and gui.yml without changing your values.

See also

Version 1.0.5