Repository files navigation

Warning: This project goes through frequent API breaking changes and hasn't been thoroughly tested.

Checkout the GameDig Community Discord Serverhere.
Note that it isn't be a replacement for GitHub issues, if you have found a problemwithin the library or want to request a feature, it's better to do so here rather thanon Discord.

Minimum Supported Rust Version is1.81.0 and the code is cross-platform.

Pick a game/service/protocol (check theGAMES,SERVICES andPROTOCOLS filesto see the currently supported ones), provide the ip and the port (be aware that some game servers use a separate portfor the info queries, the port can also be optional if the server is running the default ports) then query on it.

Team Fortress 2 query example:

use gamedig::games::teamfortress2;fnmain(){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)}}

Response (note that some games have a different structure):

{protocol:17,name:"Team Fortress 2 Dedicated Server.",map:"ctf_turbine",game:"tf2",appid:440,players_online:0,players_details:[],players_maximum:69,players_bots:0,server_type:Dedicated,has_password:false,vac_secured:true,version:"7638371",port:Some(27015),steam_id:Some(69753253289735296),tv_port:None,tv_name:None,keywords:Some("alltalk,nocrits"),rules:["mp_autoteambalance"    :"1","mp_maxrounds"    :"5",//....]}

Want to see more examples? Checkout theexamples folder.

The library also has anofficial CLI that you can use, it hasMSRV of1.81.0.

The documentation is available atdocs.rs.
Curious about the history and what changed between versions?
Everything is in the changelogs file:lib andcli.

If you want to see your favorite game/service being supported here, open an issue, and I'll prioritize it (or do a pullrequest if you want to implement it yourself)!

Before contributing please readCONTRIBUTING.