Skip to content

Configuration

ZDiscord edited this page Jun 7, 2026 · 4 revisions

Configuration

All configuration lives in plugins/ZDiscord/config.yml. User-facing strings are in messages.yml.

Top-level sections

Section Purpose
storage YAML or MySQL backend for persistent data
bot Bot token, activity, and target guild
channels Discord channel IDs for each module
chat Chat bridge formatting and webhook options
events Join, quit, death, and advancement messages
status Server status embed
leaderboard Stats tracked and the leaderboard size
tickets Support ticket settings
linking Account linking and reward commands
anti-raid Mass-join thresholds and lockdown behaviour
performance TPS and memory alert thresholds
profile Player profile card appearance
follow Follow system toggle
confessions Confession channel, colour, and cooldown
command-logger Watched and critical commands
staff-chat Staff chat bridge channel
voice-status Voice status indicator
misc Invite link, console role, debug flag

Placeholders

User-facing strings and event messages accept the following placeholders:

  • %player%, %name% — player username
  • %displayname% — display name (colour codes stripped)
  • %uuid%, %uuid_nodashes% — player UUID
  • %world% — current world
  • %x%, %y%, %z% — coordinates
  • %health%, %food% — vitals
  • %online%, %max% — server player counts
  • %tps% — current TPS, one decimal
  • %death_message% — vanilla death message

Colour codes use the & character (e.g. &a for green). The %prefix% placeholder is replaced with the value of messages.yml:prefix.

Avatar URL

The chat.avatar-url field controls the avatar source for player heads. It accepts the same placeholders above; the default is https://crafatar.com/avatars/%uuid%?overlay=true.

Validation

The configuration is non-destructively migrated on version bumps. Existing values are preserved; missing keys are filled in from the bundled defaults. The config-version key is updated automatically.


ZDiscord v1.1.0 · Home · Issues · Source

Clone this wiki locally