About this project

Minecraft Stress Tester is an open-source load-testing tool for Minecraft servers. Rather than merely opening sockets, it connects a swarm of bots and measures the effect of that load on the server, reporting estimated TPS, a connection funnel, latency, throughput and kick reasons. It is designed to scale to thousands of bots across multiple processes and to work against real servers. Safety is built into the workflow: the project describes itself as a load generator and states it should only be run against servers you own or have explicit written permission to test. The tool refuses to start until the operator affirms authorization, and a SECURITY.md document covers responsible use. Distribution and quickstart options include running via npx under the published package name minecraft-stress-tester (binary mcst), cloning the repository and installing with npm, or running the web UI in a container from ghcr.io. A sample configuration file is provided under examples/local.yaml. The command set covers several modes: a default load test, a web control panel (gui), a control-plane API with REST and live metrics (serve), an interactive single-bot console (debug), a defensive security scan for servers you own (scan), and programmable bots via blueprints (script). Documentation is organized into install and distribution, usage and CLI, metrics, architecture, roadmap, web control panel, control-plane API, debug and bot API, programmable bots, behavior pipeline, and security scan pages, alongside contributing and security guidance. The project is MIT licensed, requires Node.js 24 or newer, and advertises CI with a coverage badge of at least 95 percent.