Minecraft-plugin Maintenance

🔌 About Maintenance

Maintenance is a Minecraft plugin that provides a full maintenance mode system for single servers and proxy networks. It blocks new joins while optionally keeping specific players allowed, updates the server list messages and playercount display during maintenance, and can synchronize maintenance state across multiple proxy instances.

🎯 Purpose

The plugin is intended for server administrators who need a controlled way to take a server or a set of proxied servers offline for updates, backups, or troubleshooting. It supports both local server maintenance behavior (kick/block joins, custom MOTD) and proxy-level maintenance workflows where proxied servers, waiting lobbies, and fallback targets are relevant.

⚙️ Features

• Enable/disable maintenance mode (global and per-proxied-server where applicable).
• Whitelist specific players by name or UUID to allow joining during maintenance.
• Customizable ping messages (MOTD) and optional playercount hover/message replacement while maintenance is active.
• Start/stop timers and scheduled maintenance (start timer, end timer, schedule with duration).
• Send notifications to configured players when someone attempts to join during maintenance.
• Optionally change the server icon during maintenance and run commands on enable/disable.
• Proxy support with MySQL-backed synchronization for multiple proxy instances (Bungee/Velocity variants).
• Integration behavior for ServerListPlus (toggles SLP state when maintenance is enabled/disabled).
• Optional ProtocolLib requirement on Paper to enable custom server-icon and playercount-message features.

🧩 Who It Is For

• Server owners and admins who need scheduled or immediate maintenance windows.
• Networks using BungeeCord/Velocity that require synchronized maintenance states across proxies.
• Paper servers that want enhanced MOTD/playercount features (requires ProtocolLib for some features).

🏗️ Example Use Cases

• Enable maintenance before deploying server updates and automatically kick non-whitelisted players.
• Schedule a maintenance start in 15 minutes and automatically disable it after 45 minutes.
• On proxies, send players to a waiting server or fallback lobby while a backend server is under maintenance.

⌨️ Commands

🔐 Permissions

⚙️ Installation

📥 Setup

• Download the plugin JAR and place it in your server plugins/ directory for the appropriate server type (Paper/Spigot or proxy).
• Restart the server and check the console to confirm the plugin loaded.

📦 Dependencies

• ProtocolLib (required for some Paper features: custom server icon and playercount-message functionality).
• ServerListPlus is supported for integration (optional; Maintenance will toggle SLP state when used together).

🧾 Configuration

• The plugin provides a YAML configuration with options to enable maintenance, define ping messages, playercount messages, waiting/fallback servers for proxies, timers, and MySQL connection settings for proxy synchronization.
• Language files are provided and most messages are editable; translations exist for multiple languages.

🧠 Technical Notes

• The plugin offers separate behavior for Paper/Spigot servers and for proxy deployments (BungeeCord/Velocity). MySQL-backed synchronization and proxied-server features are only available in the proxy builds.
• ProtocolLib is required on Paper to enable the custom server-icon and playercount-message features.
• ServerListPlus integration is supported and will be automatically toggled if present.

🤝 When This Plugin Is Useful

If you need a configurable maintenance mode for a single server or a proxied network with timers, whitelists, and custom MOTDs (plus optional icon/playercount customization on Paper), Maintenance provides those administrative controls in a single plugin.