ari/mcstatusface
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
ari melody 2025-06-16 19:30:51 +01:00
parent d66b12caff
commit d2fb78108e
Signed by: ari
GPG key ID: CF99829C92678188
1 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -7,9 +7,14 @@ For more information, see https://minecraft.wiki/w/Query
## 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 .`)
McStatusFace can simply be run with `mcstatusface <address:[port]>`.
Alternatively, you can simply run `mcstatusface <address[:port]>`, and the
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.