☰ Contents: MRwaitroom
For admins

Configuration

Preview: unreleased state (branch beta) - may still change before the next release. Go to the released version →

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
server Memory, Java options, Paper updates, planned restarts, /stop, hangs - only with the starter Restarts
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 for times of day.

Setting Default Meaning
general.language Automatic (auto) Language of the players - Automatic: every player gets the language of their Minecraft client (German or English, otherwise the fallback language). Or one fixed language for everyone.
general.fallback-language English (en) Fallback language - For players whose Minecraft is set to a language without a language file (e.g. French).
general.server-language English (en) Server language - For texts that go to no single player. The console always stays English.
general.timezone empty Time zone - For times like “maintenance until 18:00” in the bossbar and the menu, e.g. Europe/Vienna. Empty = the time zone of the machine the waiting room runs on.

Main server

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

Setting Default Meaning
main.server main Name in the proxy - Exactly the name the main server has in the section [servers] of velocity.toml (e.g. main). The waiting room sends the players back there.
main.address 127.0.0.1:25565 Address of the main server - Host:port of the main server in the internal network, e.g. 10.0.0.5:25565. The waiting room sees from it whether the server is up - also without MRadmin.
main.link-url http://127.0.0.1:8126 MRadmin address - Address of MRadmin's waiting room endpoint (waiting-room.link there), e.g. http://10.0.0.5:8126. Reason, countdown, maintenance, warnings as well as configuration and updates come through it. Empty = without MRadmin.
main.link-key empty Key - The same value as waiting-room.link.key in MRadmin's config.yml. Without the matching key MRadmin does not answer.
main.poll-seconds 2 seconds Ask every - How often the waiting room checks the main server and asks MRadmin. Shorter = faster return, longer = fewer requests. 2 seconds fit almost always.
agent.port 8127 Port for MRadmin - Through this port MRadmin shows performance, console and log of this server like its own. Protected with the key above, MRadmin finds it by itself. 0 = off.
agent.bind empty Listen on address - Best the address in the internal network (e.g. 10.0.152.101), then the port cannot be reached from outside. Empty = all addresses of this machine.
agent.console-commands on Commands from MRadmin's console - Allows commands through MRadmin's web console (there only with the permission and after unlocking as on the main server). Off = the console only shows the output.

Going back

How players go back once the main server is ready again.

Setting Default Meaning
return.delay-seconds 10 seconds Countdown before going back - Once the main server is ready again, this countdown runs in the waiting room (bossbar, chat line, ticking in the last seconds) - then players go back. Gives plugins time to finish loading.
return.batch-size 5 Players per batch - This many players go back at once. Small batches spare the freshly started server, whoever waits longest goes first.
return.batch-seconds 2 seconds Pause between batches - Gap between two batches. Example: 5 players every 2 seconds = 50 players in 20 seconds.
return.max-attempts 3 Tries per player - If a player does not arrive on the main server this often (e.g. banned or not on the whitelist), the waiting room disconnects them with a note. During a maintenance nobody is disconnected.
return.estimate-seconds 120 seconds Countdown of restarts - The bossbar counts down from here on a restart or crash of the main server. If it is back earlier, players go back earlier; if it takes longer, it says “back in a moment”.

Room

The world players wait in.

Setting Default Meaning
room.world waitroom World - Name of the waiting room world. If it does not exist yet, MRwaitroom creates it empty (no terrain). Every player is put at its spawn on joining. (needs a restart)
room.lobby on Build the lobby - Builds the lobby when a new world is created - with spawn and board. That is the bundled lobby or your own, saved with /mrwaitroom lobby save. An existing world stays as it is. (needs a restart)
room.platform on Build a platform - Only without the lobby: builds a small platform (9×9) at the spawn when a new world is created, so nobody falls into the void. An existing world stays as it is. (needs a restart)
room.platform-block SMOOTH_STONE Block of the platform - Minecraft name of the block, e.g. SMOOTH_STONE, QUARTZ_BLOCK or GLASS. (needs a restart)
room.chat off Allow chat - Whether waiting players may write. Off by default, so e.g. banned players cannot write during a restart. With mrwaitroom.chat it always works.
room.hide-players off Hide other players - Waiting players do not see each other - calmer with many players on the small platform.

Display

Clock in the hotbar and bossbar with the countdown.

Setting Default Meaning
display.item CLOCK Item - Minecraft name of the item in the hand, e.g. CLOCK. Its name says what is going on (“⏳ Restart”), a right click opens the menu with all details.
display.slot 4 Slot in the hotbar - 0 = far left, 4 = middle, 8 = far right. The slot stays selected.
display.bossbar on Show the bossbar - At the top of the screen: countdown, reason and a bar until the expected return or the end of the maintenance.
display.bossbar-color Blue (BLUE) Colour of the bossbar - Colour of the bar at the top of the screen.

Server & restarts

Only with MRadmin's starter (mrserver setup --role waitroom): it starts the waiting room, brings it back after restarts and crashes and keeps Paper up to date.

Setting Default Meaning
server.restart-times empty Planned restarts - Every day at these times (time zone see General). The waiting room only restarts when it is not needed: main server ready, no maintenance, no restart of the main server within the next 15 minutes, nobody waiting. Otherwise the restart waits until that is true.
server.plain-stop Stays down (stop) /stop in the console - What a plain /stop does: the server stays down, or it comes back right away.
server.memory-min 1G Memory min. - E.g. 1G or 1024M. Applies from the next start.
server.memory-max 2G Memory max. - E.g. 2G. 2 GB are plenty for the waiting room. Applies from the next start.
server.paper-update Automatic (auto) Paper updates - Automatic = before every start the newest stable Paper build of this Minecraft version (never a new Minecraft version). If it does not start, the starter takes the old one again.
server.java-flags -XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:MaxGCPauseMillis=200 -XX:+UnlockExperimentalVMOptions -XX:+DisableExplicitGC -XX:+AlwaysPreTouch -XX:G1NewSizePercent=30 -XX:G1MaxNewSizePercent=40 -XX:G1HeapRegionSize=8M -XX:G1ReservePercent=20 -XX:G1HeapWastePercent=5 -XX:G1MixedGCCountTarget=4 -XX:InitiatingHeapOccupancyPercent=15 -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=5 -XX:SurvivorRatio=32 -XX:+PerfDisableSharedMem -XX:MaxTenuringThreshold=1 -Dusing.aikars.flags=https://mcflags.emc.gs -Daikars.new.flags=true Java options - Default are Aikar's flags (recommended for Paper). Only tuning options - anything that could run programs or read files is ignored.
server.hang-seconds 180 seconds Hang after - If the server does not tick this long, the starter ends and restarts it. 0 = off.

Xaero maps

For players with Xaero's Minimap or World Map.

Setting Default Meaning
xaero.enabled on Send an own map ID - Behind the proxy the main server and the waiting room have the same address. With an own map ID Xaero keeps the maps apart - otherwise the empty waiting room world could overwrite the map of the main server.
xaero.world-id 0 Map ID - Created at random on the first start. Only change it if you know why - Xaero starts a new map for a new ID.

Updates

New versions of MRwaitroom - also those you order in MRadmin.

Setting Default Meaning
updates.enabled on Look for updates - On start and regularly afterwards. If there is a new version, a notice appears in the console.
updates.source GitHub (github) Source - Where to look for new versions. GitHub is the official 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 - Gap between two checks.
updates.notify-on-join on Tell the team on join - Players with mrwaitroom.admin.update get a notice about a new version on joining.
updates.restart-when-idle on Put in updates when idle - Updates ordered in MRadmin are downloaded by the waiting room itself. If this is on, it restarts as soon as nobody waits and the main server is ready. Needs something that starts it again (e.g. systemd with Restart=always) - otherwise switch it off, then the update comes with your next restart by hand.

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 ↗