Maintenance | Bungee AND Spigot support! [1.8-1.17] 3.0.7

Lets you activate a maintenance mode on your BungeeCord as well as Spigot server!

  1. kennytv
    Tested Minecraft Versions:
    • 1.8
    • 1.9
    • 1.10
    • 1.11
    • 1.12
    • 1.13
    • 1.14
    • 1.15
    • 1.16
    • 1.17
    Source Code:
    https://github.com/kennytv/Maintenance
    Languages Supported:
    English, German, French, Portuguese, Spanish, Russian, Italian, Chinese
    generatedtext.png
    This plugin lets you activate a maintenance mode on your
    BungeeCord as well as Spigot server, which will prevent players without a permission to join the server.

    Whatever version you want to use, just place the plugin inside your plugin folder of your server running Spigot or BungeeCord!


    Screenshot_1.jpg

    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 Bungee:
    • Only want to enable maintenance on a single server? You can also do so by using the `/maintenance <on/off> <servername>` 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
    • Using ServerListPlus? Maintenance will toggle its status when enabling maintenance and reenable the SLP motd when disabling maintenance
    • Want to have PlaceholderAPI placeholders on Spigot? See here for more information on the MaintenanceAddon.

    IMPORTANT: If using the plugin on a Spigot server, the plugin ProtocolLib is required to use Maintenance to its full extend.


    generatedtext (1).png

    Did you find a bug? Use the issue tracker
    Other questions or problems? Click the wonderful icon below ✨


    ba74954dde74ff40a32ff58069e78c36.png


    German Plugin Tutorial

    generatedtext (1).png

    Arguments in < > are necessary, those in [ ] aren't (can be omitted).
    • /maintenance <on/off> [server] will set the status of the maintenance mode
    • /maintenance reload reloads the config and maintenance-icon file
    • /maintenance <add/remove> <player/uuid> 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] <minutes> will enable maintenance mode after the time is up
    • /maintenance endtimer [server] <minutes> will enable maintenance mode for the given time in minutes. After the time is up, it'll be disabled again
    • /maintenance schedule [server] <minutes> <minutesToEnd> 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 <index> <1/2> <message> 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

    generatedtext (2).png

    • 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 <on/off>" commands
    • maintenance.reload - use the "/maintenance reload" command
    • maintenance.update - use the "/maintenance <update/forceupdate>" commands
    • maintenance.timer - use the "/maintenance <starttimer/endtimer> <minutes>" and "/maintenance timer abort" commands
    • maintenance.whitelist.add - use the "/maintenance add <player>" command
    • maintenance.whitelist.remove - use the "/maintenance remove <player>" command
    • maintenance.whitelist.list - use the "/maintenance whitelist" command
    • maintenance.setmotd - use the "/maintenance setmotd <index> <1/2> <message>" 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 Bungee part:
    • maintenance.singleserver.bypass.<server> - join the proxied server during maintenance
    • maintenance.singleserver.toggle - use the "/maintenance <on/off> <server>" commands
    • maintenance.singleserver.timer - use the "/maintenance <starttimer/endtimer> <server> <minutes>" and "/maintenance timer abort <server>" 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 Spigot servers! This can be done by putting them into the Bungee config.yml as seen here:
    ciwvo.png
    This or you have a permissions plugin, which also works across the Proxy/Bungee (for example LuckPerms).
    If you use it on a Spigot server, normal permission plugins should work (as well as being an operator).

    generatedtext (4).png

    If you are using the Spigot version of the plugin, you have to have ProtocolLib 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 Bungee version you don't need to have any other plugins installed.

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

    Code (Text):
    # Enables maintenance mode.
    maintenance-enabled: false

    # Enables maintenance on certain servers managed by your Bungee 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:
      - "&cMaintenance mode!%NEWLINE%&6We 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: false
    timerspecific-pingmessages:
      - "&cMaintenance mode!%NEWLINE%&6We will be back in %TIMER%!"
    # - "Other entry"

    # If set to true, the message below will be shown at 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. "&cMaintenance &7%ONLINE%&8/&7%MAX%").
    enable-playercountmessage: true
    playercountmessage: "&4Maintenance"

    # Is shown when you move your mouse above the text at the top right corner of the server in the serverlist,
    # where the playercount would normally be displayed.
    playercounthovermessage: "&cCurrently under%NEWLINE%&cmaintenance"

    # 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)
    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 less 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: 5
     
    Code (Text):
    noPermission: "&cYou do not have the permission to execute that command."
    kickmessage: "&cThe server is currently under maintenance!%NEWLINE%&cTry again later!"
    maintenanceActivated: "&8[&eMaintenance&8] &6Maintenance mode is now activated."
    maintenanceDeactivated: "&8[&eMaintenance&8] &6Maintenance mode is now deactivated."
    alreadyEnabled: "&8[&eMaintenance&8] &cMaintenance is already enabled!"
    alreadyDisabled: "&8[&eMaintenance&8] &cMaintenance is already disabled!"
    endtimerBroadcast: "&8[&eMaintenance&8] &7Maintenance mode will be disabled in &6%TIME%&7."
    endtimerStarted: "&8[&eMaintenance&8] &aStarted timer: &7Maintenance mode will be deactivated in &6%TIME%&7."
    starttimerBroadcast: "&8[&eMaintenance&8] &7Maintenance mode will be enabled in &6%TIME%&7."
    starttimerStarted: "&8[&eMaintenance&8] &aStarted timer: &7Maintenance mode will be activated in &6%TIME%&7."
    scheduletimerBroadcast: "&8[&eMaintenance&8] &7Maintenance mode will be enabled in &6%TIME% &7and will last for &6%DURATION%&7."
    timerAlreadyRunning: "&8[&eMaintenance&8] &cThere is already a timer scheduled!"
    timerNotRunning: "&8[&eMaintenance&8] &cThere is currently no running timer."
    timerCancelled: "&8[&eMaintenance&8] &cThe current timer has been disabled."
    timerTooLong: "&8[&eMaintenance&8] &cThe number has to be less than 40320 (28 days)!"
    timerMotdDisabled: "&8[&eMaintenance&8] &cYou 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: "&8[&eMaintenance&8] &e%PLAYER% &ctried to join the server."
    motdList: "&8[&eMaintenance&8] &7List of your maintenance motds:"
    motdListEmpty: "8[&eMaintenance&8] &cYou don't have any maintenance motds set!"
    reload: "&8[&eMaintenance&8] &aReloaded config, whitelistedplayers, language file and the maintenance icon."
    removedMotd: "&8[&eMaintenance&8] &aRemoved motd number %INDEX%."
    removeMotdError: "&8[&eMaintenance&8] &cYou only have one motd, so you cannot remove any!"
    setMotd: "&8[&eMaintenance&8] &aSet line %LINE% of the %INDEX%. maintenance motd to %MOTD%"
    setMotdIndexError: "&8[&eMaintenance&8] &cYou currently have %MOTDS% motds, so you have to pick a number between 1 and %NEWAMOUNT%."
    setMotdLineError: "&8[&eMaintenance&8] &cThe second argument has to be the line number (1 or 2)!"
    updateDownloading: "&8[&eMaintenance&8] &c&lDownloading update..."
    updateFailed: "&8[&eMaintenance&8] &4&lUpdate failed!"
    updateFinished: "&8[&eMaintenance&8] &a&lThe update was successful! To prevent issues with tasks and to complete the update, you have to restart the server!"
    whitelistedPlayers: "&8[&eMaintenance&8] &6Whitelisted players for maintenance:"
    whitelistedPlayersFormat: "&8- &e%NAME% &8(&7%UUID%&8)"
    whitelistAdded: "&8[&eMaintenance&8] &aAdded &b%PLAYER% &ato the maintenance whitelist!"
    whitelistAlreadyAdded: "&8[&eMaintenance&8] &b%PLAYER% &calready is in the maintenance whitelist!"
    whitelistRemoved: "&8[&eMaintenance&8] &aRemoved &b%PLAYER% &afrom the maintenance whitelist!"
    whitelistNotFound: "&8[&eMaintenance&8] &cThis player is not in the maintenance whitelist!"
    whitelistEmpty: "&8[&eMaintenance&8] &cThe maintenance whitelist is empty! Use &e/maintenance add <player/uuid> &cto add someone!"
    playerNotFound: "&8[&eMaintenance&8] &cNo player with this name has played on this server before."
    playerNotFoundUuid: "&8[&eMaintenance&8] &cNo player with that uuid could be found."
    playerNotOnline: "&8[&eMaintenance&8] &cThere is no player online with that name."
    invalidUuid: "&8[&eMaintenance&8] &cInvalid uuid format!"

    # Messages for the Bungee/Velocity part, just can ignore them if you use the plugin on Spigot/Sponge
    sentToWaitingServer: "&8[&eMaintenance&8] &cYou have been sent to a waiting server!"
    forceWaitingServer: "&8[&eMaintenance&8] &cYou cannot leave the waiting server while maintenance is enabled!"
    serverNotFound: "&8[&eMaintenance&8] &cNo server with this name is registered on the proxy!"

    singleTimerAlreadyRunning: "&8[&eMaintenance&8] &cThere is already a timer scheduled for that server!"
    singleTimerCancelled: "&8[&eMaintenance&8] &cThe current timer for server &e%SERVER% &chas been disabled."
    singleTimerNotRunning: "&8[&eMaintenance&8] &cThere is currently no running timer for that server."
    singleEndtimerBroadcast: "&8[&eMaintenance&8] &7Maintenance mode on server %SERVER% will be disabled in &6%TIME%&7."
    singleStarttimerBroadcast: "&8[&eMaintenance&8] &7Maintenance mode on server %SERVER% will be enabled in &6%TIME%&7."
    singleScheduletimerBroadcast: "&8[&eMaintenance&8] &7Maintenance mode on server %SERVER% will be enabled in &6%TIME% &7and will last for &6%DURATION%&7."
    singleMaintenanceKick: "&8[&eMaintenance&8] &cThe server %SERVER% is currently under maintenance! Try again later!"
    singleMaintenanceKickComplete: "&cThe server %SERVER% is under maintenance!%NEWLINE%&cYou may try to rejoin to go onto another server!"
    singleMaintenanceActivated: "&8[&eMaintenance&8] &6Maintenance mode is now activated on server &e%SERVER%&6."
    singleMaintenanceDeactivated: "&8[&eMaintenance&8] &6Maintenance mode is now deactivated on server &e%SERVER%&6."
    singleServerAlreadyEnabled: "&8[&eMaintenance&8] &cMaintenance is already enabled on server &e%SERVER%&c!"
    singleServerAlreadyDisabled: "&8[&eMaintenance&8] &cMaintenance is already disabled on server &e%SERVER%&c!"
    singleServerMaintenanceList: "&8[&eMaintenance&8] &7Proxied servers, that have maintenance enabled:"
    singleServerMaintenanceListEmpty: "&8[&eMaintenance&8] &7There are no proxied servers that are under maintenance."

    second: "second"
    seconds: "seconds"
    minute: "minute"
    minutes: "minutes"
    hour: "hour"
    hours: "hours"

    helpHeader: "&8========[ &e%NAME% &8| &e%PAGE%/%MAX% &8]========"
    helpPageNotFound: "&8[&eMaintenance&8] &cThere is no page with that number!"
    helpNextPage: "&7Use &b/maintenance help %PAGE% &7to get to the next help window."
    helpAbortTimer: "&6/maintenance aborttimer &7(If running, the current timer will be aborted)"
    helpEndtimer: "&6/maintenance endtimer <minutes> &7(After the given time in minutes, maintenance mode will be disabled)"
    helpStarttimer: "&6/maintenance starttimer <minutes> &7(After the given time in minutes, maintenance mode will be enabled)"
    helpScheduleTimer: "&6/maintenance scheduletimer <timer minutes> <maintenance duration> &7(After the given time in minutes, maintenance mode will be enabled for the given duration in minutes)"
    helpDebug: "&6/maintenance debug &7(Enables some debug logging)"
    helpDump: "&6/maintenance dump &7(Dumps some server information, used for bug reports)"
    helpHelp: "&6/maintenance help [page] &7(Shows this beautiful help window)"
    helpMotd: "&6/maintenance motd [timer] &7(Lists the currently set maintenance motds. If specifying 'timer', the timer motds are shown)"
    helpRemoveMotd: "&6/maintenance removemotd [timer] <index> &7(Removes a maintenance motd. If using 'timer' as an argument, a timerspecific pingmessage will be removed)"
    helpSetMotd: "&6/maintenance setmotd [timer] <index> <1/2> <message> &7(Sets a motd for maintenance mode. If using 'timer' as an argument, a timerspecific pingmessage will be set)"
    helpReload: "&6/maintenance reload &7(Reloads the config file, whitelist file and the server-icon)"
    helpToggle: "&6/maintenance <on/off> &7(Enables/disables maintenance mode)"
    helpUpdate: "&6/maintenance update &7(Remotely downloads the newest version of the plugin onto your server)"
    helpWhitelist: "&6/maintenance whitelist &7(Shows all whitelisted players for the maintenance mode)"
    helpWhitelistAdd: "&6/maintenance add <name/uuid> &7(Adds the player to the maintenance whitelist, so they can join the server even though maintenance is enabled)"
    helpWhitelistRemove: "&6/maintenance remove <name/uuid> &7(Removes the player from the maintenance whitelist)"

    # Messages for the Bungee/Velocity part, just can ignore them if you use the plugin on Spigot/Sponge
    helpAbortSingleTimer: "&6/maintenance aborttimer [server] &7(If running, the current timer will be aborted)"
    helpSingleEndtimer: "&6/maintenance endtimer [server] <minutes> &7(After the given time in minutes, maintenance mode will be disabled)"
    helpSingleStarttimer: "&6/maintenance starttimer [server] <minutes> &7(After the given time in minutes, maintenance mode will be enabled)"
    helpSingleScheduleTimer: "&6/maintenance scheduletimer [server] <timer minutes> <maintenance duration> &7(After the given time in minutes, maintenance mode will be enabled for the given duration in minutes)"
    helpSingleToggle: "&6/maintenance <on/off> [server] &7(Enables/disables maintenance mode)"
    helpStatus: "&6/maintenance status &7(Lists all proxied servers, that are currently under maintenance)"
     


    generatedtext.png
    If you have the ServerListPlus plugin on your BungeeCord/Spigot server, Maintenance will toggle its status. If you enable maintenance, the ServerListPlus motd will be disabled and then reenabled, when you disable maintenance to prevent any issues with them overriding each other.


    generatedtext (6).png
    [I]Only available in the BungeeCord version![/I]

    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!


    I want to give a small thank you to the people translating messages - you're awesome!
    French: [USER=470472]@Zendrique[/USER]
    Spanish: [USER=645893]@Vixo_Ulises[/USER]
    Portuguese: [USER=165132]@JoaoPinto[/USER]
    Russian: [USER=254758]@En_0t_S[/USER]
    Chinese: [USER=262541]@yeban[/USER]
    Italian: [URL='[URL][URL]https://github.com/TheViperShow[/URL][/URL]']TheViperShow[/URL]



    A rating or a review would be highly appreciated and a creation of one (and also for a spigot account) is fairly easy! :)

Recent Updates

  1. 3.0.7 Changelog
  2. Version 3.0.6 changelog
  3. Version 3.0.5 Changelog

Recent Reviews

  1. Xiaoguard
    Xiaoguard
    5/5,
    Version: 3.0.7
    A great, lightweight plugin. I have been using this for a while now without issues. I highly recommend using this for your maintenance plugin.
    1. kennytv
      Author's Response
      Thank you!
  2. MaxDaFoxHybridz
    MaxDaFoxHybridz
    5/5,
    Version: 3.0.7
    Very simple and lightweight plugin! Been trying to find a lockdown/maintenance plugin for awhile. Also up-to-date, really recommend!
    1. kennytv
  3. MrP4red3s
    MrP4red3s
    4/5,
    Version: 3.0.6
    Is it compatible with hex colors?
    ----------------------------------------------------------
  4. billyxd_
    billyxd_
    5/5,
    Version: 3.0.6
    Perfect plugin. Have everything I need. Fast setup etc. If you're looking for maintenance plugin go for this one. Love it
    1. kennytv
      Author's Response
      Thank you :)
  5. Bingoo
    Bingoo
    5/5,
    Version: 3.0.6
    Excellent plugin! Have used it for couple of months now and have nothing to complain about. Earlier I used a macro to send messages before stoping a server, the /maintenance starttimer command makes it 10 times easier.
    Keep up the good work!
  6. Camm
    Camm
    5/5,
    Version: 3.0.6
    THIS IS AN EXCELLENT PLUGIN!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  7. MilkShaker
    MilkShaker
    4/5,
    Version: 3.0.6
    The plugin is really nice, but I'm having some problems (I think it's the bad configuration on my part) but would there be any way to add the days in %TIMER% ?

    For example, let's say I'm launching my server in 5 days, would I be able to show the day, hour and minute in %TIMER%?

    In the case of "/maintenance endtimer 4320" I put the hours that the plugin will leave the server in maintenance, but in the server's MOTD, it shows me the days and hours that the maintenance will be ended.

    If I could, it would help me a lot.
  8. Xdlob9
    Xdlob9
    5/5,
    Version: 3.0.6
    A very good plugin! Works perfectly well. I have been using it for more than one year (with Spigot and Bungeecord) and it works very well.
    Keep the great work!
    1. kennytv
      Author's Response
      Thank you :)
  9. Actvise
    Actvise
    3/5,
    Version: 3.0.6
    Es ist eig. ein gutes Plugin. Aber leider kann mann nur leute whitelisten die online sind. Wenn dies behoben wird, ändere ich meine Bewertung.
  10. Produktecheck
    Produktecheck
    1/5,
    Version: 3.0.6
    A really great plugin. Only you cannot whitelist players who have never been on the server. So you have to take out the maintenance briefly every time. The developer doesn't want to add the feature either :/
    1. kennytv
      Author's Response
      That's just plainly wrong