Configuration
A guided tour of config.yml — split by section so you only read what you need.
TDX Leaderboards keeps everything in two YAML files. They live under
plugins/TDXLeaderboards/ and are created automatically on first start.
config.yml— every behavioural setting (storage, schedules, boards, rewards, hooks).messages.yml— every player-facing string. MiniMessage-aware: colour, click events, hover events, gradients all supported.
Both files are auto-merged with new bundled keys on plugin upgrade — your
customisations are preserved and a timestamped .backup-YYYYMMDD-HHMMSS
copy is written next to the original before any change.
The bundled config.yml is heavily commented and is the main
reference. The pages below explain why each section exists, with
worked examples, the inline comments tell you exactly what every key
does.
Sections
general
Update interval, leaderboard size, storage backend, debug toggle.
storage
SQLite vs MySQL — when to use which, full schema, pool sizing.
monthly
Reset schedule — monthly, weekly, or biweekly.
points
Points-from-position scoring across boards.
rewards
Per-position commands and messages, plus per-board overrides.
boards
The actual board definitions — type, statistic, material, slot. Read this one first if you only read one.
milestones
First-time top-N alerts and rewards.
hooks
DecentHolograms, Discord webhooks, PlaceholderAPI.
Reload vs restart
- Reload-able with
/lbadmin reload: everything exceptgeneral.storageand themysqlblock. - Restart-required: switching storage backend, changing the database connection.