config.yml
config.yml contains global behavior shared by every Snake arena. Per-arena locations, blocks, speed, and win conditions belong in arena.yml and should normally be changed through the arena editor.
Storage Selection
Section titled “Storage Selection”The current runtime selects a database implementation from the database key:
database: flatAccepted values are:
flat,flatfile, ordefaultforstats.ymlstorage;mysqlorsqlfor the connection defined inmysql.yml.
Saving and Updates
Section titled “Saving and Updates”| Key | Default | Purpose |
|---|---|---|
statistic-saving-period | 300 | Describes a statistics saving interval in seconds. The current scheduler uses a fixed five-minute interval. |
update-notifier | true | Checks Spigot resource 120508 during startup and logs a link when an update is available. |
Command Messages
Section titled “Command Messages”messages.commands controls usage errors and all arena join, edit, and deletion feedback.
| Key | Used when |
|---|---|
correct-usage | A command is missing required arguments. {0} is the expected usage. |
created-arena | A new arena is created. {0} is the arena ID. |
deleted-arena | An arena is deleted. {0} is the arena ID. |
no-arena | The supplied arena ID does not exist. |
someone-editing | Another player already has the arena editor open. |
already-editing | The sender is already editing the arena. |
editing-now | Editing starts successfully. |
arena-already-created | Create is used with an existing ID. |
arena-not-ready | Join is attempted before all locations are saved. |
already-playing | A player already belongs to a Snake arena. |
someone-playing | The target arena is occupied. |
not-playing | Leave is used outside a Snake arena. |
Messages support legacy ampersand color codes. Positional variables use {0}, {1}, and {2}.
Game Messages
Section titled “Game Messages”The messages.game section has separate results for quitting, dying, and winning:
quitanddiedreceive the current score as{0}and total board cells as{1};- the
*-without-a-scorevariants are used when the score is zero; win-eaten-allis used whentargetScoreis0;win-reached-target-scorereceives the configured target as{2}.
Direction Subtitles
Section titled “Direction Subtitles”messages.subtitles.up, down, left, and right are shown after an accepted turn. messages.subtitles.new-point appears when an apple is collected.
Sounds
Section titled “Sounds”Each entry under sounds has a sound, volume, and pitch:
| Entry | Trigger |
|---|---|
fail | A collision or non-wrapping border loss. |
direction-change | A valid direction change. |
tick | Every snake movement update. |
point | Apple collection. |
win | A completed win condition. |
Set a sound to NONE to disable it.
Placeholder Fallbacks
Section titled “Placeholder Fallbacks”The placeholders section controls output when data is missing:
no-player: an arena has no current player;not-in-arena: the requested player is not playing;no-nameandno-value: reserved leaderboard fallbacks;states.waiting,pre-in-game,in-game,ending, andinactive: friendly text forstate_pretty.