Maintenance

📘Config.yml

maintenance:
  enabled: false
  exempt:
    - Notch
    - billy_bob_123
  message:
    - "&cMaintenance!"
    - ""
    - "&fMaintenance has been enabled please be patient while we resolve the issues"
    - "&fJoin our discord for updates: &bdiscord.gg/"
  motd:
    enabled: true
    text:
      - "&c&lMaintenance!"
      - "&fCheck out the discord for more info!"
    default: []
  server-ping:
    text: "&c&lMaintenance"

📘Maintenance Mode Configuration & Commands

EasyStaff allows you to configure and manage maintenance mode both in-game and directly via the config file. Below is a breakdown of the available options and commands.


📘Configuration Options

  • enabled Toggles maintenance mode on or off. Can be changed in-game or through the config.

  • exempt A list of player names who will not be kicked when /maintenance kickall is used. These players are exempt from maintenance restrictions.

  • message The kick message shown to players who try to join during maintenance mode.

  • motd Allows you to customize the MOTD (Message of the Day) shown while maintenance mode is active.

    • When enabled, it will temporarily replace your server's MOTD.

    • The original MOTD is stored and automatically restored when maintenance mode is disabled.

  • server-ping Overrides the player count display in the server list with custom text when maintenance mode is enabled.


⌨️Maintenance Commands

Toggle Maintenance

You can toggle maintenance mode in-game using any of the following commands:

/maintenance on

/maintenance off

/maintenance toggle

Countdown Timer

You can schedule maintenance to begin after a specific delay using a countdown timer.

/maintenance timer start <duration> [optional reason]

  • Duration format: s, m, h, d (seconds, minutes, hours, days)

  • Once the timer ends:

    • Maintenance mode is enabled

    • All players not on the exempt list will be kicked

To cancel a countdown:

/maintenance timer cancel

🛡️Managing the Exempt List

You can manage the exempt list either through the config or in-game using:

/maintenance add <player> -> Add a player to the exempt list

/maintenance remove <player> -> Remove a player from the exempt list

/maintenance info -> View all players currently on the exempt list


‼️Kicking Non-Exempt Players

To manually kick all non-exempt players:

/maintenance kickall

Last updated