mcping

Crates.iomcping
lib.rsmcping
version0.2.0
sourcesrc
created_at2020-10-18 22:24:33.195426
updated_at2021-02-15 15:14:07.26885
descriptionImplementation of the Server List Ping (SLP) part of the Minecraft Modern protocol
homepage
repositoryhttps://github.com/Scetch/mcping
max_upload_size
id302491
size45,603
Jarek Samic (Cldfire)

documentation

README

mcping

crate documentation Crates.io version Crates.io downloads CI

mcping is a Rust crate that can ping a Minecraft server and collect ping information such as the MOTD, max player count, player sample, etc.

Note: mcping currently only supports Minecraft Java edition.

Example

// Ping the server and gather status information and latency.
let (latency, status) = mcping::get_status("mc.hypixel.net", Duration::from_secs(10))?;

println!("latency: {}", latency);
print!("version: {}", status.version.name);
println!("description: {}", status.description.text());
println!("players: {}/{}", status.players.online, status.players.max);

A more complete example can be found in the cli example (examples/cli.rs) and can be run with cargo run --example cli.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Commit count: 64

cargo fmt