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

[Games] Programmatic games by storing information as data (#45)

Browse source 
* Define games as structs

* Create table of response types

* Ensure serde is always included

* Remove server_ prefix in GenericResponse

* Make players online/max non-optional in generic response

* Use already existing minecraft server enum

* Implement ExtraResponses to prevent cloning when creating generic

* Add game definitions

* Add doc comments to generic types

* Include players in gamespy extra responses

* Add custom response types for TheShip and FFOW

* Cargo format differing files

* Final cleanup
This commit is contained in:
Tom 2023-06-13 18:49:58 +00:00 • committed by GitHub
parent 26ad1f5d19
commit d853189e06
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 806 additions and 102 deletions
Download patch file Download diff file Expand all files Collapse all files

54
RESPONSES.md Normal file
View file

@ -0,0 +1,54 @@
Every protocol has its own response type(s), below is a listing of the overlapping fields on these responses.
If a cell is blank it doesn't exist, otherwise it contains the type of that data in the current column's response type.
In the case that a field that performs the same function exists in the current column's response type that name is annotated in brackets.
# Response table
| Field | Generic | GameSpy(1) | GameSpy(3) | Minecraft(Java) | Minecraft(Bedrock) | Valve | Quake | FFOW | TheShip |
| :--------------- | -------------- | ---------- | ---------- | --------------- | ------------------ | ------ | ------ | ------ | ------- |
| name | Option<String> | String | String | | String | String | String | String | String |
| description | Option<String> | | | String | | | | String | |
| game | Option<String> | String (game_type) | String (game_type) | | Option<GameMode> (game_mode) | String | | String (game_mode) | String |
| game_version | Option<String> | String | String | String (version_name) | | String (version) | String (version) | String (version) | String (version) |
| map | Option<String> | String | String | | Option<String> | String | String | String | String |
| players_maxmimum | u64 | usize | usize | u32 | u32 | u8 | u8 | u8 | u8 (max_players) |
| players_online | u64 | usize | usize | u32 | u32 | u8 | u8 | u8 | u8 (players) |
| players_bots | Option<u64> | | | | | u8 | | | u8 (bots) |
| has_password | Option<bool> | bool | bool | | | bool | | bool | bool |
| map_title | | Option<String> | | | | | | | |
| admin_contact | | Option<String> | | | | | | | |
| admin_name | | Option<String> | | | | | | | |
| players_minimum | | Option<u8> | Option<u8> | | | | | | |
| players | | Vec<Player> | Vec<Player> | | | Option<Vec<ServerPlayer>> | Vec<P> | | Vec<TheShipPlayer> (player_details) |
| tournament | | bool | bool | | | | | | |
| unused_entries | | Hashmap<String, String> | HashMap<String, String> | | | Option<ExtraData> (extra_data) | HashMap<String, String> | | |
| teams | | | Vec<Team> | | | | | | |
| version_protocol | | | | i32 | String | u8 (protocol) | | u8 (protocol) | u8 (protocol) |
| players_sample | | | | Option<Vec<Player>> | | | | | |
| favicon | | | | Option<String> | | | | | |
| previews_chat | | | | Option<bool> | | | | | |
| enforces_secure_chat | | | | Option<bool> | | | | | |
| server_type | | | | Server | Server | Server | | | Server |
| edition | | | | | String | | | | |
| id | | | | | String | | | | |
| rules | | | | | | Option<HashMap<String,String>> | | | HashMap<String,String> |
| folder | | | | | | String | | | |
| appid | | | | | | u32 | | | |
| environment_type | | | | | | Environment | | Environment | |
| vac_secured | | | | | | bool | | bool | bool |
| the_ship | | | | | | Option<TheShip> | | | |
| is_mod | | | | | | bool | | | |
| mod_data | | | | | | Option<ModData> | | | |
| active_mod | | | | | | | | String | |
| round | | | | | | | | u8 | |
| rounds_maximum | | | | | | | | u8 | |
| time_left | | | | | | | | u16 | |
| port | | | | | | | | | Option<u16> |
| steam_id | | | | | | | | | Option<u64> |
| tv_port | | | | | | | | | Option<u16> |
| tv_name | | | | | | | | | Option<String> |
| keywords | | | | | | | | | Option<string> |
| mode | | | | | | | | | u8 |
| witnesses | | | | | | | | | u8 |
| duration | | | | | | | | | u8 |