From 4fb13507533321b538580841864957b6b5437a2c Mon Sep 17 00:00:00 2001 From: CosminPerRam Date: Mon, 16 Jan 2023 23:31:59 +0200 Subject: [PATCH] Update some github documentation. --- GAMES.md | 3 ++- README.md | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/GAMES.md b/GAMES.md index 92ae331..6bcfb33 100644 --- a/GAMES.md +++ b/GAMES.md @@ -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: | Game | Use name | Protocol | Notes | diff --git a/README.md b/README.md index e10c783..69e37d3 100644 --- a/README.md +++ b/README.md @@ -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. ## 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: ```rust use gamedig::games::tf2; 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 { Err(error) => println!("Couldn't query, error: {error}"), Ok(r) => println!("{:#?}", r)