Skip to content

Server tools ​

These talk to MCTest's API inside a dedicated server (ws://127.0.0.1:25598/ by default), started by runServer. See Dedicated servers for the setup.

ToolMethodWhat it does
mc_server_wait_ready(polls status)Wait until the server has started; tolerates it not running yet
mc_server_statusstatusState (starting/running/stopping), game port, online mode, players, ms/tick, frozen, dimensions, mods
mc_server_commandcommand {command,ticks?}Run a command as the console (full permissions); returns output, success, result
mc_server_playersplayersPlayers as the server sees them: op, ping, position, dimension, gamemode, health, inventory, open menu, effects
mc_server_blockblock {x,y,z,dimension?}Authoritative block state and block-entity NBT
mc_server_entitiesentities {player? | x,y,z?, dimension?, radius?, type?, limit?}Entities around a player or point, or all loaded in a dimension
mc_server_wait_forwaitFor {condition,timeoutTicks?}ticks:<n>, log:<text>, player:<name>, noplayer:<name>, players:<n>, block:<x,y,z>=<id>[@dim], entity:<type>[@dim]
mc_server_logslogs {…}The server's captured log lines, same format as mc_logs
mc_server_time_freeze / _unfreeze / _step / _statustime.*Tick freeze and exact stepping on the server
mc_server_gametest_list / _rungametest.*The GameTest tools, on the dedicated server
mc_server_stopstopSave and stop the server
mc_server_callanyRaw call to the server API

Released under the MIT License.