Server Console

Server Console

The server reads commands from its standard input: type them in the console or terminal it runs in. A line is at most 1024 bytes. Every answer goes to the console and to the log. The same commands work from afar through the remote console, limited by the operator's rights.

A service has no console. Its input ends, and the server runs on without it; use the remote console there.

Commands

help prints the list:

commands: status | kick <rider number | player id prefix | name> [reason] | say <text> | stop | start <resource> | stop <resource> | restart <resource> | ensure <resource> | refresh | blocklists | scripts | <a server script's command> | help
operation: instances | ban <rider | player:<id> | ip:<address> | range:<range>> <duration | forever> [reason] | unban <ban number | player:<id> | ip:<address> | range:<range>> | bans [reload] | mute <rider | player:<id>> <duration | forever> [reason] | unmute <rider | player:<id>> | mutes | acl list | acl show <group> | acl check <object> <right> | acl create <group> | acl delete <group> | acl add <group> <object> | acl remove <group> <object> | acl allow <group> <right> | acl deny <group> <right> | acl revoke <group> <right> | acl reload | aclrequest list [resource] | aclrequest allow <resource> <right | all> | aclrequest deny <resource> <right | all> (a rider: its number, a player id prefix of 8 hex digits or more, or its exact name, in double quotes when it has spaces; a duration: 30m, 12h, 7d, 2w)

The server

Command	What it does
status	uptime and tick times, joins, traffic, chat, each instance and its round, validation counts, discovery, resources, blocklists, and every rider: number, name, short player id, address
instances	each instance: its mode, level, round state and players
say <text>	a chat line from "the server" to every player
kick <rider> [reason]	ends a rider's connection; the reason is shown to them
stop	the graceful stop: a round under way may finish ([stop] round_end), the riders are told and the server leaves the server list, then it exits
help	the list above

A rider is named by its number (from status), a prefix of its player id of at least 8 hex digits, or its exact name, in double quotes when it has spaces: kick "Snow Fox" be nice.

Resources

See Server Resources.

Command	What it does
start <resource>	starts a resource from the resources folder (its requirements first)
stop <resource>	stops it (and what depends on it)
restart <resource>	reads it again from disk and restarts it; if the new copy does not read, the running one stays
ensure <resource>	starts it, or restarts it when it runs already
refresh	says which resources changed on disk
blocklists	the followed blocklists' state; reads them again now (at most once per 10 s)
scripts	the server scripts' monitor: budgets, time used, messages, rights checks

Resource commands are queued and run one at a time. stop alone stops the server; stop <name> stops a resource.

Bans, mutes and the ACL

See Bans and Mutes and Access Control List.

Commands of server scripts

Any other word (lower-case letters, digits and _, at most 32 characters) goes to the server scripts' command handlers (addCommandHandler). If no script registered it, the server answers unknown command <word>: no server script registered it; ….