Default Configs

Last updated Sep 18, 2026

Default Configs

Files created in plugins/SoapsQuest/ on first run.


All editions

File Purpose
config.yml Core settings, progress display, sounds, anti-cheat, performance
quests.yml Quest definitions and showcase quests
messages.yml Player-facing messages
gui.yml Browser, editor, and active quest menu layouts
tiers.yml Rarity tiers (common through mythic)
difficulties.yml Difficulty scaling multipliers
playerdata.yml Per-player quest instance progress (auto)
statistics.yml Completion counts by tier and difficulty (auto)
sigils.yml Sigil balances (auto)
data/players/ Per-player progress shards when data.per-player-files: true (auto)

config.yml highlights

gui:
  enabled: true
debug: false
autosave-interval: 5
default-tier: common
default-difficulty: normal
progress-display:
  mode: "actionbar"    # actionbar | chat | bossbar | none
prevent-workstation-placement: true
anti-cheat:
  enabled: true
  break: true
  place: true
  collect: true
  creative: true
quest-timer-display:
  paper-name: false       # append countdown to paper item name
  action-bar: true        # live countdown while timed quest is active
  boss-bar: false         # boss bar for most urgent active timed quest
  chat-reminder-seconds: 0  # periodic chat updates (0 = off; 60s warning always sent)

Quest paper behavior (comments in config.yml): pressing Q to drop a quest paper releases it to the world with progress preserved; another player can pick it up and continue. Storing a paper in a chest, ender chest, or shulker only pauses it until picked up again. Quest papers cannot be placed in workstations or moved by hoppers. There is no /sq abandon — drop the paper to release it.

Free → Premium upgrade

Replace the Free jar with Premium and restart. Existing configs and player data are never overwritten. Missing Premium files (random-generator.yml, daily.yml, contract-request.yml, quest-loot.yml) are created automatically. New default keys are merged into existing config.yml, messages.yml, and gui.yml without changing your values.

Timed quest HUD (quest-timer-display above): optional countdown on the paper item name, action bar, boss bar, and periodic chat reminders while a timed quest is active in your queue. Timer lore on the paper always updates when a deadline is armed.

Block objective anti-cheat

anti-cheat:
  enabled: true
  break: true      # break/harvest ignore player-placed blocks
  place: true      # place ignores re-placing after you break your own block
  collect: true    # collect ignores drops from those breaks and items you dropped
  creative: true   # no break/place/harvest/collect progress in creative mode

Set enabled: false to turn off all rules. Each sub-key defaults to true when omitted.

Tracking is in-memory and resets on server restart. Blocks placed before restart are treated as natural until someone places again.

See FAQ for common anti-cheat questions.

integrations:
  lands: true
  citizens: true
  mcmmo: true
  worldguard: true
  denizen: true

quests.yml

Top-level quests: map. Each key is a quest ID. See Creating Quests. Ships with starter quests and showcase_<type> entries for every objective type (admin-gated showcases in 1.1.0).

Optional timer: (minutes, start-on: receive|activate, on-expire: fail|consolation|overtime) and fail-reward: (same keys as reward:) add a per-quest deadline. Omit timer: for untimed quests. activate starts the clock when the player right-clicks the active paper in hand. Fail rewards are edited in the quest editor next to success rewards.

NPC links are stored in quests.yml under citizens-npcs:. See Integrations. Also editable via /sq npc link.

gui.yml

Sections: quest-browser, quest-editor, quest-details, objective-editor, condition-editor, reward-editor, player-quests.

tiers.yml / difficulties.yml

Define display, color, weight, description, and (for difficulties) multiplier blocks. See Tiers and Difficulties.


Premium only

These files are bundled only in the Premium JAR:

File Purpose
daily.yml Daily and weekly recurring quest schedules
random-generator.yml Random quest generator templates and reward pools
contract-request.yml Random contracts from NPCs, commands, or the browser
quest-loot.yml Chest and mob quest paper drops
generated.yml Storage for generated quest IDs (created on first generate)

Data files (do not hand-edit while server is running)

File 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 Economy balances

Use /sq reload after editing YAML configs. Data files are written on autosave (autosave-interval minutes) and shutdown.


Reload order

/sq reload refreshes, in order:

  1. config.yml
  2. messages.yml
  3. difficulties.yml, tiers.yml
  4. quests.yml (with validation)
  5. Rewards
  6. daily.yml (Premium)
  7. quest-loot.yml (Premium)
  8. Random generator config (Premium)
  9. contract-request.yml (Premium)
  10. gui.yml
  11. Citizens NPC links in quests.yml (citizens-npcs:) when Citizens integration is enabled
  12. Integration bridges re-probed (WorldGuard, Lands, Citizens, mcMMO, Denizen)

Version 1.0.5