Skip to content

config.yml

config.yml contains global behavior shared by every Snake arena. Messages and sounds now have dedicated files, while per-arena locations, blocks, speed, and win conditions belong in arenas.yml.


KeyDefaultPurpose
databaseflatSelects flat-file storage or the connection defined in mysql.yml.
statistic-saving-period300Seconds between asynchronous arena and statistic saves and leaderboard refreshes. Values below 1 are treated as one second.
leaderboard-size10Maximum number of ranked entries cached for leaderboard placeholders.

The database selector accepts flat, flatfile, or default for data/stats.yml, and mysql or sql for MySQL. Data migration between storage types is not automatic.


When command blocking is enabled, a player in an arena can only execute entries from the allowlist:

command-settings:
disable-commands-while-playing: true
allowed-commands:
- "snake leave"

Entries are case-insensitive and may include or omit the leading slash. A root such as msg allows all of its arguments, while snake leave allows that subcommand and any arguments below it. Namespaced roots such as minecraft:msg are normalized before matching.


KeyUsed by
placeholders.no-playerArena player placeholders when the arena is empty.
placeholders.not-in-arena%snake_player_arena% outside a game.
placeholders.no-nameEmpty leaderboard name or UUID positions.
placeholders.no-valueEmpty leaderboard value positions.
placeholders.states.*Friendly waiting, in-game, ending, restarting, and inactive state labels.

KeyDefaultPurpose
update-notifiertrueChecks for newer SpigotMC releases during startup.
debugfalseRegisters advanced debug commands and their tab completion.
event-profiling.enabledfalseMeasures execution time spent inside listeners for The Snake custom events.
event-profiling.verbosefalseLogs every profiled event call with timing details.

/snake reload applies cached options, command rules, messages, sounds, and event-profiling switches without a full server restart. Changing the database implementation still requires careful restart and migration planning.