Maintenance Plugin do Minecraft 1.20.1, 1.21.1

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. If you're running Velocity or Bungee, only put Maintenance on the proxy, not the backend servers.

Maintenance 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

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 (accepts a duration format like 1h5m30s, 5m, or 90s)
• 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

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 Spigot server, the plugin ProtocolLib is required to use Maintenance to its full extent.

Issues/Support

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

German Plugin Tutorial\ @YouTube

Localization

If you want to join the localization crew, join the Discord 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 (accepts h/m/s durations, e.g. 1h5m30s or 90s)
• /maintenance endtimer \[server\] will enable maintenance mode for the given time (accepts h/m/s durations, e.g. 1h5m30s or 90s). 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 (accepts h/m/s durations, e.g. 1h5m30s or 90s)
• /maintenance aborttimer cancels a running start-/endtimer
• /maintenance setmotd 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 " 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 Maintenance on Spigot (ew) or a Paper version below 1.12.2 (also ew), you need to have ProtocolLib installed to use the custom server-icon and the playercount-messages! The rest however is also accessible without it.

proxied-maintenance-servers, fallback and mysql section are only for the Velocity/Bungee version.

Changes the language of command feedback/messages.

If you find missing translations or want to contribute, see https://crowdin.com/project/maintenance

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), da (Danish), ko (Korean), hu (Hungarian), vi (Vietnamese)

language: en

Enables maintenance mode.

maintenance-enabled: false

Enables maintenance on certain servers managed by your proxy instance(s).

proxied-maintenance-servers:

• PaperServer1

- 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 (MOTD) 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 ping message.

ping-message: enabled: true messages:

• "Currently under maintenance

We will be back soon!"

If set to true and an endtimer is currently running, a message 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-timer-specific-messages: true timer-messages:

• "Currently under maintenance

Come back in: %TIMER%"

If enabled, the message below will be shown in the top right corner of the server in the server list, where the player count would normally be displayed.

You can use '%ONLINE%' and '%MAX%' if you want to include the player count in a custom message (e.g. "Maintenance %ONLINE%/%MAX%").

DOES NOT SUPPORT RGB!

player-count-message: enabled: true message: "Maintenance"

If set to true and an endtimer is currently running, the timer message will be used instead of the normal one.

enable-timer-specific-message: false timer-message: "Come back in: %TIMER%"

Is shown when you move your mouse above the text in the top right corner of the server in the server list, where the player count would normally be displayed.

DOES NOT SUPPORT RGB!

player-list-hover-message: enabled: true message: "Currently under maintenance"

If set to true and an endtimer is currently running, the timer message will be used instead of the normal one.

enable-timer-specific-message: false timer-message: "Come back in: %TIMER%"

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: []

Any extra commands inside the "all" array will be executed when maintenance is enabled/disabled on a proxied server.

You can also add commands for specific servers by adding a new array with the server name as key.

In the commands, you can use the %SERVER% placeholder to get the server name.

Example: coolserver: ["say hello", "othercommand %SERVER%"]

commands-on-single-maintenance-enable: all: [] commands-on-single-maintenance-disable: all: []

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).

kick-online-players: true

When fetched player does not exist then fallback to offline uuid. Only works on proxies like Velocity or BungeeCord

fallback-to-offline-uuid: false

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 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