☰ Contents: MRwaitroom
For admins

Configuration

Everything is in plugins/MRwaitroom/config.yml, every option is commented there. /mrwaitroom reload applies changes; only room.* needs a restart.

Section The most important settings More
general language (default auto), fallback-language, server-language, timezone Languages & texts
main server (name in the proxy), address, link-url + link-key (MRadmin), poll-seconds Setting up
return Wait, batch size, tries, expected restart length How it works
room World, platform, chat, hide others How it works
display Item, slot in the hotbar, bossbar and colour How it works
xaero Own map ID for Xaero's Minimap/World Map Setting up
updates on/off, source, check interval, notice on join

General

Language of the texts and time zone.

Setting Default Meaning
general.language Automatic (auto) Language of the players - Automatic = every player gets the language of their Minecraft client.
general.fallback-language English (en) Fallback language - For players whose language has no file of its own.
general.server-language English (en) Server language - For texts without a single player.
general.timezone empty Time zone - For times like “maintenance until 18:00”, e.g. Europe/Vienna. Empty = time zone of this machine.

Main server

Where players go back to and how the waiting room knows what is going on.

Setting Default Meaning
main.server main Name in the proxy - Name of the main server in the section [servers] of velocity.toml.
main.address 127.0.0.1:25565 Address - Host:port of the main server in the internal network - shows whether it is up.
main.link-url http://127.0.0.1:8126 MRadmin connection - Address of waiting-room.link in MRadmin, e.g. http://10.0.0.5:8126. Empty = without MRadmin.
main.link-key empty Key - The same value as waiting-room.link.key in MRadmin.
main.poll-seconds 2 seconds Ask every

Going back

How players go back once the main server is ready.

Setting Default Meaning
return.delay-seconds 5 seconds Wait after the start - This long after “ready” it starts.
return.batch-size 5 Players per batch
return.batch-seconds 2 seconds Pause between batches
return.max-attempts 3 Tries per player - Whoever does not get back this often (e.g. banned) is disconnected.
return.estimate-seconds 90 seconds Expected restart length - Until enough restarts were measured. Afterwards the typical length of the last ones counts.

Room

The world of the waiting room.

Setting Default Meaning
room.world waitroom World - Created empty if it does not exist yet. (needs a restart)
room.platform on Build a platform - Small platform at the spawn of a newly created world. (needs a restart)
room.platform-block SMOOTH_STONE Block of the platform (needs a restart)
room.chat off Allow chat - With mrwaitroom.chat one may always write.
room.hide-players off Hide other players

Display

Item in the hotbar and bossbar.

Setting Default Meaning
display.item CLOCK Item - Shows in its name how long it takes, e.g. CLOCK.
display.slot 4 Slot in the hotbar - 0-8, stays selected.
display.bossbar on Show the bossbar
display.bossbar-color Blue (BLUE) Colour of the bossbar

Xaero maps

Own map ID, so Xaero does not draw the waiting room over the map of the main server.

Setting Default Meaning
xaero.enabled on Send an own map ID
xaero.world-id 0 Map ID - 0 = create on the first start.

Updates

Look for new versions of MRwaitroom.

Setting Default Meaning
updates.enabled on Look for updates - On start and regularly afterwards. A notice appears in the console.
updates.source GitHub (github) Source
updates.beta off Betas too - Also reports beta versions (BET-...). While a 0.x beta runs they are always reported.
updates.interval-hours 6 hours Check every
updates.notify-on-join on Tell the team on join - Players with mrwaitroom.admin.update get a notice.

Generated automatically from src/main/resources/web-config.yml + config.yml.

  • Please do not change config-version - MRwaitroom uses it to see whether the file needs updating.
  • Broken umlauts ("ä" instead of "ä")? Set the encoding in your editor to UTF-8.

✎ Edit on GitHub·docs/wiki/en/konfiguration.md ↗·View unreleased state