Configuration

A walk through config.yml section by section, with every key, what it controls and its default.

config.yml holds everything that is not about one particular event. Every key has a comment above it in the file itself, and this page goes through them in the same order. Events live in their own file, see Events file.

A map of config.yml as eight cards: language and disabled worlds, storage, scheduler, anti-repeat, team-mode, event-defaults, logging, and sounds, each with the keys that live under it.

Language and worlds

language: en
disabled-worlds:
  - creative_world
  - plots

Key	What it does	Default
`language`	Which file in the `lang` folder to read messages from.	`en`
`disabled-worlds`	Worlds where nothing is ever counted.	two examples

See Messages & language and Scoring rules.

Storage

storage:
  type: sqlite
  mysql:
    host: localhost
    port: 3306
    database: eventpulse
    username: root
    password: ""
    use-ssl: false
    pool-size: 8

sqlite needs no setup and is the default. The mysql block is only read when type is mysql. See Storage for every key.

Scheduler

scheduler:
  enabled: true
  min-interval: 45m
  max-interval: 90m
  first-delay: 10m
  min-online-players: 5
  retry-interval: 5m
  blackout-hours:
    - "23:00-07:00"

anti-repeat:
  remember-last: 3

When events start on their own, how long the wait is, how many players it needs, when it must not start, and how many recent events cannot be picked again. See Scheduling for every key.

Team mode

team-mode:
  mode: RANDOM
  chance: 25
  provider: AUTO
  solo-players-compete: true
  reward-online-only: false

Whether events run per island, how often, and through which island plugin. See Team mode for every key.

Event defaults

event-defaults:
  duration: 15m
  broadcast-places: 3
  min-participants: 3
  warn-at:
    - 5m
    - 1m
    - 10s

Key	What it does	Default
`duration`	Used by any event that does not set its own `duration`.	`15m`
`broadcast-places`	How many places the end announcement lists.	`3`
`min-participants`	Fewer players than this scoring means nobody is paid. Set it to `0` while testing alone.	`3`
`warn-at`	Times before the end at which the warning message and sound go out.	`5m`, `1m`, `10s`

Logging

logging:
  quiet-reward-commands: true
  announce-in-console: true
  detailed-rewards: false

Key	What it does	Default
`quiet-reward-commands`	Reward commands are run from the console, and every reply they write lands in the log. On, the replies are swallowed. The plugin that owns a command may still write its own lines.	`true`
`announce-in-console`	Write the start, warning and end broadcasts in the console as well as in chat.	`true`
`detailed-rewards`	Write a line for every single reward handed out and every place that paid nobody. Turn it on only while working out why a reward did not arrive.	`false`

Every warning and every failure reason stays in the console whatever these are set to, since those are the lines that diagnose a real problem.

Spawn diagnostics

debug-spawns: false

Key	What it does	Default
`debug-spawns`	Logs why an objective block or entity could not spawn, including missing points, unloaded chunks, no safe ground, active caps being reached, MythicMobs being unavailable or not recognising a mob, and an entity removed by another plugin.	`false`

This is off by default. A no-safe-ground failure can still be written once per event so a completely failed random spawn is not silent.

Sounds

sounds:
  start: ENTITY_PLAYER_LEVELUP
  start-volume: 1.0
  warn: BLOCK_NOTE_BLOCK_PLING
  warn-volume: 1.0
  end: UI_TOAST_CHALLENGE_COMPLETE
  end-volume: 0.4

Played to everyone with the notify permission when an event starts, at each warning, and at the end. Set any of them to none to turn that sound off. A sound name is the Minecraft sound id in capitals with the dots turned into underscores, so block.note_block.pling is written BLOCK_NOTE_BLOCK_PLING. A name the running version does not have plays nothing, and the console says so once, naming it.

Each sound also has its own volume, start-volume, warn-volume and end-volume, each written as a number from 0.0 for silent to 1.0 for full volume. The end sound is set to 0.4 out of the box because it is the loudest of the three, and each is lowered to whatever its volume key says rather than all playing at the same loudness.

Key	What it does	Default
`start-volume`	How loud the start sound is.	`1.0`
`warn-volume`	How loud each warning sound is.	`1.0`
`end-volume`	How loud the end sound is.	`0.4`

Durations

Every duration in every file is written the same way: 30s, 15m, 1h, or a combination such as 1h30m. A value the plugin cannot read falls back to its default with a console warning that says how to write it.

Keeping the file up to date

config.yml carries a config-version key at the top. On an upgrade, any key added since your version is written in with its comment, your own values are kept, and the console prints one line saying the file was brought forward. Leave that key alone. See Installation.

Reload

/event reload rereads this file, the events, FarmPoints, the scoreboard layout and the language files. An event already running keeps the settings it started with. Storage settings are read at startup only, so a change of database needs a restart.

On this page