## 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.** ![https://i.imgur.com/kjrgLUm.png](https://i.imgur.com/kjrgLUm.png) Maintenance uses MiniMessage as the component text format. **LEGACY TEXT FORMATTING (§a/&a) IS NOT SUPPORTED** * Use [https://webui.adventure.kyori.net/](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](https://docs.adventure.kyori.net/minimessage/format) ## Features 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 ` 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 * Want to have PlaceholderAPI placeholders on Paper? Get the **[MaintenanceAddon](https://hangar.papermc.io/kennytv/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: ```yaml playercountmessage: "Maintenance AAAA" ``` ![https://i.imgur.com/0lh0Hwv.png](https://i.imgur.com/0lh0Hwv.png)

IMPORTANT: If using the plugin on a Spigot server, the plugin **[ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/)** is required to use Maintenance to its full extent. ## Issues/Support Did you find a bug? Use the [**issue tracker**](https://github.com/kennytv/maintenance/issues) Other questions or problems? [Join the support Discord guild](https://discord.gg/vgcuzhq) ✨ German Plugin Tutorial\ @[YouTube](https://youtu.be/xZpAVIeGhjM) ## Localization If you want to join the localization crew, join [the Discord](https://discord.gg/vgcuzhq) to get the proofreader or translator role on Crodwin. All translations are done here: https://crowdin.com/project/maintenance ## Commands *Arguments in < > are necessary, those in \[ \] aren't (can be omitted).* * **/maintenance \[server\]** will set the status of the maintenance mode * **/maintenance reload** reloads the config and maintenance-icon file * **/maintenance ** 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\] ** will enable maintenance mode after the time is up * **/maintenance endtimer \[server\] ** will enable maintenance mode for the given time in minutes. After the time is up, it'll be disabled again * **/maintenance schedule \[server\] ** 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 <1/2> ** 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 " commands * **maintenance.reload** - use the "/maintenance reload" command * **maintenance.update** - use the "/maintenance " commands * **maintenance.timer** - use the "/maintenance " and "/maintenance timer abort" commands * **maintenance.whitelist.add** - use the "/maintenance add " command * **maintenance.whitelist.remove** - use the "/maintenance remove " command * **maintenance.whitelist.list** - use the "/maintenance whitelist" command * **maintenance.setmotd** - use the "/maintenance setmotd <1/2> " 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.\** - join the proxied server during maintenance * **maintenance.singleserver.toggle** - use the "/maintenance " commands * **maintenance.singleserver.timer** - use the "/maintenance " and "/maintenance timer abort " commands * **maintenance.singleserver.status** - use the "/maintenance status" command IMPORTANT - If you are using the plugin on your proxyserver: You have to have these permissions on the proxy, not on the backend servers! The best way of doing this is using a proper permissions plugin on the proxy (for example LuckPerms). ## Configuration If you are using *the Paper version of the plugin*, you have to have [**ProtocolLib**](https://www.spigotmc.org/resources/protocollib.1997/) installed to use the custom server-icon and the playercount-messages (that, or you have Paper running on 1.12.2 or higher)! The rest however is also accessible without it. For the Velocity/Bungee version you don't need to have any other plugins installed. *proxied-maintenance-servers*, *fallback* and *mysql* section are only for the Velocity/Bungee version. ```YAML # Enables maintenance mode. maintenance-enabled: false # Enables maintenance on certain servers managed by your proxy instance(s). proxied-maintenance-servers: - SpigotServer1 # - AnotherServer # If maintenance is enabled on a proxied server with players on it, they will be sent to the fallback server instead of being kicked off the network. # If the fallback server is not reachable/not set, they will just be kicked off the network. # This can also be set to an array to set multiple fallback servers, in case one server is not always reachable: 'fallback: [s1, s2, s3, ...]' fallback: lobby # If maintenance is enabled globally, you can define a "waiting" lobby for players to be sent to instead of being kicked. # Leave this empty to disable. waiting-server: "" # The message shown in the multiplayer server list motd when maintenance is enabled. # If you put in multiple entries, one of them will be chosen randomly on every ping. # If running an endtimer, the time left can be displayed by including '%TIMER%' in a pingmessage (also works in playercount(-hover) message). pingmessages: - "Currently under maintenance
We will be back soon!" # - "Other entry" enable-pingmessages: true # Any extra commands inside the arrays will be executed when maintenance is enabled/disabled. # Example: commands-on-maintenance-enable: ["say hello!", "stop"] commands-on-maintenance-enable: [] commands-on-maintenance-disable: [] # If set to true and an endtimer is currently running, a pingmessage from this pool will be chosen # instead of the ones above, so you can have different messages for when an endtimer is running/not running. enable-timerspecific-messages: true timerspecific-pingmessages: - "Currently under maintenance
Come back in: %TIMER%" # - "Other entry" # If set to true, the message below will be shown in the top right corner of the server in the serverlist, where the playercount would normally be displayed. # If set to false, the normal playercount will be shown. # # Alternatively you can use '%ONLINE%' and '%MAX%' if you want to include the playercount in a custom message (e.g. "Maintenance %ONLINE%/%MAX%"). # DOES NOT SUPPORT RGB! enable-playercountmessage: true playercountmessage: "Maintenance" # Is shown when you move your mouse above the text in the top right corner of the server in the serverlist, # where the playercount would normally be displayed. # DOES NOT SUPPORT RGB! enable-playercounthovermessage: true playercounthovermessage: "Currently under
maintenance" # If set to true, the server icon will be changed to the 'maintenance-icon.png' file in the plugin's folder during maintenance. custom-maintenance-icon: false # If set to true, players with the 'maintenance.joinnotification' permission will receive a message, # that a player tried to join the server while maintenance is enabled. send-join-notification: false # Set this to false if you do not want players to be kicked when you enable maintenance (new connections will still be blocked). # ... I don't know why you would want that, but you can disable it. :p kick-online-players: true # Changes the language of command feedback/messages. # If you find missing translations or want to contribute a new language file, you are very welcome to message me on Spigot or my Discord server! :) # Currently available are: en (English), de (German), fr (French), pt (Portuguese), es (Spanish), ru (Russian), zh (Chinese), it (Italian), pl (Polish), tr (Turkish), sv (Swedish), uk (Ukrainian), ja (Japanese) language: en # If you have 2 or more proxy instances, the database connection will make sure all proxies # have the same maintenance status, so you won't have to enable/disable it on every proxy by hand. mysql: use-mysql: false host: host port: 3306 database: database username: username password: password # Requests to the database will only be made at least x seconds after the last request, # so there won't be a request on every single ping on a server with many players. # # Set this to 0 to make a database request on (almost) every single ping. # (0 is not recommended if having more than a hundred concurrent players, then I'd recommend keeping it from 10-60). update-interval: 15 # If you for some reason cannot establish SSL connections to your database, you may disable it here (not recommended). use-ssl: true # If enabled and the server is restarted while running an endtimer, the timer will be continued after the restart. # If the timer ends while the server is offline, maintenance will be disabled as soon as the server starts again. continue-endtimer-after-restart: enabled: false # This value is set everytime an endtimer is started, cancelled or ended. # Do not manually change this value. end: 0 # If using the timer command: In what intervalls before enabling/disabling maintenance there will be a broadcast. timer-broadcast-for-seconds: [1200, 900, 600, 300, 120, 60, 30, 20, 10, 5, 4, 3, 2, 1] # If disabled, you will no longer receive any messages if there is an update. # Not recommended to disable, as new versions generally tend to run better and with fewer bugs. # However, you can always check for updates manually using the '/maintenance update' command. update-checks: true # Used for autoupdating the config, do not change this value. config-version: 7 ```

Language file

```yaml #You can use https://webui.adventure.kyori.net/ to edit and preview the formatted text #For a full list of formats and fancy examples, see https://docs.adventure.kyori.net/minimessage/format.html #Messages containing the placeholder "" will have it replaced with the following string prefix: "[Maintenance] " noPermission: "You do not have the permission to execute that command." kickmessage: "The server is currently under maintenance!
Try again later!" maintenanceActivated: "Maintenance mode is now activated." maintenanceDeactivated: "Maintenance mode is now deactivated." alreadyEnabled: "Maintenance is already enabled!" alreadyDisabled: "Maintenance is already disabled!" endtimerBroadcast: "Maintenance mode will be disabled in %TIME%." endtimerStarted: "Started timer: Maintenance mode will be deactivated in %TIME%." starttimerBroadcast: "Maintenance mode will be enabled in %TIME%." starttimerStarted: "Started timer: Maintenance mode will be activated in %TIME%." scheduletimerBroadcast: "Maintenance mode will be enabled in %TIME% and will last for %DURATION%." timerAlreadyRunning: "There is already a timer scheduled!" timerNotRunning: "There is currently no running timer." timerCancelled: "The current timer has been disabled." timerTooLong: "The number has to be less than 40320 (28 days)!" timerMotdDisabled: "You have to set 'enable-timerspecific-messages' in the config to 'true', if you want to use/edit timerspecific motds." motdTimer: "%HOURS%:%MINUTES%:%SECONDS%" motdTimerNotRunning: "-" joinNotification: "%PLAYER% tried to join the server." motdList: "List of your maintenance motds:" motdListEmpty: "You don't have any maintenance motds set!" reload: "Reloaded config, whitelistedplayers, language file and the maintenance icon." removedMotd: "Removed motd number %INDEX%." removeMotdError: "You only have one motd, so you cannot remove any!" setMotd: "Set line %LINE% of the %INDEX%. maintenance motd to %MOTD%" setMotdIndexError: "You currently have %MOTDS% motds, so you have to pick a number between 1 and %NEWAMOUNT%." setMotdLineError: "The second argument has to be the line number (1 or 2)!" updateDownloading: "Downloading update..." updateFailed: "Update failed!" updateFinished: "The update was successful! To prevent issues with tasks and to complete the update, you have to restart the server!" whitelistedPlayers: "Whitelisted players for maintenance:" whitelistedPlayersFormat: "- %NAME% (%UUID%)" whitelistAdded: "Added %PLAYER% to the maintenance whitelist!" whitelistAlreadyAdded: "%PLAYER% already is in the maintenance whitelist!" whitelistRemoved: "Removed %PLAYER% from the maintenance whitelist!" whitelistNotFound: "This player is not in the maintenance whitelist!" whitelistEmpty: "The maintenance whitelist is empty! Use /maintenance add to add someone!" playerNotFound: "No player with this name has played on this server before." playerNotFoundUuid: "No player with that uuid could be found." playerNotOnline: "There is no player online with that name." invalidUuid: "Invalid uuid format!" # Messages for the Bungee/Velocity part, you can ignore them if you use the plugin on Spigot/Sponge sentToWaitingServer: "You have been sent to a waiting server!" forceWaitingServer: "You cannot leave the waiting server while maintenance is enabled!" serverNotFound: "No server with this name is registered on the proxy!" singleTimerAlreadyRunning: "There is already a timer scheduled for that server!" singleTimerCancelled: "The current timer for server %SERVER% has been disabled." singleTimerNotRunning: "There is currently no running timer for that server." singleEndtimerBroadcast: "Maintenance mode on server %SERVER% will be disabled in %TIME%." singleStarttimerBroadcast: "Maintenance mode on server %SERVER% will be enabled in %TIME%." singleScheduletimerBroadcast: "Maintenance mode on server %SERVER% will be enabled in %TIME% and will last for %DURATION%." singleMaintenanceKick: "The server %SERVER% is currently under maintenance! Try again later!" singleMaintenanceKickComplete: "The server %SERVER% is under maintenance!
You may try to rejoin to go onto another server!" singleMaintenanceActivated: "Maintenance mode is now activated on server %SERVER%." singleMaintenanceDeactivated: "Maintenance mode is now deactivated on server %SERVER%." singleServerAlreadyEnabled: "Maintenance is already enabled on server %SERVER%!" singleServerAlreadyDisabled: "Maintenance is already disabled on server %SERVER%!" singleServerMaintenanceList: "Proxied servers, that have maintenance enabled:" singleServerMaintenanceListEmpty: "There are no proxied servers that are under maintenance." singleServerMaintenanceListEntry: "- %SERVER%" second: "second" seconds: "seconds" minute: "minute" minutes: "minutes" hour: "hour" hours: "hours" helpHeader: "========[ %NAME% | %PAGE%/%MAX% ]========" helpPageNotFound: "There is no page with that number!" helpNextPage: "Use /maintenance help %PAGE% to get to the next help window." helpAbortTimer: "/maintenance aborttimer (If running, the current timer will be aborted)" helpEndtimer: "/maintenance endtimer (After the given time in minutes, maintenance mode will be disabled)" helpStarttimer: "/maintenance starttimer (After the given time in minutes, maintenance mode will be enabled)" helpScheduleTimer: "/maintenance scheduletimer (After the given time in minutes, maintenance mode will be enabled for the given duration in minutes)" helpDebug: "/maintenance debug (Enables some debug logging)" helpDump: "/maintenance dump (Dumps some server information, used for bug reports)" helpHelp: "/maintenance help [page] (Shows this beautiful help window)" helpMotd: "/maintenance motd [timer] (Lists the currently set maintenance motds. If specifying 'timer', the timer motds are shown)" helpRemoveMotd: "/maintenance removemotd [timer] (Removes a maintenance motd. If using 'timer' as an argument, a timerspecific pingmessage will be removed)" helpSetMotd: "/maintenance setmotd [timer] <1/2> (Sets a motd for maintenance mode. If using 'timer' as an argument, a timerspecific pingmessage will be set)" helpReload: "/maintenance reload (Reloads the config file, whitelist file and the server-icon)" helpToggle: "/maintenance (Enables/disables maintenance mode)" helpUpdate: "/maintenance update (Remotely downloads the newest version of the plugin onto your server)" helpWhitelist: "/maintenance whitelist (Shows all whitelisted players for the maintenance mode)" helpWhitelistAdd: "/maintenance add (Adds the player to the maintenance whitelist, so they can join the server even though maintenance is enabled)" helpWhitelistRemove: "/maintenance remove (Removes the player from the maintenance whitelist)" # Messages for the Bungee/Velocity part, you can ignore them if you use the plugin on Spigot/Sponge helpAbortSingleTimer: "/maintenance aborttimer [server] (If running, the current timer will be aborted)" helpSingleEndtimer: "/maintenance endtimer [server] (After the given time in minutes, maintenance mode will be disabled)" helpSingleStarttimer: "/maintenance starttimer [server] (After the given time in minutes, maintenance mode will be enabled)" helpSingleScheduleTimer: "/maintenance scheduletimer [server] (After the given time in minutes, maintenance mode will be enabled for the given duration in minutes)" helpSingleToggle: "/maintenance [server] (Enables/disables maintenance mode)" helpStatus: "/maintenance status (Lists all proxied servers, that are currently under maintenance)" # Used for autoupdating the language file, do not change this value. language-version: 1 ```

## MySQL/Multi-Proxy Support *Only available in the Bungee/Velocity version!* By enabling MySQL in the config, you can even connect multiple proxy-servers to a set value in your database, so you won't have to enable/disable maintenance on each proxy by hand!

Maintenance

4.2.0

4.1.0

4.0.1

Channels

Platforms