async-minecraft-ping (0.4.0)

Published 2024-08-02 23:21:42 +02:00 by LordMZTE in LordMZTE/async-minecraft-ping

Setup this registry in the Cargo configuration file (for example ~/.cargo/config.toml):

[registry]
default = "forgejo"

[registries.forgejo]
index = "sparse+" # Sparse index
# index = "" # Git

[net]
git-fetch-with-cli = true

To install the package using Cargo, run the following command:

cargo add async-minecraft-ping@0.4.0

For more information on the Cargo registry, see the documentation.

An async Rust client for the Minecraft ServerListPing protocol

async-minecraft-ping

An async ServerListPing client implementation in Rust.

Usage

See the example.

let mut config = ConnectionConfig::build(args.address);
if let Some(port) = args.port {
    config = config.with_port(port);
}

let mut connection = config.connect().await?;

let status = connection.status().await?;

println!(
    "{} of {} player(s) online",
    status.players.online, status.players.max
);

License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.