Configuration
config.yml #
| Key | Default | Meaning |
|---|---|---|
language | en | en, es, pt_br, de, tr, fr, ru. |
health-check-interval-seconds | 10 | How often waiting players' server is pinged (2-3600). |
ping-timeout-seconds | 5 | A ping slower than this counts as failed (1-60). A crashed server refuses at once; this only matters for a hung one. |
return-stability-checks | 2 | Answers in a row required before players are sent back (1-20). |
return-rate-per-second | 20 | Players sent back per second (1-1000). |
return-give-up-minutes | 30 | Stop trying after this long (0 = never). The player is told. |
planned-shutdown-messages | Server closed, Server is restarting, Restarting | Kick messages (part of the text, ignoring case) that mean the server is being stopped on purpose. [] = only crashes trigger the fallback. |
planned-return-grace-seconds | 60 | After a planned stop, players wait until the server was seen going down or this many seconds passed (0-3600). |
teleport-to-spawn-on-return | true | After a crash, ask VelorFailoverSpawn on the recovered server to teleport the player to spawn (the saved position may be old). |
teleport-to-spawn-after-planned-stop | false | The same after a planned stop. false = the player returns exactly where they were. |
switch-commands | lobby, survival | List of command, target, optional permission, restrict-from, override. |
fallback-routes | survival -> lobby | List of watch, fallback, optional auto-return (default true). |
A switch command whose name is already used by another plugin or by Velocity is skipped with a warning; add override: true to replace it. A route that would send players around in a circle (A to B and B to A) is skipped with a warning. Servers that are not in velocity.toml are reported at startup and on reload.
Settings added by a newer version are appended to your existing config.yml with their comments (a backup is kept as config.yml.bak); your own values, switch commands and routes are never touched.
Messages #
Every message is in plugins/velorfailover/lang/<language>.yml and can be edited. Colours use &a, &c, ... and hex like 7FF55. A message missing from your file is taken from the bundled copy of the same language, then from English.
VelorFailoverSpawn #
The proxy sends one plugin message on the channel velorfailover:spawn right after it returns a player. The companion teleports the player to the world spawn. The proxy drops that message when a client sends it, and the companion accepts it once per login, in the first seconds after the player joined, so players cannot use it to teleport themselves. Without the companion the setting is ignored.