tribufu/rust-gamedig
1
0
Fork 0
mirror of https://github.com/tribufu/rust-gamedig synced 2026-06-01 09:42:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update some github documentation.

Browse source
This commit is contained in:
CosminPerRam 2023-01-16 23:31:59 +02:00
parent e2f42008b2
commit 4fb1350753
2 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
GAMES.md
View file

@ -1,4 +1,5 @@
A supported game is defined as a game that has been successfully tested, other games that use the implemented protocols might work too, but it isn't guaranteed. A supported game is defined as a game that has been successfully tested, other games that use the implemented protocols might work too, but it isn't guaranteed.
Beware of the `Notes` column, as it contains information about query port offsets or other query requirements.
# Supported games: # Supported games:
| Game | Use name | Protocol | Notes | | Game | Use name | Protocol | Notes |

4
README.md
View file

@ -8,13 +8,13 @@ MSRV is `1.56.1` and the code is cross-platform.
To see the supported (or the planned to support) games/services/protocols, see [GAMES](GAMES.md), [SERVICES](SERVICES.md) and [PROTOCOLS](PROTOCOLS.md) respectively. To see the supported (or the planned to support) games/services/protocols, see [GAMES](GAMES.md), [SERVICES](SERVICES.md) and [PROTOCOLS](PROTOCOLS.md) respectively.
## Usage ## Usage
Just pick a game/service/protocol, provide the ip and the port (can be optional) (some use a special query port) then query on it. Just pick a game/service/protocol, provide the ip and the port (be aware that some game servers use a separate port for 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: Team Fortress 2 query example:
```rust ```rust
use gamedig::games::tf2; use gamedig::games::tf2;
fn main() { fn main() {
let response = tf2::query("127.0.0.1", None); //or Some(27015), None is the default protocol port let response = tf2::query("127.0.0.1", None); // None is the default port (which is 27015), could also be Some(27015)
match response { match response {
Err(error) => println!("Couldn't query, error: {error}"), Err(error) => println!("Couldn't query, error: {error}"),
Ok(r) => println!("{:#?}", r) Ok(r) => println!("{:#?}", r)