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-06-16 19:30:51 +01:00
|
|
|
McStatusFace can simply be run with `mcstatusface <address:[port]>`.
|
2025-04-14 18:49:04 +01:00
|
|
|
|
2025-06-16 19:30:51 +01:00
|
|
|
Alternatively, you can start a web interface with
|
|
|
|
|
`mcstatusface serve [address:[port]]`.
|
|
|
|
|
|
|
|
|
|
This provides a web interface to query server information via a frontend, or
|
|
|
|
|
in JSON format if the request is cURLed.
|
|
|
|
|
|
|
|
|
|
The server queries Minecraft servers when a `GET /?s=<address[:port]>` request
|
|
|
|
|
is received. (e.g. `curl -sS "127.0.0.1:8080?s=127.0.0.1:25565" | jq .`)
|
2025-04-14 18:49:04 +01:00
|
|
|
tool will provide server details in plain-text format.
|
