Maintenance

Maintenance

Close your server or network for maintenance, with its commands and placeholders.

View as Markdown ·

On this page

circle-info

This module is configured in modules/maintenance.yml inside the PhoenixLobby folder.

#Maintenance

Maintenance closes a server, or the whole network, for everyone except the people you allow. Players already connected are kicked, and new connections are denied until it ends. Open it from Editor > Modules > Maintenance.

It works in two places. Without a proxy, the lobby runs its own maintenance and closes only that server. On a proxy the maintenance lives on BungeeCord or Velocity, where it can close any backend server or the entire network at once, and the lobby side stands down.

Behind a proxy, a player on a closed server, or trying to join one, is sent to a lobby instead, and only kicked when no lobby is open to them. Closed lobbies are skipped when picking one, except for players who are allowed in, so /lobby and /hub keep working for them.

Everyone with phoenixlobby.maintenance.bypass can always join, and phoenixlobby.maintenance is needed to use the command.

Modules (Maintenance)

#Maintenance State

With this option, you can close the server right now, and open it again the same way. It has no end time, so it stays closed until you turn it back off. Use /maintenance start <time> instead when you want it to end on its own.

Maintenance (Maintenance State)

#Whitelisted Players

With this option, you can list the names or uuids that are still allowed in while the server is closed. It is the same list /maintenance add writes to, so either way of managing it works.

Maintenance (Whitelisted Players)

#Feature State

With this option, you can turn the module off completely. The commands stop working and nobody is kept out, even if a maintenance was left running.

Maintenance (Feature State)

#Time Format

Times are written as 1Y 1M 1W 1D 1H 1m 1S, and can be combined, for example 1D12H.

circle-exclamation

An uppercase M means months and a lowercase m means minutes.

#Changing the time words

The letters and words used for times live in the time-format section of the translations file on the lobby, and of messages.yml on the proxy. Every unit has a short form and a full form, in singular and plural.

YAML
time-format:
  style-commands: "short"
  style-motd: "short"
  style-placeholders: "full"
  separator: " "
  short-entry: "%amount%%unit%"
  full-entry: "%amount%%unit%"
  years-short: "Y"
  years-singular: "Year"
  years-plural: "Years"
  months-short: "M"
  months-singular: "Month"
  months-plural: "Months"
  weeks-short: "W"
  weeks-singular: "Week"
  weeks-plural: "Weeks"
  days-short: "D"
  days-singular: "Day"
  days-plural: "Days"
  hours-short: "H"
  hours-singular: "Hour"
  hours-plural: "Hours"
  minutes-short: "m"
  minutes-singular: "Minute"
  minutes-plural: "Minutes"
  seconds-short: "S"
  seconds-singular: "Second"
  seconds-plural: "Seconds"
Key What it does
style-commands short or full, for the replies of /maintenance
style-motd short or full, for {timer} in the motd
style-placeholders short or full, for %phoenixlobby_maintenance_<server>% (lobby only)
separator What goes between two units
short-entry How one unit is written in the short style. %amount% is the number, %unit% the short form
full-entry How one unit is written in the full style. %unit% is the singular or plural word

For a German server, set the short forms to J, M, W, T, S, m and s, the words to Jahr/Jahre, Monat/Monate, Woche/Wochen, Tag/Tage, Stunde/Stunden, Minute/Minuten and Sekunde/Sekunden, and full-entry to "%amount% %unit%" for a space between the number and the word. Switch a style to full wherever you want the times written out.

The short forms you set are also accepted when typing a time in the commands, so with the German letters /maintenance start 1T12S closes the server for a day and a half. Letters are case-sensitive, so M and m stay apart. The default letters above keep working as well, except where one of your own short forms uses the same letter: then your meaning wins. With the German letters, S means hours and s means seconds.

circle-info

A short form may be longer than one letter, for example Std, but it cannot contain numbers or spaces. Run /plobby reload on the lobby after editing; the proxy reads the file when it starts.

#MOTD

Both sides replace the motd with a separate one while a maintenance is running, and {timer} shows how much time is left. It sits in motd.maintenance next to the regular one. The regular motd, and the full list of options around it, is covered on the MOTD page.

#Player Count Message

With this option, you can show your own text in the server list where the player count usually is, for example <dark_red>Maintenance. With Use Timer Message on, a maintenance that has an end time shows the timer message instead, where {timer} is the time left. Turning it off keeps the regular player count.

Maintenance (Player Count Message)

#Player List Hover Message

With this option, you can replace the list of players shown when the player count is hovered. It works like the player count message, and <br> starts a new line.

Maintenance (Player List Hover Message)

circle-exclamation

On a lobby without a proxy, both messages need Paper or a fork of it.

#Maintenance Icon

With this option, you can swap the server icon for maintenance-icon.png while a maintenance is running. Put a 64x64 png with that name in the PhoenixLobby folder, next to the config, and reload. It is off by default, and when the file is missing the regular icon stays and the console warns once.

Maintenance (Maintenance Icon)

circle-info

On the proxy the same options live in its config.yml and maintenance.yml. Either way the running and scheduled maintenances are saved to disk, so they survive a restart.

circle-exclamation

As soon as the lobby is talking to a proxy, its own maintenance is ignored and the lobby command answers that the proxy is in charge. Start and end the maintenance on the proxy there, and use the lobby commands only on a standalone server.

#Commands

Every command needs phoenixlobby.maintenance. Which set you use depends on where the maintenance runs: the proxy commands take a server name, the lobby ones always act on the server they are run from.

Command Description
/maintenance start [time] Starts a maintenance
/maintenance end Ends the maintenance
/maintenance add <user/uuid> Allows someone to join
/maintenance remove <user/uuid> Revokes someone's access
/maintenance list Lists who is allowed to join
/maintenance schedule <start-in> <duration> Schedules a maintenance for later
/maintenance status Shows the current maintenance
Command Description
/maintenance start <server> [time] Starts a maintenance
/maintenance end <server> Ends a maintenance
/maintenance add <user/uuid> <server> Allows someone to join
/maintenance remove <user/uuid> <server> Revokes someone's access
/maintenance list <server> Lists who is allowed to join
/maintenance schedule <start-in> <duration> <server> Schedules a maintenance for later
/maintenance schedules Lists every scheduled maintenance

Leave the server empty or use global to affect every server at once.

Leaving the time empty makes the maintenance last until you end it yourself.

Times use the time format described above, so /maintenance start 1D12H closes the server for a day and a half.

circle-info

/maintenance add and /maintenance remove write to the same list as Whitelisted Players in the editor.

#Placeholders

These are PlaceholderAPI placeholders, so they work anywhere PlaceholderAPI is read, including the scoreboard, the tablist and holograms.

Every one of them takes a server name. Behind a proxy that is the backend's name, or global for the whole network. On a standalone lobby, use the name of that server.

circle-info

A proxy is not needed. The lobby answers these from its own Maintenance module whenever that module is enabled, and only falls back to asking the proxy when it is not.

#Is it closed

Placeholder Returns
%phoenixlobby_inmaintenance_<server>% true / false

#How long is left

Placeholder Returns
%phoenixlobby_maintenance_<server>% The remaining time, written out as 2Hours 15Minutes 3Seconds

When the maintenance has no end time this returns Forever, and when nothing is running it returns None. Both words come from your translations file, so they follow whatever language you have set.

The unit words, and whether they are written out, follow the time words you set. The _formatted_ placeholders below use the same singular and plural words.

#A single unit

Adding _raw_ or _formatted_ and a unit reports just that unit, which is what a countdown showing only minutes needs.

Placeholder Example result
%phoenixlobby_maintenance_<server>_raw_minutes% 135
%phoenixlobby_maintenance_<server>_formatted_minutes% 135 Minutes
%phoenixlobby_maintenance_<server>_raw_hours% 2
%phoenixlobby_maintenance_<server>_formatted_hours% 2 Hours

The unit is one of seconds, minutes, hours, days, weeks, months or years. The singular spelling works too, and the case does not matter.

The whole remaining time is converted into that one unit rather than split across several, so two hours and fifteen minutes reads as 135 in minutes and 2 in hours.

circle-info

With no end time, _raw_ returns -1 and _formatted_ returns Forever. Check that before showing a countdown.

The MOTD has its own separate set of maintenance placeholders, written with braces instead: see MOTD Placeholders.

My Cart
Spider

Your cart is empty

Looks like the spiders padded through here. Pick a plugin and it will show up here. Continue shopping