mcstatusface/README.md

16 lines
536 B
Markdown
Raw Normal View History

2025-04-14 18:49:04 +01:00
# Crafty McStatusFace
A light application that serves Minecraft server query information in a
convenient format!
2025-06-16 17:57:51 +01:00
For more information, see https://minecraft.wiki/w/Query
2025-04-14 18:49:04 +01:00
## Usage
2025-04-14 23:53:03 +01:00
McStatusFace can be run as a web server with `mcstatusface serve`. This will
2025-04-14 18:49:04 +01:00
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 .`)
2025-04-14 23:53:03 +01:00
Alternatively, you can simply run `mcstatusface <address[:port]>`, and the
2025-04-14 18:49:04 +01:00
tool will provide server details in plain-text format.