Skip to content
Plugins

Maintenancev3.0.0

C++by spheretoPuts the server in maintenance mode, where players must enter a password before they can play.

Stars
20

PLUGINSMAINTENANCE

# Install

C:\Users\you\bedrock_server\plugins\endstone_Maintenance.dll

Use the animation for reference. Follow the plugin's README for exact steps.

# README

A lightweight C++ plugin for Endstone servers that puts the server into a password-protected maintenance mode.

While maintenance is on, every player who joins must enter the password in a login form before they can do anything. Operators, players with the maintenance.bypass permission and whitelisted names skip the form entirely.

Features

  • Password login form with a configurable timeout; players who fail, close the form or run out of time are kicked.
  • Full lockdown while on the login screen: movement, chat, commands, interaction (blocks and entities), block breaking/placing, item dropping, pickup and use, and emotes are all blocked, plus optional blindness/slowness/resistance effects. Looking around is allowed. The effects are removed when the player logs in or is kicked, or at their next join if they disconnected on the login screen.
  • In-game control with /maintenance: toggle the mode, manage the whitelist and change the password without editing files or restarting. Turning maintenance on also locks players who are already online.
  • Maintenance whitelist for people who should always get in.
  • Server-list MOTD that shows the server is under maintenance.
  • Every message is configurable, including colour codes.
  • Exact, constant-time password comparison.

Compatibility

PluginEndstone
3.0.x0.11.x (built against 0.11.13)

Installation

  1. Download endstone_Maintenance.dll (Windows) or endstone_Maintenance.so (Linux) from the latest release.
  2. Put it in your server's plugins/ folder and start the server.
  3. Edit plugins/maintenance/config.yml, change the password, and run /maintenance reload.

Commands

All commands need the maintenance.command permission (operators by default). /mt is an alias.

CommandDescription
/maintenance on / offEnable or disable maintenance mode. The choice is saved to the config.
/maintenance statusShow whether maintenance is on, how many players are on the login screen, and the settings in effect.
/maintenance reloadRe-read config.yml after editing it by hand.
/maintenance listList whitelisted players.
/maintenance add <player>Add a player to the whitelist.
/maintenance remove <player>Remove a player from the whitelist.
/maintenance password <password>Change the login password.

Permissions

PermissionDefaultDescription
maintenance.commandOperatorUse /maintenance.
maintenance.bypassOperatorSkip the login form during maintenance.

Configuration

plugins/maintenance/config.yml is created on first start. It uses simple key: value lines; # starts a comment.

KeyDefaultDescription
maintenance.enabledtrueMaster switch.
maintenance.passwordpasswordherePassword required to join. Change this. An empty password means nobody can log in.
maintenance.kick_delay15Seconds to enter the password.
maintenance.apply_effectstrueApply blindness, slowness and resistance on the login screen.
maintenance.whitelist(empty)Comma-separated names that skip the form (case-insensitive).
messages.motd§cServer under maintenanceServer-list MOTD while maintenance is on; empty keeps the normal one.
messages.form_title, form_body, form_input_label, form_submitsee fileText of the login form.
messages.timeout, wrong_password, closedsee fileKick messages.
messages.accepted, bypasssee fileChat messages.

Note: the password is stored in plain text in config.yml. Keep that file readable by the server only.

Building from source

Endstone dictates the toolchain; it is downloaded automatically during configure.

PlatformRequirements
LinuxCMake 3.21+, Ninja, Clang with libc++
WindowsCMake 3.29+, Ninja, clang-cl (LLVM) and the Visual Studio C++ build tools / Windows SDK
# Linux
sudo apt install clang libc++-dev libc++abi-dev ninja-build
cmake --preset linux && cmake --build --preset linux

# Windows: run from an "x64 Native Tools Command Prompt for VS" with LLVM (clang-cl) on PATH
cmake --preset windows && cmake --build --preset windows

The plain MSVC compiler (cl.exe) is not supported for the plugin itself, because Endstone refuses to configure with it.

The plugin ends up in build/<preset>/ as endstone_Maintenance.so / .dll. To build against a different Endstone version, pass -DENDSTONE_VERSION=vX.Y.Z.

Trying a build without compiling it yourself

Every push to a branch other than main runs the Test build workflow, and you can start it manually from the Actions tab (Run workflow) on any branch. Open the run, download the Maintenance-v<version>-<commit>-linux or ...-windows artifact, unzip it and drop the .so / .dll into your server's plugins/ folder. Artifacts are kept for 14 days.

Run the unit tests (no Endstone download needed):

cmake --preset tests && cmake --build --preset tests && ctest --preset tests

See CONTRIBUTING.md for the development workflow and release process.

License

MIT. See LICENSE.

© 2023–2026 EndstoneMC

Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.