mcstatusface/README.md
2025-04-14 23:53:46 +01:00

13 lines
478 B
Markdown

# Crafty McStatusFace
A light application that serves Minecraft server query information in a
convenient format!
## Usage
McStatusFace can be run as a web server with `mcstatusface serve`. This will
provide server information in JSON format to requests on `GET /?s=<address[:port]>`.
(e.g. `curl -sS "127.0.0.1:8080?s=127.0.0.1:25565" | jq .`)
Alternatively, you can simply run `mcstatusface <address[:port]>`, and the
tool will provide server details in plain-text format.