Configuration

config.yml holds the general settings: language, storage, notifications, and saving.

After any change, run /collection reload to apply it without restarting. See Commands.

warning

Do not change the config-version line at the top. It controls automatic config updates. If you change it, the plugin may overwrite your settings or skip an update.

When a new version adds a setting, it is merged into your existing config.yml automatically on the next start, with its default value and comments. Your own changes are kept. So after an update you may see new lines you did not add. That is expected.

Language

language: english

Picks which file to load from the lang/ folder. Built-in options are english, french, spanish, italian, and german. See Messages and Language.

Storage

storage:
  type: sqlite
  mysql:
    host: localhost
    port: 3306
    database: zcollections
    username: root
    password: ''
    use-ssl: false
    pool-size: 10

type is sqlite (default, no setup) or mysql (for shared data across servers). The mysql block is only used when type is mysql. See Storage for the full guide.

Discovery notifications

Controls what a player sees the first time they discover a resource.

discovery:
  enabled: true
  send-title: true
  send-chat: true
  send-actionbar: false
  sound: ENTITY_PLAYER_LEVELUP
  sound-volume: 1.0
  sound-pitch: 1.2

Setting	What it does
enabled	Turn discovery notifications on or off
send-title	Show a title on screen
send-chat	Send a chat message
send-actionbar	Show a message above the hotbar
sound	The sound to play, a Minecraft sound name
sound-volume	How loud, 1.0 is normal
sound-pitch	How high, 1.0 is normal

Tier-up notifications

Controls what a player sees when they reach a new tier.

tier-up:
  send-title: true
  send-chat: true
  send-actionbar: false
  sound: UI_TOAST_CHALLENGE_COMPLETE
  sound-volume: 1.0
  sound-pitch: 1.0
  fireworks: false

Same settings as discovery, plus fireworks, which launches a celebratory firework at the player on a tier-up when set to true.

Rewards

Controls how tier rewards are handed out and how the permission reward type grants its node.

rewards:
  mode: claim
  permission-command: 'lp user {player} permission set {node} true'

Setting	What it does
mode	claim (default) or auto. See below.
permission-command	The console command run for a permission: reward. {player} and {node} are filled in.

Reward mode:

• claim - reaching a tier makes its rewards claimable. Players open a resource and click each completed tier to claim it, or use the main-menu Claim All button to claim every completed tier across all collections at once. Nothing is paid until they claim.
• auto - rewards are paid the instant a tier is reached, with nothing to claim. This is how earlier versions behaved.

See Tiers and Rewards for the reward types and the claim flow.

The default permission-command targets LuckPerms. To use a different permission plugin, change the command to match it.

Per-collection commands

Gives each collection its own command that opens it directly, like /mining instead of /collection mining.

category-commands:
  enabled: true
  only-show-alias: false
  commands:
    mining: [mining]
    farming: [farming]
    hunting: [hunting]
    fishing: [fishing]
    lumberjack: [lumberjack]
    divers: [divers]

Setting	What it does
enabled	Turn the whole feature on or off
only-show-alias	false (default): /collection tab-complete suggests both the collection id and its custom command, like mining and minage. true: hide the id for any collection that has a custom command, suggesting only the custom one. Either way /collection <id> still works when typed in full
commands	Maps each collection id to the command name(s) that open it

Each line maps a collection id (the part before the colon, matching categories.yml) to a list of command names. Each name is a single word with no slash and no arguments: [minage] makes /minage open the collection. Do not write [collection minage], that is not a command name. The first word is the main command; any extra words are aliases, so [mining, mine, min] gives all three.

info

Changes here apply after a server restart, not a /collection reload. If a name is already used by another plugin, the command still works as /zcollections:<name>. You do not need this section to open a collection directly, /collection <id> always works too. See Commands.

Divers (stat-based collections)

Controls the stat-tracking collections such as playtime, votes, experience, and island level.

divers:
  poll-interval: 60

Setting	What it does
poll-interval	How often, in seconds, polled stats are refreshed (playtime, votes, island level, and other STAT resources). Default 60.

See Categories for how to set up EXP_GAIN and STAT resources.

Saving

save-interval: 300

How often, in seconds, player data is written to the database. The default is 300 (every five minutes). Data also saves when a player logs out and when the server stops, so this is a safety net, not the only save.

Metrics

metrics: true

Sends anonymous usage stats through bStats. Set to false to turn it off.

Debug

debug: false

Turns on extra console logging. Leave it false unless you are tracking down a problem or a support helper asks you to turn it on.

Related pages

• Storage covers SQLite and MySQL in detail.
• Messages and Language covers the lang/ files.
• Categories covers collections, resources, and rewards.