rust-mc-status 1.1.0

High-performance asynchronous Rust library for querying Minecraft server status (Java & Bedrock)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# Rust Minecraft Server Status Library

[![Crates.io](https://img.shields.io/crates/v/rust-mc-status)](https://crates.io/crates/rust-mc-status)
[![Documentation](https://docs.rs/rust-mc-status/badge.svg)](https://docs.rs/rust-mc-status)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

A high-performance, asynchronous Rust library for querying the status of both Minecraft Java Edition and Bedrock Edition servers.

## Features

*   **Dual Protocol Support**: Ping both Minecraft Java Edition (`25565`) and Bedrock Edition (`19132`) servers.
*   **Async/Await**: Built on Tokio for non-blocking operations and high concurrency.
*   **Batch Queries**: Ping multiple servers in parallel with configurable concurrency limits.
*   **DNS Caching**: Automatically caches DNS lookups to reduce latency for repeated queries.
*   **Structured Data**: Returns richly structured, serializable data (using `serde`), including version info, player counts, MOTD, map, gamemode, plugins, mods and more.
*   **Favicon Handling**: Easily retrieve and save the server's favicon (Java Edition only).
*   **Robust Error Handling**: Comprehensive error types using `thiserror`.
*   **Extended Information**: Detailed data about plugins, mods, DNS and more.

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
rust-mc-status = "1.1.0"
tokio = { version = "*", features = ["full"] }
```

## Usage

### Basic Example

```rust
use rust_mc_status::{McClient, ServerEdition, ServerInfo};
use std::time::Duration;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = McClient::new()
        .with_timeout(Duration::from_secs(5))
        .with_max_parallel(10);

    // Check a single server
    let status = client.ping("mc.hypixel.net", ServerEdition::Java).await?;
    println!("Status: {:?}", status);

    // Batch check servers
    let servers = vec![
        ServerInfo {
            address: "mc.hypixel.net".to_string(),
            edition: ServerEdition::Java,
        },
        ServerInfo {
            address: "geo.hivebedrock.network:19132".to_string(),
            edition: ServerEdition::Bedrock,
        },
    ];

    let results = client.ping_many(&servers).await;

    for (server, result) in results {
        println!("Server: {} - {:?}", server.address, result);
    }
    
    Ok(())
}
```

### Advanced Example

See [examples/advanced_usage.rs](examples/advanced_usage.rs) for a demonstration of all the new library features.

## Key Structs and Methods

*   `McClient`: The main client for making requests.
    *   `new()`, `with_timeout()`, `with_max_parallel()`
    *   `ping(address, edition)`: Ping a single server.
    *   `ping_many(servers)`: Ping multiple servers in parallel.
*   `ServerStatus`: The result of a successful ping.
    *   `online`: `bool`
    *   `ip`: `String` - Server IP address
    *   `port`: `u16` - Server port
    *   `hostname`: `String` - Hostname
    *   `latency`: `f64` - Latency in ms
    *   `dns`: `Option<DnsInfo>` - DNS information
    *   `data`: `ServerData` (enum containing either `JavaStatus` or `BedrockStatus`)
*   `JavaStatus`: Contains detailed information from a Java server.
    *   `version`: Version information
    *   `players`: Player information
    *   `description`: Server description (MOTD)
    *   `map`: Map name
    *   `gamemode`: Game mode
    *   `software`: Server software
    *   `plugins`: List of plugins
    *   `mods`: List of mods
    *   `save_favicon(filename)`: Saves the server icon to a PNG file.
*   `BedrockStatus`: Contains information from a Bedrock server.
    *   `edition`: Minecraft edition
    *   `motd`: Message of the day
    *   `version`: Server version
    *   `online_players`: Online players count
    *   `max_players`: Maximum players
    *   `map`: Map name
    *   `software`: Server software
    *   `game_mode`: Game mode

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Version

I recommend increasing the version to **1.1.0** in `Cargo.toml`, since new functionality has been added without breaking backward compatibility:

```toml
[package]
name = "rust-mc-status"
version = "1.1.0"  # Change from 1.0.3 to 1.1.0
# ... rest remains unchanged
```