Overview
The Maintenance plugin allows you to customize messages displayed in the server list (MOTD), player count area, and hover text when maintenance mode is enabled. All messages support MiniMessage formatting.
Ping Message (MOTD)
The ping message is displayed in the server list as the Message of the Day (MOTD) when maintenance is enabled.
Enables custom ping messages during maintenance.
List of messages to display. If multiple entries are provided, one will be chosen randomly on every ping.ping-message:
enabled: true
messages:
- "<red>Currently under maintenance<br><gradient:#fbffc2:#0fffff>We will be back soon!"
- "<gold>Server offline<br><yellow>Please check back later"
ping-message.enable-timer-specific-messages
If enabled and an endtimer is running, messages from timer-messages will be used instead of regular messages.
ping-message.timer-messages
Messages displayed when an endtimer is active. Use %TIMER% to show the remaining time.ping-message:
enable-timer-specific-messages: true
timer-messages:
- "<red>Currently under maintenance<br><gradient:#fbffc2:#fffff>Come back in:</gradient> <color:#aa55ee>%TIMER%"
# Simple colored message with line break
- "<red>Currently under maintenance<br><yellow>We will be back soon!"
# Gradient effect
- "<gradient:#ff0000:#0000ff>Maintenance in progress</gradient><br><white>Please wait"
# Bold and italic
- "<bold><red>OFFLINE</red></bold><br><italic><gray>Scheduled maintenance</italic>"
# Rainbow effect
- "<rainbow>Server is being updated!</rainbow><br><green>Check Discord for updates"
# Combination with timer
- "<dark_red>Maintenance Mode<br><gradient:#ffaa00:#ff5555>Back online in: %TIMER%</gradient>"
Player Count Message
This message appears in the top-right corner of the server listing where the player count is normally displayed.
Player count messages do NOT support RGB colors due to Minecraft protocol limitations. Use named colors only (e.g., <red>, <dark_red>, <yellow>).
player-count-message.enabled
Enables custom player count messages during maintenance.
player-count-message.message
string
default:"<dark_red>Maintenance"
The message to display. Use %ONLINE% and %MAX% to include actual player counts.player-count-message:
enabled: true
message: "<dark_red>Maintenance"
# OR with player count
message: "<red>Maintenance %ONLINE%/%MAX%"
player-count-message.enable-timer-specific-message
If enabled and an endtimer is running, the timer message will be used instead of the normal message.
player-count-message.timer-message
string
default:"<dark_red>Come back in: <yellow>%TIMER%"
Message displayed when an endtimer is active.player-count-message:
enable-timer-specific-message: true
timer-message: "<dark_red>Come back in: <yellow>%TIMER%"
Player List Hover Message
This message appears when you hover your mouse over the player count area in the server list.
Player list hover messages do NOT support RGB colors due to Minecraft protocol limitations. Use named colors only.
player-list-hover-message.enabled
Enables custom hover messages during maintenance.
player-list-hover-message.message
The message to display on hover. Use <br> for line breaks.player-list-hover-message:
enabled: true
message: "<red>Currently under<br><red>maintenance"
player-list-hover-message.enable-timer-specific-message
If enabled and an endtimer is running, the timer message will be used instead.
player-list-hover-message.timer-message
Message displayed on hover when an endtimer is active.player-list-hover-message:
enable-timer-specific-message: true
timer-message: "<red>Come back in:<br><yellow>%TIMER%"
Available Variables
You can use these variables in your messages:
| Variable | Description | Available In |
|---|
%TIMER% | Shows the remaining time when an endtimer is running | All message types |
%ONLINE% | Shows the current number of online players | player-count-message only |
%MAX% | Shows the maximum number of players | player-count-message only |
Complete Example
Here’s a complete configuration example with all message types:
ping-message:
enabled: true
messages:
- "<red>Currently under maintenance<br><gradient:#fbffc2:#0fffff>We will be back soon!"
- "<dark_red>Server Offline<br><yellow>Scheduled maintenance in progress"
enable-timer-specific-messages: true
timer-messages:
- "<red>Currently under maintenance<br><gradient:#fbffc2:#fffff>Come back in:</gradient> <color:#aa55ee>%TIMER%"
player-count-message:
enabled: true
message: "<dark_red>Maintenance"
enable-timer-specific-message: true
timer-message: "<dark_red>Back in: <yellow>%TIMER%"
player-list-hover-message:
enabled: true
message: "<red>Currently under<br><red>maintenance"
enable-timer-specific-message: true
timer-message: "<red>Come back in:<br><yellow>%TIMER%"
Testing Your Messages
Use the MiniMessage Web UI to create and preview your formatted messages before adding them to the configuration.
After updating your messages, reload the configuration: