tribufu/rust-gamedig
1
0
Fork 0
mirror of https://github.com/tribufu/rust-gamedig synced 2026-05-06 07:17:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added PROTOCOLS.md, modified README and updated GAMES

Browse source
This commit is contained in:
CosminPerRam 2022-10-20 14:41:17 +03:00
parent 21d2bc45a1
commit aac3a483c0
3 changed files with 21 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

16
GAMES.md
View file

@ -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.

8
PROTOCOLS.md Normal file
View file

@ -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

6
README.md
View file

@ -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)