Configuration

Settings are in plugins/Veloroad/config.yml; every option is commented there. Apply changes with /veloroad reloadconfig.

KeyDefaultMeaning
languageenen, tr, es, de or fr. Messages are in plugins/Veloroad/lang/<language>.yml.
backups.folder-name.veloroad-backupsFolder inside plugins/ where the current jar is saved before it is replaced.
backups.keep-per-plugin5Backups kept per plugin; older ones are deleted. 0 keeps everything, which is not recommended.
safety.require-confirmtrue/veloroad unload needs the word confirm.
safety.block-if-dependentstrueUnload, disable and reload are blocked while another plugin depends on the target, unless force is added.
safety.block-unsafe-reloadtrueReload and unload of the plugins in unsafe-reload-plugins is blocked unless force is added, and automatic updates of them are never applied.
safety.unsafe-reload-pluginsProtocolLib, WorldEdit, WorldGuard, ViaVersion, FastAsyncWorldEditCase-insensitive list.
notifications.notify-opstrueAnnounce every action to online operators.
notifications.notify-consoletruePrint the same announcement to the console.
notifications.discord-webhook-urlemptyPosts every action to a Discord channel. Empty means off. Mentions are never triggered and the address is never printed to the log.
performance.force-gc-after-unloadfalseRuns System.gc() after an unload. Not recommended; it can cause a short lag spike.
logging.enabledtrueWrites plugins/Veloroad/audit.log.
logging.max-lines5000The log drops its oldest lines past this many. 0 never trims.
health-check.enabledtrueAfter a deploy, checks that every command the plugin declares belongs to the new version. A mismatch fails the deployment and restores the previous version when a backup exists.
auto-deploy.enabledtrueWatches plugins/ for X.jar.new (replace) and X.jar.install (install when not installed). A failed file is renamed to <name>.failed.
auto-deploy.poll-seconds15How often the folder is checked.
auto-deploy.install-newtrueLets *.jar.install files add plugins that are not installed yet.
multi-server.linked-serversemptyFolder names (next to this server's folder) or full paths of servers on the same machine that receive /veloroad reload <plugin> all. Each needs its own VeloRoad.
multi-server.discover-siblingsfalseTreats every folder next to this server that has a plugins folder as a linked server. Off by default because on a shared machine it could reach servers that are not yours.
dependency-sourcesemptyDownload links for missing hard dependencies. Only HTTPS is used, the download is limited in size and time, and the file must be the plugin it claims to be. A sha256 value is optional but recommended.
integrations.metrics.enabledtruebStats metrics. See the privacy section on the overview page.

Linked servers #

yaml
multi-server:
  linked-servers:
    - survival
    - "D:/servers/lobby"

Only linked servers that already have the plugin installed are updated. Add install (/veloroad reload <plugin> all install) to also install it on linked servers that do not have it yet. The servers must share a disk with this one.

Dependency sources #

yaml
dependency-sources:
  Vault:
    url: "https://example.com/Vault.jar"
    sha256: "the SHA-256 of the file"