ari/mcstatusface
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions
mcstatusface/README.md
ari melody d2fb78108e
update readme
2025-06-16 19:30:51 +01:00

669 B
Raw Permalink Blame History

Crafty McStatusFace

A light application that serves Minecraft server query information in a convenient format!

For more information, see https://minecraft.wiki/w/Query

Usage

McStatusFace can simply be run with mcstatusface <address:[port]>.

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 .) tool will provide server details in plain-text format.