From aac3a483c0e89ca06e015add77753b21c3aa2baa Mon Sep 17 00:00:00 2001 From: CosminPerRam Date: Thu, 20 Oct 2022 14:41:17 +0300 Subject: [PATCH] Added PROTOCOLS.md, modified README and updated GAMES --- GAMES.md | 16 ++++++++++------ PROTOCOLS.md | 8 ++++++++ README.md | 6 +++--- 3 files changed, 21 insertions(+), 9 deletions(-) create mode 100644 PROTOCOLS.md diff --git a/GAMES.md b/GAMES.md index 13fd16b..777933e 100644 --- a/GAMES.md +++ b/GAMES.md @@ -1,7 +1,11 @@ -# Supported games: -| Type ID | Name | Notes | -|---------|-----------------|-------| -| TF2 | Team Fortress 2 | | -# Planned to add support: -All Valve titles. +# Supported games: +| ID | Name | Protocol | Notes | +|----------|----------------------------------|----------------|----------------------------------| +| TF2 | Team Fortress 2 | Valve Protocol | | +| The_Ship | The Ship | Valve Protocol | | +| CSGO | Counter Strike: Global Offensive | Valve Protocol | Rules doesnt work on this title. | + +## Planned to add support: +All Valve titles. +Minecraft. diff --git a/PROTOCOLS.md b/PROTOCOLS.md new file mode 100644 index 0000000..48aad3e --- /dev/null +++ b/PROTOCOLS.md @@ -0,0 +1,8 @@ + +# Supported protocols: +| Name | Documentation reference | Used by | +|----------------|---------------------------------------------------------------------------|---------------------| +| Valve Protocol | [Server Queries](https://developer.valvesoftware.com/wiki/Server_queries) | TF2, CSGO, The_ship | + +## Planned to add support: +Minecraft protocol diff --git a/README.md b/README.md index 4ef0c8c..248cfaa 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ rust-GameDig is a game server/services query library, capable of querying the st MSRV is `1.58.1` and the code is cross-platform. +## Games/Protocols List +To see the supported (or the planned to support) games/protocols, see [GAMES](GAMES.md) and [PROTOCOLS](PROTOCOLS.md) respectively. + ## Usage Just pick a game, provide the ip and the port (can be optional) then query on it. ```rust @@ -22,8 +25,5 @@ To see more examples, see the [examples](examples) folder. The documentation is available at [docs.rs](https://docs.rs/gamedig/latest/gamedig/). Curious about the history and what changed between versions? you can see just that in the [CHANGELOG](CHANGELOG.md) file. -## Games List -To see the supported (or the planned to support) games, see [GAMES](GAMES.md). - ## Contributing If you want see your favorite game/service being supported here, open an issue and I'll prioritize it! (or do a pull request if you want to implement it yourself)