mc-status-probe 0.1.0-alpha.4

A zero-dependency Minecraft Java server status probe based on wiki.vg Server List Ping protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# mc-status-probe

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Crates.io](https://img.shields.io/crates/v/mc-status-probe.svg)](https://crates.io/crates/mc-status-probe)

English | [中文](./README_zh-cn.md)

A zero-dependency, protocol-level Minecraft Java server status probe. Built from scratch following the [wiki.vg Server List Ping](https://wiki.vg/Server_List_Ping) protocol specification.

## Features

- **Pure protocol implementation** — no Minecraft protocol library dependencies
- **Async** — built on `tokio` for non-blocking I/O
- **Type-safe** — structured `PingResult` with version, players, MOTD, latency
- **Configurable** — adjustable protocol version, timeout
- **Lightweight** — only `tokio`, `serde_json`, `thiserror` as dependencies

## Usage

```rust
use mc_status_probe::ping;
use std::time::Duration;

#[tokio::main]
async fn main() {
    match ping("mc.hypixel.net", 25565, Duration::from_secs(3), None).await {
        Ok(result) => {
            println!("Server: {}", result.description);
            println!("Players: {}/{}", result.players_online, result.players_max);
            println!("Version: {}", result.version_name);
            println!("Latency: {}ms", result.latency_ms);
        }
        Err(e) => println!("Ping failed: {}", e),
    }
}
```

## How It Works

1. Opens a TCP connection to the Minecraft server
2. Sends a Handshake packet (protocol version + server address + "status" next state)
3. Sends a Status Request packet (empty packet)
4. Reads and parses the Status Response JSON
5. Calculates round-trip latency

## Protocol Version Reference

| Minecraft Version | Protocol Version |
|-------------------|-----------------|
| 1.21.11 | 774 |
| 1.21.5 | 767 |
| 1.21 / 1.21.1 | 767 |
| 1.20.5 / 1.20.6 | 766 |
| 1.20.2 / 1.20.4 | 765 |
| 1.19.4 | 762 |
| 1.19.3 | 761 |
| 1.19.1 / 1.19.2 | 760 |
| 1.19 | 759 |
| 1.18.2 | 758 |

Full list: https://wiki.vg/Protocol_version_numbers

## License

MIT