README.md

Minecraft Puma #

minecraft-puma is a Go starting point for checking Minecraft server availability. It currently implements the modern Java Edition status protocol on both sides:

  • serve exposes a small TCP status server for local testing.
  • ping requests status and validates the ping/pong round trip.

Run #

Start the test server:

go run ./cmd/minecraft-puma serve -listen 127.0.0.1:25565 -motd "Puma test server"

Ping it from another terminal:

go run ./cmd/minecraft-puma ping 127.0.0.1:25565

The ping command writes JSON containing the advertised status and measured ping/pong latency.

Verify #

go test ./...