Expand description
Game Server Query Library.
§Usage example:
§For a specific game
use gamedig::games::teamfortress2;
let response = teamfortress2::query(&"127.0.0.1".parse().unwrap(), None); // None is the default port (which is 27015), could also be Some(27015)
match response { // Result type, must check what it is...
Err(error) => println!("Couldn't query, error: {}", error),
Ok(r) => println!("{:#?}", r)
}
§Using a game definition
use gamedig::{GAMES, query};
let game = GAMES.get("teamfortress2").unwrap(); // Get a game definition, the full list can be found in src/games/mod.rs
let response = query(game, &"127.0.0.1".parse().unwrap(), None); // None will use the default port
match response {
Err(error) => println!("Couldn't query, error: {}", error),
Ok(r) => println!("{:#?}", r.as_json()),
}
§Crate features:
Enabled by default: games
, game_defs
, services
serde
- enables serde serialization/deserialization for many gamedig types
using serde derive.
games
- include games support.
services
- include services support.
game_defs
- include game definitions for programmatic access (enabled by
default).
clap
- enable clap derivations for gamedig settings types.
tls
- enable TLS support for the HTTP client.
Re-exports§
pub use protocols::types::ExtraRequestSettings;
pub use protocols::types::TimeoutSettings;
pub use errors::*;
pub use games::*;
pub use query::*;
pub use services::*;
Modules§
- Every GameDig errors.
- Currently supported games.
- Protocols that are currently implemented.
- Services that are currently implemented.