Server management

The tools a network owner needs to run the network: the maintenance mode, the restarts and the list of backends.

---

The maintenance mode

While the maintenance mode is on, the network is closed for the players.

/maintenance on
/maintenance off

The permission is appeltools.command.admin.maintenance. The command answers to /mt as well.

What happens when it is switched on

• Every player without appeltools.command.admin.maintenance.bypass is kicked with the message from maintenance.kick-message.
• The server list shows the maintenance instead of the normal information: the icon, the MOTD, the text when you hover a player in the list and the version line. Each of those can be switched on and off on its own in config.yml:

modules:
  maintenance:
    enabled: true
    icon: true
    motd: true
    player-list-hover: true
    version: true

• The staff are told about it, on Discord in the log channel.

The bypass permission is meant for the staff: give it to the moderators and they keep playing while the players are locked out.

---

The restarts

There are two restart commands: one for the proxy and one for a backend.

/restartproxy 10m
/restartserver survival 5m

The permission is appeltools.command.admin.restart. /rp and /rs are the shortcuts.

The duration

Written	Means
30s	30 seconds
10m	10 minutes
1h	1 hour
90	90 seconds
cancel	Cancel the restart that is running

The longest is two days.

The countdown

The countdown is announced to the players at these moments:

1 hour, 30 minutes, 10 minutes, 1 minute, 10 seconds, 5, 4, 3, 2, 1

A moment that lies before the end of the countdown is skipped, so a restart of ten seconds only announces the last five seconds.

What happens at the end

Command	What it does
/restartproxy <duration>	The proxy shuts down. The countdown is broadcast on the proxy, to everybody who is online.
/restartserver <server> <duration>	The named backend shuts down. The countdown is broadcast on that backend only — the players of the other servers do not see it.

The name of the backend is not case-sensitive.

Cancelling

Run the same command with cancel as the duration:

/restartproxy cancel
/restartserver survival cancel

The countdown stops and the players are told that there is no restart. After a restart has finished, a new one can be started right away.

WARNING

The proxy restart stops the proxy itself. The plugin does not start it again — that is up to the service manager of the server, or to whatever usually starts the proxy.

---

The backends

The proxy knows the backends it can send players to. With the commands below you can add and remove them without touching velocity.toml.

/servers register survival 192.168.1.20 25565
/servers unregister survival
/servers list

The permission is appeltools.command.admin.servers.

Command	What it does
/servers register <name> <ip> <port>	Adds a backend to the proxy.
/servers unregister <name>	Removes a backend from the proxy.
/servers list	The backends that the proxy knows, with their address.

Registering a backend that is already there is refused. Unregistering a backend that the proxy does not know is refused as well.

The address is written to the servers table of the database as well, so the plugin knows the servers of the network — that is what the statistics, the crash reports and the join messages work with.

WARNING

The registration in the proxy itself is not written to velocity.toml. When the proxy restarts, a backend that you registered by hand is gone from the proxy again — add it to velocity.toml as well to keep it.

TIP

The servers module has to be on for these commands to exist: modules.servers.enabled.