Default config.yml

Shipped defaults from SoapsQuest 1.0.7. Edition: Free and Premium.

After first run, this file lives in plugins/SoapsQuest/. Updating the jar does not overwrite your live copy.

See also: Config Reference · Configuration

# ##############################################################
# #                                                            #
# #                      SoapsQuest                            #
# #                                                            #
# #           Created by: AlternativeSoap                      #
# #           Website:    www.SoapsUniverse.com                #
# #           Support:    https://discord.gg/mawAzwFq          #
# #                                                            #
# ##############################################################

# ════════════════════════════════════════════════════════════════════════════
# SoapsQuest - Configuration
# Free & Premium share this file. Premium-only configs: random-generator.yml, daily.yml, quest-loot.yml, contract-request.yml
# Advanced quest system with 43+ vanilla objective types (61 with integrations)
#
# Related config files:
#   difficulties.yml  — Difficulty levels & multipliers
#   tiers.yml         — Rarity tiers & display
#   daily.yml         — Recurring quest schedules
#   quests.yml        — Quest definitions
#   messages.yml      — All plugin messages
#   gui.yml           — GUI layout & items
#   random-generator.yml — Random quest generation settings
#   contract-request.yml — Random contracts for players (NPC / command / browser)
#   quest-loot.yml    — Loot table configuration
# ════════════════════════════════════════════════════════════════════════════

# ════════════════════════════════════════════════════════════════════════════
# CORE SETTINGS
# ════════════════════════════════════════════════════════════════════════════

gui:
  enabled: true             # Master switch for all SoapsQuest inventory GUIs

debug: false                            # Enable verbose debug logging (/sq debug toggle or restart)
log-quest-completions: false            # Log when players claim quest rewards to console
log-admin-actions: false                # Log quest generation and editor saves to console
autosave-interval: 5                    # Player progress save interval (minutes)

# Player progress storage: when true, each player is written to data/players/<uuid>.yml
data:
  per-player-files: true
max-generation-retries: 5               # Max random quest generation attempts
generate-cooldown: 0                    # Cooldown in seconds between /sq generate (0 = disabled)
max-batch-generate: 25                  # Max quests per /sq generate [type] [count]

# Default values for new quests created via /sq editor
default-tier: common
default-difficulty: normal

# ════════════════════════════════════════════════════════════════════════════
# DATA CLEANUP
# Automatically removes stale playerdata.yml entries
# ════════════════════════════════════════════════════════════════════════════

data-cleanup:
  enabled: true                         # Enable automatic data cleanup
  remove-inactive-after-days: 90        # Remove data for players offline this long
  cleanup-on-startup: true              # Run cleanup when plugin loads
  cleanup-on-save: true                 # Run cleanup on each autosave

# ════════════════════════════════════════════════════════════════════════════
# PERFORMANCE
# ════════════════════════════════════════════════════════════════════════════

performance:
  async-processing-enabled: true        # Enable async quest processing
  batch-size: 50                        # Operations per batch
  processing-interval-ticks: 20         # Batch processing interval (ticks)
  batch-save-enabled: true              # Enable batch save optimization
  batch-save-interval-ticks: 100        # Batch save interval (ticks)
  coalesce-save-ticks: 40               # Merge rapid progress saves (2s)

# ════════════════════════════════════════════════════════════════════════════
# PROGRESS DISPLAY
# Modes: actionbar | chat | bossbar | none
# ════════════════════════════════════════════════════════════════════════════

progress-display:
  mode: "actionbar"                     # actionbar = above hotbar, bossbar = top bar
  interval: 5                           # Chat mode: show every X updates
  bossbar:
    color: "GREEN"
    style: "SEGMENTED_10"
    duration: 5                         # Seconds to display bossbar

# ════════════════════════════════════════════════════════════════════════════
# SOUNDS
# ════════════════════════════════════════════════════════════════════════════

# Milestone reached (e.g. 50%, 75%)
milestone-sound: "ENTITY_PLAYER_LEVELUP"
milestone-sound-volume: 1.0
milestone-sound-pitch: 1.0

# Quest completion (all objectives done)
completion-sound: "UI_TOAST_CHALLENGE_COMPLETE"
completion-sound-volume: 1.0
completion-sound-pitch: 1.0

# ════════════════════════════════════════════════════════════════════════════
# QUEST PAPER BEHAVIOR
# ════════════════════════════════════════════════════════════════════════════

# Q-drop releases the paper to the world (progress kept). Another player can pick it up and continue.
# Storing in a chest/ender chest/shulker only pauses it until picked up again.
# lock-to-player still blocks others from taking parked papers.
# Hoppers, dispensers, droppers, and similar cannot move quest papers.

# Prevent quest papers from being placed into crafting grids, anvils,
# grindstones, smithing tables, and other workstation slots.
prevent-workstation-placement: true

# Block objective anti-cheat (all on by default; set enabled: false to disable all).
anti-cheat:
  enabled: true
  break: true      # break/harvest ignore player-placed blocks
  place: true      # place ignores re-placing after breaking 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

# ════════════════════════════════════════════════════════════════════════════
# TIMED QUEST DISPLAY (global defaults for quests with timer: in quests.yml)
# ════════════════════════════════════════════════════════════════════════════
# paper-name: append countdown to the quest paper item name (in addition to lore).
# action-bar: live countdown while a timed quest is active in your queue.
# boss-bar: progress-style boss bar for the most urgent active timed quest.
# chat-reminder-seconds: 0 = off; otherwise sends chat reminders on that interval.

quest-timer-display:
  paper-name: false
  action-bar: true
  boss-bar: false
  chat-reminder-seconds: 0

# ════════════════════════════════════════════════════════════════════════════
# OPTIONAL PLUGIN INTEGRATIONS
# Soft-dependencies: Lands, Citizens, mcMMO, WorldGuard, Denizen (see plugin.yml).
# MythicMobs and PlaceholderAPI are detected automatically — no config entry needed.
#
# With auto-detect enabled (default), each integration turns on when its plugin is installed.
# Set an integration to false to force-disable it, or set auto-detect: false to opt in manually.
# ════════════════════════════════════════════════════════════════════════════

integrations:
  auto-detect: true
  # Optional per-plugin overrides (omit or set true to allow auto-detect):
  # lands: false
  # citizens: false
  # mcmmo: false
  # worldguard: false
  # denizen: false