Maintenance Mode - AkselGlyholt/velocity-limbo-handler GitHub Wiki

🛠 Maintenance Mode

VelocityLimboHandler includes built-in support for handling backend servers that are under maintenance. This prevents players from endlessly retrying to reconnect to a server that’s intentionally offline.

When maintenance is active for a server, its queue is paused — no reconnect attempts will be made until the server is marked as available again.

🔍 What Is Maintenance Mode?

Maintenance mode tells the plugin:

"Don't try to reconnect anyone to this server right now — it’s down on purpose."

This prevents:

  • Console spam from repeated failed attempts
  • Confusing behavior for players stuck in Limbo
  • Resource waste from checking servers that shouldn’t be touched

✅ How It Works

  • Each backend queue pauses automatically when maintenance is detected
  • Reconnection attempts are skipped for that server
  • Players stay in Limbo, keep their queue position, and resume reconnecting when the server is back

🤝 Plugin Compatibility

VelocityLimboHandler is designed to optionally integrate with [KennyTV’s Maintenance plugin](https://hangar.papermc.io/KennyTV/Maintenance).

If the Maintenance plugin is installed:

  • The plugin detects when a backend server is under maintenance using reflection
  • No hard dependency — it won’t crash if the plugin is missing

If you don’t use the Maintenance plugin:

  • You can manually shut down a backend, and as long as it's unreachable, the reconnect attempts will continue
  • However, it won’t suppress queue processing unless the server is marked as "under maintenance"

⚠️ Important Notes

  • Maintenance mode affects each server independently
  • You don't need to change anything in config.yml — detection is automatic
  • If you remove KennyTV’s plugin, VelocityLimboHandler will simply resume reconnecting based on server reachability

💡 Use Cases

  • Doing updates on your prison server? Put it in maintenance mode — players stay in Limbo until it’s back.
  • Restarting a backend without warning? Players get queued, and reconnects are retried normally.
  • Want to block reconnects completely during maintenance? Enable KennyTV’s plugin and let LimboHandler do the rest.