Rename mcstatus to gamestatus

This commit is contained in:
2026-04-05 13:43:11 +03:00
parent 39a3ceadbb
commit cdf375ba80
15 changed files with 319 additions and 55 deletions

View File

@@ -1,6 +1,17 @@
# mcstatus
# gamestatus
Small Go library for querying Minecraft Java and Bedrock server status.
Small Go library for querying game server status.
Current support:
- Minecraft Java
- Minecraft Bedrock
- Source / A2S servers
- Rust servers
- Counter-Strike 2 servers
- Valve/Source servers
The project is structured so other game protocols can be added later. Rust currently uses the same A2S-based transport layer as Source-style servers.
## Features
@@ -8,33 +19,42 @@ Small Go library for querying Minecraft Java and Bedrock server status.
- Java full query
- Bedrock RakNet ping
- Bedrock full query
- Source A2S info
- Source A2S players and rules via full query
- Rust query via the same Source/A2S layer
- CS2 query via the same Source/A2S layer
- Valve query via the same Source/A2S layer
- Optional SRV lookup
- Simple MOTD cleanup helper
## Install
```bash
go get github.com/VexoraDevelopment/mcstatus
go get github.com/VexoraDevelopment/gamestatus
```
## CLI
The repository also ships a small CLI in `cmd/mcstatus`.
The repository also ships a small CLI in `cmd/gamestatus`.
Build locally:
```bash
go build -o mcstatus ./cmd/mcstatus
go build -o gamestatus ./cmd/gamestatus
```
Examples:
```bash
mcstatus mc.hypixel.net
mcstatus java -json mc.hypixel.net
mcstatus bedrock -query play.example.com:19132
mcstatus auto -pretty localhost
mcstatus java -motd-raw mc.hypixel.net
gamestatus mc.hypixel.net
gamestatus java -json mc.hypixel.net
gamestatus bedrock -query play.example.com:19132
gamestatus source 127.0.0.1:27015
gamestatus rust 127.0.0.1:28015
gamestatus cs2 127.0.0.1:27015
gamestatus valve 127.0.0.1:27015
gamestatus auto -pretty localhost
gamestatus java -motd-raw mc.hypixel.net
```
If you prefer prebuilt binaries, use the files attached to GitHub Releases.
@@ -48,11 +68,11 @@ import (
"fmt"
"time"
"github.com/VexoraDevelopment/mcstatus"
"github.com/VexoraDevelopment/gamestatus"
)
func main() {
client := mcstatus.NewAll(3 * time.Second)
client := gamestatus.NewAll(3 * time.Second)
info, err := client.Java.Connect("hypixel.net", 25565)
if err != nil {
@@ -69,10 +89,11 @@ func main() {
## Packages
- `github.com/VexoraDevelopment/mcstatus`
- `github.com/VexoraDevelopment/mcstatus/java`
- `github.com/VexoraDevelopment/mcstatus/bedrock`
- `github.com/VexoraDevelopment/mcstatus/text`
- `github.com/VexoraDevelopment/gamestatus`
- `github.com/VexoraDevelopment/gamestatus/java`
- `github.com/VexoraDevelopment/gamestatus/bedrock`
- `github.com/VexoraDevelopment/gamestatus/source`
- `github.com/VexoraDevelopment/gamestatus/text`
## Releases
@@ -82,7 +103,7 @@ Pushing a tag like `v1.0.1` triggers GitHub Actions and publishes release archiv
- Linux
- macOS
using the `mcstatus` CLI binary from `cmd/mcstatus`.
using the `gamestatus` CLI binary from `cmd/gamestatus`.
## Notes