Maintenance

About This Plugin

This plugin lets you activate a maintenance mode on your Paper, Velocity, Bungee, and Sponge server, which will prevent players without a permission to join the server.

This plugin uses MiniMessage as the component text format. LEGACY TEXT FORMATTING (§a/&a) IS NOT SUPPORTED

• Use https://webui.adventure.kyori.net/ to preview parsed components
• You can find full documentation on the format (including normal colors and formatting, rgb, click/hover events, and more) here: https://docs.adventure.kyori.net/minimessage/format

Its features include:

• A custom motd as well as server icon, that will be shown during maintenance
• Start- and endtimers, which will enable/disable maintenance mode after the time is up
• Schedule timers, which will enable maintenance, then disable it after a given amount of time
• A '%TIMER%' variable usable in the pingmessage, to show the time until a running endtimer finishes (other variables and tricks are explained in the configuration file's comments)
• A maintenance whitelist, to grant specific players the ability to join while you're working on your server
• Notifications when players try to join your server during maintenance
• Nearly all messages are editable via the language file, given in a multitude of different languages

Additional features on Velocity/Bungee:

• Only want to enable maintenance on a single server? You can also do so by using the /maintenance <on/off> <servername> command
• Link multiple proxy instances with a MySQL database connection, so you don't have to enable/disable maintenance on each proxy by hand
• Waiting servers during full proxy maintenance, as well as fallback servers to go to when a single proxied server is under maintenance
• Using ServerListPlus? Maintenance will toggle its status when enabling maintenance and reenable the SLP motd when disabling maintenance
• Want to have PlaceholderAPI placeholders on Paper? See here for more information on the MaintenanceAddon.

Want to know a secret? You can have text left of the server icon by just adding a lot of spaces to the playercountmessage, like so:

playercountmessage: "Maintenance                                                                    AAAA"

IMPORTANT: If using the plugin on a Paper server, the plugin ProtocolLib is required to use Maintenance to its full extend.

Issues/Support

Did you find a bug? Use the issue tracker Other questions or problems? Join the support Discord guild ✨

German Plugin Tutorial @YouTube

Commands

Arguments in < > are necessary, those in [ ] aren't (can be omitted).

• /maintenance <on/off> [server] will set the status of the maintenance mode
• /maintenance reload reloads the config and maintenance-icon file
• /maintenance <add/remove> <player/uuid> allows specific players to join on the server when maintenance is enabled
• /maintenance whitelist returns a list of all players on the
• maintenance whitelist
• /maintenance starttimer [server] <minutes> will enable maintenance mode after the time is up
• /maintenance endtimer [server] <minutes> will enable maintenance mode for the given time in minutes. After the time is up, it'll be disabled again
• /maintenance schedule [server] <minutes> <minutesToEnd> will enable maintenance mode after the given time, then disable it according to the second parameter
• /maintenance aborttimer cancels a running start-/endtimer
• /maintenance setmotd <index> <1/2> <message> sets a motd for maintenance mode
• /maintenance motd lists the currently set maintenance motds
• /maintenance update remotely downloads the newest version of the plugin onto your server
• /maintenance dump dumps some server information, used for bug reports

Permissions

• maintenance.admin - super permission, that grants access to all perms below
• maintenance.bypass - join the server during maintenance
• maintenance.command - use the "/maintenance" command (also required to use the subcommands)
• maintenance.toggle - use the "/maintenance <on/off>" commands
• maintenance.reload - use the "/maintenance reload" command
• maintenance.update - use the "/maintenance <update/forceupdate>" commands
• maintenance.timer - use the "/maintenance <starttimer/endtimer> <minutes>" and "/maintenance timer abort" commands
• maintenance.whitelist.add - use the "/maintenance add <player>" command
• maintenance.whitelist.remove - use the "/maintenance remove <player>" command
• maintenance.whitelist.list - use the "/maintenance whitelist" command
• maintenance.setmotd - use the "/maintenance setmotd <index> <1/2> <message>" command
• maintenance.motd - use the "/maintenance motd" command
• maintenance.dump - use the "/maintenance dump" command
• maintenance.joinnotification - if enabled: sends a notification to you if a player tries to join the server while maintenance is enabled

Extra permissions for the Velocity/Bungee part:

• maintenance.singleserver.bypass.<server> - join the proxied server during maintenance
• maintenance.singleserver.toggle - use the "/maintenance <on/off> <server>" commands
• maintenance.singleserver.timer - use the "/maintenance <starttimer/endtimer> <server> <minutes>" and "/maintenance timer abort <server>" commands
• maintenance.singleserver.status - use the "/maintenance status" command