diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f8f282..4a08885 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,8 @@ Who knows what the future holds... - Added [Valheim](https://store.steampowered.com/app/892970/Valheim/) support. ### Breaking: -None, yaay! +Protocols: +- Valve: Removed `SteamApp` due to it not being really useful at all, replaced all instances with `Engine`. # 0.4.1 - 13/10/2023 ### Changes: diff --git a/src/games/battalion1944.rs b/src/games/battalion1944.rs index dc49d9e..b6d4851 100644 --- a/src/games/battalion1944.rs +++ b/src/games/battalion1944.rs @@ -1,5 +1,6 @@ +use crate::protocols::valve::Engine; use crate::{ - protocols::valve::{self, game, SteamApp}, + protocols::valve::{self, game}, GDErrorKind::TypeParse, GDResult, }; @@ -8,7 +9,7 @@ use std::net::{IpAddr, SocketAddr}; pub fn query(address: &IpAddr, port: Option) -> GDResult { let mut valve_response = valve::query( &SocketAddr::new(*address, port.unwrap_or(7780)), - SteamApp::BATTALION1944.as_engine(), + Engine::new(489_940), None, None, )?; diff --git a/src/games/definitions.rs b/src/games/definitions.rs index 1e36305..578e3e5 100644 --- a/src/games/definitions.rs +++ b/src/games/definitions.rs @@ -4,7 +4,7 @@ use crate::protocols::{ gamespy::GameSpyVersion, minecraft::{LegacyGroup, Server}, quake::QuakeVersion, - valve::SteamApp, + valve::Engine, Protocol, }; use crate::Game; @@ -44,65 +44,65 @@ pub static GAMES: Map<&'static str, Game> = phf_map! { "minecraftlegacy16" => game!("Minecraft (legacy v1.6)", 25565, Protocol::Minecraft(Some(Server::Legacy(LegacyGroup::V1_6)))), "minecraftlegacy15" => game!("Minecraft (legacy v1.4-1.5)", 25565, Protocol::Minecraft(Some(Server::Legacy(LegacyGroup::V1_5)))), "minecraftlegacy13" => game!("Minecraft (legacy vB1.8-1.3)", 25565, Protocol::Minecraft(Some(Server::Legacy(LegacyGroup::V1_3)))), - "alienswarm" => game!("Alien Swarm", 27015, Protocol::Valve(SteamApp::ALIENSWARM)), - "aoc" => game!("Age of Chivalry", 27015, Protocol::Valve(SteamApp::AOC)), - "a2oa" => game!("ARMA 2: Operation Arrowhead", 2304, Protocol::Valve(SteamApp::A2OA)), - "ase" => game!("ARK: Survival Evolved", 27015, Protocol::Valve(SteamApp::ASE)), - "asrd" => game!("Alien Swarm: Reactive Drop", 2304, Protocol::Valve(SteamApp::ASRD)), - "avorion" => game!("Avorion", 27020, Protocol::Valve(SteamApp::AVORION)), - "barotrauma" => game!("Barotrauma", 27016, Protocol::Valve(SteamApp::BAROTRAUMA)), - "battalion1944" => game!("Battalion 1944", 7780, Protocol::Valve(SteamApp::BATTALION1944)), - "brainbread2" => game!("BrainBread 2", 27015, Protocol::Valve(SteamApp::BRAINBREAD2)), + "alienswarm" => game!("Alien Swarm", 27015, Protocol::Valve(Engine::new(630))), + "aoc" => game!("Age of Chivalry", 27015, Protocol::Valve(Engine::new(17510))), + "a2oa" => game!("ARMA 2: Operation Arrowhead", 2304, Protocol::Valve(Engine::new(33930))), + "ase" => game!("ARK: Survival Evolved", 27015, Protocol::Valve(Engine::new(346_110))), + "asrd" => game!("Alien Swarm: Reactive Drop", 2304, Protocol::Valve(Engine::new(563_560))), + "avorion" => game!("Avorion", 27020, Protocol::Valve(Engine::new(445_220))), + "barotrauma" => game!("Barotrauma", 27016, Protocol::Valve(Engine::new(602_960))), + "battalion1944" => game!("Battalion 1944", 7780, Protocol::Valve(Engine::new(489_940))), + "brainbread2" => game!("BrainBread 2", 27015, Protocol::Valve(Engine::new(346_330))), "battlefield1942" => game!("Battlefield 1942", 23000, Protocol::Gamespy(GameSpyVersion::One)), - "blackmesa" => game!("Black Mesa", 27015, Protocol::Valve(SteamApp::BLACKMESA)), - "ballisticoverkill" => game!("Ballistic Overkill", 27016, Protocol::Valve(SteamApp::BALLISTICOVERKILL)), - "codenamecure" => game!("Codename CURE", 27015, Protocol::Valve(SteamApp::CODENAMECURE)), - "colonysurvival" => game!("Colony Survival", 27004, Protocol::Valve(SteamApp::COLONYSURVIVAL)), - "counterstrike" => game!("Counter-Strike", 27015, Protocol::Valve(SteamApp::COUNTERSTRIKE)), - "cscz" => game!("Counter Strike: Condition Zero", 27015, Protocol::Valve(SteamApp::CSCZ)), - "csgo" => game!("Counter-Strike: Global Offensive", 27015, Protocol::Valve(SteamApp::CSGO)), - "css" => game!("Counter-Strike: Source", 27015, Protocol::Valve(SteamApp::CSS)), - "creativerse" => game!("Creativerse", 26901, Protocol::Valve(SteamApp::CREATIVERSE)), + "blackmesa" => game!("Black Mesa", 27015, Protocol::Valve(Engine::new(362_890))), + "ballisticoverkill" => game!("Ballistic Overkill", 27016, Protocol::Valve(Engine::new(296_300))), + "codenamecure" => game!("Codename CURE", 27015, Protocol::Valve(Engine::new(355_180))), + "colonysurvival" => game!("Colony Survival", 27004, Protocol::Valve(Engine::new(366_090))), + "counterstrike" => game!("Counter-Strike", 27015, Protocol::Valve(Engine::new_gold_src(false))), + "cscz" => game!("Counter Strike: Condition Zero", 27015, Protocol::Valve(Engine::new_gold_src(false))), + "csgo" => game!("Counter-Strike: Global Offensive", 27015, Protocol::Valve(Engine::new(730))), + "css" => game!("Counter-Strike: Source", 27015, Protocol::Valve(Engine::new(240))), + "creativerse" => game!("Creativerse", 26901, Protocol::Valve(Engine::new(280_790))), "crysiswars" => game!("Crysis Wars", 64100, Protocol::Gamespy(GameSpyVersion::Three)), - "dod" => game!("Day of Defeat", 27015, Protocol::Valve(SteamApp::DOD)), - "dods" => game!("Day of Defeat: Source", 27015, Protocol::Valve(SteamApp::DODS)), - "doi" => game!("Day of Infamy", 27015, Protocol::Valve(SteamApp::DOI)), - "dst" => game!("Don't Starve Together", 27016, Protocol::Valve(SteamApp::DST)), + "dod" => game!("Day of Defeat", 27015, Protocol::Valve(Engine::new_gold_src(false))), + "dods" => game!("Day of Defeat: Source", 27015, Protocol::Valve(Engine::new(300))), + "doi" => game!("Day of Infamy", 27015, Protocol::Valve(Engine::new(447_820))), + "dst" => game!("Don't Starve Together", 27016, Protocol::Valve(Engine::new(322_320))), "ffow" => game!("Frontlines: Fuel of War", 5478, Protocol::PROPRIETARY(ProprietaryProtocol::FFOW)), - "garrysmod" => game!("Garry's Mod", 27016, Protocol::Valve(SteamApp::GARRYSMOD)), - "hl2d" => game!("Half-Life 2 Deathmatch", 27015, Protocol::Valve(SteamApp::HL2D)), + "garrysmod" => game!("Garry's Mod", 27016, Protocol::Valve(Engine::new(4000))), + "hl2d" => game!("Half-Life 2 Deathmatch", 27015, Protocol::Valve(Engine::new(320))), "hce" => game!("Halo: Combat Evolved", 2302, Protocol::Gamespy(GameSpyVersion::Two)), - "hlds" => game!("Half-Life Deathmatch: Source", 27015, Protocol::Valve(SteamApp::HLDS)), - "hll" => game!("Hell Let Loose", 26420, Protocol::Valve(SteamApp::HLL)), - "insurgency" => game!("Insurgency", 27015, Protocol::Valve(SteamApp::INSURGENCY)), - "imic" => game!("Insurgency: Modern Infantry Combat", 27015, Protocol::Valve(SteamApp::IMIC)), - "insurgencysandstorm" => game!("Insurgency: Sandstorm", 27131, Protocol::Valve(SteamApp::INSURGENCYSANDSTORM)), - "left4dead" => game!("Left 4 Dead", 27015, Protocol::Valve(SteamApp::LEFT4DEAD)), - "left4dead2" => game!("Left 4 Dead 2", 27015, Protocol::Valve(SteamApp::LEFT4DEAD2)), - "ohd" => game!("Operation: Harsh Doorstop", 27005, Protocol::Valve(SteamApp::OHD)), - "onset" => game!("Onset", 7776, Protocol::Valve(SteamApp::ONSET)), - "projectzomboid" => game!("Project Zomboid", 16261, Protocol::Valve(SteamApp::PROJECTZOMBOID)), + "hlds" => game!("Half-Life Deathmatch: Source", 27015, Protocol::Valve(Engine::new(360))), + "hll" => game!("Hell Let Loose", 26420, Protocol::Valve(Engine::new(686_810))), + "insurgency" => game!("Insurgency", 27015, Protocol::Valve(Engine::new(222_880))), + "imic" => game!("Insurgency: Modern Infantry Combat", 27015, Protocol::Valve(Engine::new(17700))), + "insurgencysandstorm" => game!("Insurgency: Sandstorm", 27131, Protocol::Valve(Engine::new(581_320))), + "left4dead" => game!("Left 4 Dead", 27015, Protocol::Valve(Engine::new(500))), + "left4dead2" => game!("Left 4 Dead 2", 27015, Protocol::Valve(Engine::new(550))), + "ohd" => game!("Operation: Harsh Doorstop", 27005, Protocol::Valve(Engine::new_with_dedicated(736_590, 950_900))), + "onset" => game!("Onset", 7776, Protocol::Valve(Engine::new(1_105_810))), + "projectzomboid" => game!("Project Zomboid", 16261, Protocol::Valve(Engine::new(108_600))), "quake1" => game!("Quake 1", 27500, Protocol::Quake(QuakeVersion::One)), "quake2" => game!("Quake 2", 27910, Protocol::Quake(QuakeVersion::Two)), "quake3" => game!("Quake 3: Arena", 27960, Protocol::Quake(QuakeVersion::Three)), - "ror2" => game!("Risk of Rain 2", 27016, Protocol::Valve(SteamApp::ROR2)), - "rust" => game!("Rust", 27015, Protocol::Valve(SteamApp::RUST)), - "sco" => game!("Sven Co-op", 27015, Protocol::Valve(SteamApp::SCO)), - "7d2d" => game!("7 Days To Die", 26900, Protocol::Valve(SteamApp::SD2D)), + "ror2" => game!("Risk of Rain 2", 27016, Protocol::Valve(Engine::new(632_360))), + "rust" => game!("Rust", 27015, Protocol::Valve(Engine::new(252_490))), + "sco" => game!("Sven Co-op", 27015, Protocol::Valve(Engine::new_gold_src(false))), + "7d2d" => game!("7 Days To Die", 26900, Protocol::Valve(Engine::new(251_570))), "sof2" => game!("Soldier of Fortune 2", 20100, Protocol::Quake(QuakeVersion::Three)), "serioussam" => game!("Serious Sam", 25601, Protocol::Gamespy(GameSpyVersion::One)), - "theforest" => game!("The Forest", 27016, Protocol::Valve(SteamApp::THEFOREST)), - "teamfortress2" => game!("Team Fortress 2", 27015, Protocol::Valve(SteamApp::TEAMFORTRESS2)), - "tfc" => game!("Team Fortress Classic", 27015, Protocol::Valve(SteamApp::TFC)), + "theforest" => game!("The Forest", 27016, Protocol::Valve(Engine::new(556_450))), + "teamfortress2" => game!("Team Fortress 2", 27015, Protocol::Valve(Engine::new(440))), + "tfc" => game!("Team Fortress Classic", 27015, Protocol::Valve(Engine::new_gold_src(false))), "theship" => game!("The Ship", 27015, Protocol::PROPRIETARY(ProprietaryProtocol::TheShip)), - "unturned" => game!("Unturned", 27015, Protocol::Valve(SteamApp::UNTURNED)), + "unturned" => game!("Unturned", 27015, Protocol::Valve(Engine::new(304_930))), "unrealtournament" => game!("Unreal Tournament", 7778, Protocol::Gamespy(GameSpyVersion::One)), - "valheim" => game!("Valheim", 2457, Protocol::Valve(SteamApp::VALHEIM), GatheringSettings { + "valheim" => game!("Valheim", 2457, Protocol::Valve(Engine::new(892_970)), GatheringSettings { players: true, rules: false, check_app_id: true, }.into_extra()), - "vrising" => game!("V Rising", 27016, Protocol::Valve(SteamApp::VRISING)), + "vrising" => game!("V Rising", 27016, Protocol::Valve(Engine::new(1_604_030))), "jc2m" => game!("Just Cause 2: Multiplayer", 7777, Protocol::PROPRIETARY(ProprietaryProtocol::JC2M)), "warsow" => game!("Warsow", 44400, Protocol::Quake(QuakeVersion::Three)), }; diff --git a/src/games/mod.rs b/src/games/mod.rs index 9650f1f..35ebbd3 100644 --- a/src/games/mod.rs +++ b/src/games/mod.rs @@ -76,10 +76,10 @@ pub fn query_with_timeout_and_extra_settings( ) -> GDResult> { let socket_addr = SocketAddr::new(*address, port.unwrap_or(game.default_port)); Ok(match &game.protocol { - Protocol::Valve(steam_app) => { + Protocol::Valve(engine) => { protocols::valve::query( &socket_addr, - steam_app.as_engine(), + *engine, extra_settings .or(Option::from(game.request_settings.clone())) .map(ExtraRequestSettings::into), diff --git a/src/games/theship.rs b/src/games/theship.rs index 47de24f..5084200 100644 --- a/src/games/theship.rs +++ b/src/games/theship.rs @@ -1,7 +1,7 @@ use crate::{ protocols::{ types::{CommonPlayer, CommonResponse, GenericPlayer, TimeoutSettings}, - valve::{self, get_optional_extracted_data, Server, ServerPlayer, SteamApp}, + valve::{self, get_optional_extracted_data, Server, ServerPlayer}, GenericResponse, }, GDErrorKind::PacketBad, @@ -11,6 +11,7 @@ use std::net::{IpAddr, SocketAddr}; use std::collections::HashMap; +use crate::protocols::valve::Engine; #[cfg(feature = "serde")] use serde::{Deserialize, Serialize}; @@ -136,7 +137,7 @@ pub fn query_with_timeout( ) -> GDResult { let valve_response = valve::query( &SocketAddr::new(*address, port.unwrap_or(27015)), - SteamApp::THESHIP.as_engine(), + Engine::new(2400), None, timeout_settings, )?; diff --git a/src/games/valve.rs b/src/games/valve.rs index 80b6ad9..c7a4a71 100644 --- a/src/games/valve.rs +++ b/src/games/valve.rs @@ -2,61 +2,116 @@ use crate::protocols::valve::game_query_mod; -game_query_mod!(a2oa, "ARMA 2: Operation Arrowhead", A2OA, 2304); -game_query_mod!(alienswarm, "Alien Swarm", ALIENSWARM, 27015); -game_query_mod!(aoc, "Age of Chivalry", AOC, 27015); -game_query_mod!(ase, "ARK: Survival Evolved", ASE, 27015); -game_query_mod!(asrd, "Alien Swarm: Reactive Drop", ASRD, 2304); -game_query_mod!(avorion, "Avorion", AVORION, 27020); +game_query_mod!( + a2oa, + "ARMA 2: Operation Arrowhead", + Engine::new(33930), + 2304 +); +game_query_mod!(alienswarm, "Alien Swarm", Engine::new(630), 27015); +game_query_mod!(aoc, "Age of Chivalry", Engine::new(17510), 27015); +game_query_mod!(ase, "ARK: Survival Evolved", Engine::new(346_110), 27015); +game_query_mod!( + asrd, + "Alien Swarm: Reactive Drop", + Engine::new(563_560), + 2304 +); +game_query_mod!(avorion, "Avorion", Engine::new(445_220), 27020); game_query_mod!( ballisticoverkill, "Ballistic Overkill", - BALLISTICOVERKILL, + Engine::new(296_300), 27016 ); -game_query_mod!(barotrauma, "Barotrauma", BAROTRAUMA, 27016); -game_query_mod!(blackmesa, "Black Mesa", BLACKMESA, 27015); -game_query_mod!(brainbread2, "BrainBread 2", BRAINBREAD2, 27015); -game_query_mod!(codenamecure, "Codename CURE", CODENAMECURE, 27015); -game_query_mod!(colonysurvival, "Colony Survival", COLONYSURVIVAL, 27004); -game_query_mod!(counterstrike, "Counter-Strike", COUNTERSTRIKE, 27015); -game_query_mod!(creativerse, "Creativerse", CREATIVERSE, 26901); -game_query_mod!(cscz, "Counter Strike: Condition Zero", CSCZ, 27015); -game_query_mod!(csgo, "Counter-Strike: Global Offensive", CSGO, 27015); -game_query_mod!(css, "Counter-Strike: Source", CSS, 27015); -game_query_mod!(dod, "Day of Defeat", DOD, 27015); -game_query_mod!(dods, "Day of Defeat: Source", DODS, 27015); -game_query_mod!(doi, "Day of Infamy", DOI, 27015); -game_query_mod!(dst, "Don't Starve Together", DST, 27016); -game_query_mod!(garrysmod, "Garry's Mod", GARRYSMOD, 27016); -game_query_mod!(hl2d, "Half-Life 2 Deathmatch", HL2D, 27015); -game_query_mod!(hlds, "Half-Life Deathmatch: Source", HLDS, 27015); -game_query_mod!(hll, "Hell Let Loose", HLL, 26420); -game_query_mod!(imic, "Insurgency: Modern Infantry Combat", IMIC, 27015); -game_query_mod!(insurgency, "Insurgency", INSURGENCY, 27015); +game_query_mod!(barotrauma, "Barotrauma", Engine::new(602_960), 27016); +game_query_mod!(blackmesa, "Black Mesa", Engine::new(362_890), 27015); +game_query_mod!(brainbread2, "BrainBread 2", Engine::new(346_330), 27015); +game_query_mod!(codenamecure, "Codename CURE", Engine::new(355_180), 27015); +game_query_mod!( + colonysurvival, + "Colony Survival", + Engine::new(366_090), + 27004 +); +game_query_mod!( + counterstrike, + "Counter-Strike", + Engine::new_gold_src(false), + 27015 +); +game_query_mod!(creativerse, "Creativerse", Engine::new(280_790), 26901); +game_query_mod!( + cscz, + "Counter Strike: Condition Zero", + Engine::new_gold_src(false), + 27015 +); +game_query_mod!( + csgo, + "Counter-Strike: Global Offensive", + Engine::new(730), + 27015 +); +game_query_mod!(css, "Counter-Strike: Source", Engine::new(240), 27015); +game_query_mod!(dod, "Day of Defeat", Engine::new_gold_src(false), 27015); +game_query_mod!(dods, "Day of Defeat: Source", Engine::new(300), 27015); +game_query_mod!(doi, "Day of Infamy", Engine::new(447_820), 27015); +game_query_mod!(dst, "Don't Starve Together", Engine::new(322_320), 27016); +game_query_mod!(garrysmod, "Garry's Mod", Engine::new(4000), 27016); +game_query_mod!(hl2d, "Half-Life 2 Deathmatch", Engine::new(320), 27015); +game_query_mod!( + hlds, + "Half-Life Deathmatch: Source", + Engine::new(360), + 27015 +); +game_query_mod!(hll, "Hell Let Loose", Engine::new(686_810), 26420); +game_query_mod!( + imic, + "Insurgency: Modern Infantry Combat", + Engine::new(17700), + 27015 +); +game_query_mod!(insurgency, "Insurgency", Engine::new(222_880), 27015); game_query_mod!( insurgencysandstorm, "Insurgency: Sandstorm", - INSURGENCYSANDSTORM, + Engine::new(581_320), 27131 ); -game_query_mod!(left4dead, "Left 4 Dead", LEFT4DEAD, 27015); -game_query_mod!(left4dead2, "Left 4 Dead 2", LEFT4DEAD2, 27015); -game_query_mod!(ohd, "Operation: Harsh Doorstop", OHD, 27005); -game_query_mod!(onset, "Onset", ONSET, 7776); -game_query_mod!(projectzomboid, "Project Zomboid", PROJECTZOMBOID, 16261); -game_query_mod!(ror2, "Risk of Rain 2", ROR2, 27016); -game_query_mod!(rust, "Rust", RUST, 27015); -game_query_mod!(sco, "Sven Co-op", SCO, 27015); -game_query_mod!(sd2d, "7 Days To Die", SD2D, 26900); -game_query_mod!(teamfortress2, "Team Fortress 2", TEAMFORTRESS2, 27015); -game_query_mod!(tfc, "Team Fortress Classic", TFC, 27015); -game_query_mod!(theforest, "The Forest", THEFOREST, 27016); -game_query_mod!(unturned, "Unturned", UNTURNED, 27015); +game_query_mod!(left4dead, "Left 4 Dead", Engine::new(500), 27015); +game_query_mod!(left4dead2, "Left 4 Dead 2", Engine::new(550), 27015); +game_query_mod!( + ohd, + "Operation: Harsh Doorstop", + Engine::new_with_dedicated(736_590, 950_900), + 27005 +); +game_query_mod!(onset, "Onset", Engine::new(1_105_810), 7776); +game_query_mod!( + projectzomboid, + "Project Zomboid", + Engine::new(108_600), + 16261 +); +game_query_mod!(ror2, "Risk of Rain 2", Engine::new(632_360), 27016); +game_query_mod!(rust, "Rust", Engine::new(252_490), 27015); +game_query_mod!(sco, "Sven Co-op", Engine::new_gold_src(false), 27015); +game_query_mod!(sd2d, "7 Days To Die", Engine::new(251_570), 26900); +game_query_mod!(teamfortress2, "Team Fortress 2", Engine::new(440), 27015); +game_query_mod!( + tfc, + "Team Fortress Classic", + Engine::new_gold_src(false), + 27015 +); +game_query_mod!(theforest, "The Forest", Engine::new(556_450), 27016); +game_query_mod!(unturned, "Unturned", Engine::new(304_930), 27015); game_query_mod!( valheim, "Valheim", - VALHEIM, + Engine::new(892_970), 2457, GatheringSettings { players: true, @@ -64,4 +119,4 @@ game_query_mod!( check_app_id: true, } ); -game_query_mod!(vrising, "V Rising", VRISING, 27016); +game_query_mod!(vrising, "V Rising", Engine::new(1_604_030), 27016); diff --git a/src/protocols/types.rs b/src/protocols/types.rs index 83a9cf9..2fcd1a1 100644 --- a/src/protocols/types.rs +++ b/src/protocols/types.rs @@ -23,7 +23,7 @@ pub enum Protocol { Gamespy(gamespy::GameSpyVersion), Minecraft(Option), Quake(quake::QuakeVersion), - Valve(valve::SteamApp), + Valve(valve::Engine), #[cfg(feature = "games")] PROPRIETARY(ProprietaryProtocol), } diff --git a/src/protocols/valve/mod.rs b/src/protocols/valve/mod.rs index 575a200..9e67fae 100644 --- a/src/protocols/valve/mod.rs +++ b/src/protocols/valve/mod.rs @@ -14,22 +14,22 @@ pub use types::*; /// documentation for the created module. /// * `steam_app`, `default_port` - Passed through to [game_query_fn]. macro_rules! game_query_mod { - ($mod_name: ident, $pretty_name: expr, $steam_app: ident, $default_port: literal) => { + ($mod_name: ident, $pretty_name: expr, $engine: expr, $default_port: literal) => { crate::protocols::valve::game_query_mod!( $mod_name, $pretty_name, - $steam_app, + $engine, $default_port, GatheringSettings::default() ); }; - ($mod_name: ident, $pretty_name: expr, $steam_app: ident, $default_port: literal, $gathering_settings: expr) => { + ($mod_name: ident, $pretty_name: expr, $engine: expr, $default_port: literal, $gathering_settings: expr) => { #[doc = $pretty_name] pub mod $mod_name { - use crate::protocols::valve::GatheringSettings; + use crate::protocols::valve::{Engine, GatheringSettings}; - crate::protocols::valve::game_query_fn!($steam_app, $default_port, $gathering_settings); + crate::protocols::valve::game_query_fn!($pretty_name, $engine, $default_port, $gathering_settings); } }; } @@ -40,7 +40,7 @@ pub(crate) use game_query_mod; // https://users.rust-lang.org/t/macros-filling-text-in-comments/20473 /// Generate a query function for a valve game. /// -/// * `steam_app` - The entry in the [SteamApp] enum that the game uses. +/// * `engine` - The [Engine] that the game uses. /// * `default_port` - The default port the game uses. /// /// ```rust,ignore @@ -48,19 +48,19 @@ pub(crate) use game_query_mod; /// game_query_fn!(TEAMFORTRESS2, 27015); /// ``` macro_rules! game_query_fn { - ($steam_app: ident, $default_port: literal, $gathering_settings: expr) => { + ($pretty_name: expr, $engine: expr, $default_port: literal, $gathering_settings: expr) => { // TODO: By using $gathering_settings, also add to doc if a game doesnt respond to certain gathering settings - crate::protocols::valve::game_query_fn!{@gen $steam_app, $default_port, concat!( - "Make a valve query for ", stringify!($steam_app), " with default timeout settings and default extra request settings.\n\n", + crate::protocols::valve::game_query_fn!{@gen $engine, $default_port, concat!( + "Make a valve query for ", $pretty_name, " with default timeout settings and default extra request settings.\n\n", "If port is `None`, then the default port (", stringify!($default_port), ") will be used."), $gathering_settings} }; - (@gen $steam_app: ident, $default_port: literal, $doc: expr, $gathering_settings: expr) => { + (@gen $engine: expr, $default_port: literal, $doc: expr, $gathering_settings: expr) => { #[doc = $doc] pub fn query(address: &std::net::IpAddr, port: Option) -> crate::GDResult { let valve_response = crate::protocols::valve::query( &std::net::SocketAddr::new(*address, port.unwrap_or($default_port)), - crate::protocols::valve::SteamApp::$steam_app.as_engine(), + $engine, Some($gathering_settings), None, )?; diff --git a/src/protocols/valve/protocol.rs b/src/protocols/valve/protocol.rs index 4cde7e9..7fc44cb 100644 --- a/src/protocols/valve/protocol.rs +++ b/src/protocols/valve/protocol.rs @@ -16,7 +16,6 @@ use crate::{ }, Engine, ModData, - SteamApp, }, }, socket::{Socket, UdpSocket}, @@ -59,8 +58,8 @@ impl SplitPacket { Engine::Source(_) => { let total = buffer.read()?; let number = buffer.read()?; - let size = match protocol == 7 && (*engine == SteamApp::CSS.as_engine()) { - // certain apps with protocol = 7 dont have this field + let size = match protocol == 7 && (*engine == Engine::new(240)) { + // certain apps with protocol = 7 dont have this field, such as CSS false => buffer.read()?, true => 1248, }; @@ -304,7 +303,7 @@ impl ValveProtocol { let environment_type = Environment::from_gldsrc(buffer.read()?)?; let has_password = buffer.read::()? == 1; let vac_secured = buffer.read::()? == 1; - let the_ship = match *engine == SteamApp::THESHIP.as_engine() { + let the_ship = match *engine == Engine::new(2400) { false => None, true => { Some(TheShip { @@ -389,11 +388,11 @@ impl ValveProtocol { name: buffer.read_string::(None)?, score: buffer.read()?, duration: buffer.read()?, - deaths: match *engine == SteamApp::THESHIP.as_engine() { + deaths: match *engine == Engine::new(2400) { false => None, true => Some(buffer.read()?), }, - money: match *engine == SteamApp::THESHIP.as_engine() { + money: match *engine == Engine::new(2400) { false => None, true => Some(buffer.read()?), }, @@ -418,7 +417,8 @@ impl ValveProtocol { rules.insert(name, value); } - if *engine == SteamApp::ROR2.as_engine() { + if *engine == Engine::new(632_360) { + // ROR2 rules.remove("Test"); } diff --git a/src/protocols/valve/types.rs b/src/protocols/valve/types.rs index 573f920..ebe46ad 100644 --- a/src/protocols/valve/types.rs +++ b/src/protocols/valve/types.rs @@ -249,159 +249,20 @@ impl Request { } } -/// Supported steam apps -#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] -#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)] -pub enum SteamApp { - /// Counter-Strike - COUNTERSTRIKE, - /// Creativerse - CREATIVERSE, - /// Team Fortress Classic - TFC, - /// Day of Defeat - DOD, - /// Counter-Strike: Condition Zero - CSCZ, - /// Counter-Strike: Source - CSS, - /// Day of Defeat: Source - DODS, - /// Half-Life 2 Deathmatch - HL2D, - /// Half-Life Deathmatch: Source - HLDS, - /// Team Fortress 2 - TEAMFORTRESS2, - /// Left 4 Dead - LEFT4DEAD, - /// Left 4 Dead - LEFT4DEAD2, - /// Alien Swarm - ALIENSWARM, - /// Counter-Strike: Global Offensive - CSGO, - /// The Ship - THESHIP, - /// Garry's Mod - GARRYSMOD, - /// Age of Chivalry - AOC, - /// Insurgency: Modern Infantry Combat - IMIC, - /// ARMA 2: Operation Arrowhead - A2OA, - /// Project Zomboid - PROJECTZOMBOID, - /// Insurgency - INSURGENCY, - /// Sven Co-op - SCO, - /// 7 Days To Die - SD2D, - /// Rust - RUST, - /// Ballistic Overkill - BALLISTICOVERKILL, - /// Don't Starve Together - DST, - /// BrainBread 2 - BRAINBREAD2, - /// Codename CURE - CODENAMECURE, - /// Black Mesa - BLACKMESA, - /// Colony Survival - COLONYSURVIVAL, - /// Avorion - AVORION, - /// Day of Infamy - DOI, - /// The Forest - THEFOREST, - /// Unturned - UNTURNED, - /// ARK: Survival Evolved - ASE, - /// Battalion 1944 - BATTALION1944, - /// Insurgency: Sandstorm - INSURGENCYSANDSTORM, - /// Alien Swarm: Reactive Drop - ASRD, - /// Risk of Rain 2 - ROR2, - /// Operation: Harsh Doorstop - OHD, - /// Onset - ONSET, - /// V Rising - VRISING, - /// Hell Let Loose - HLL, - /// Barotrauma - BAROTRAUMA, - /// Valheim - VALHEIM, -} - -impl SteamApp { - /// Get the specified app as engine. - pub const fn as_engine(&self) -> Engine { - match self { - Self::CSS => Engine::new_source(240), - Self::DODS => Engine::new_source(300), - Self::HL2D => Engine::new_source(320), - Self::HLDS => Engine::new_source(360), - Self::TEAMFORTRESS2 => Engine::new_source(440), - Self::LEFT4DEAD => Engine::new_source(500), - Self::LEFT4DEAD2 => Engine::new_source(550), - Self::ALIENSWARM => Engine::new_source(630), - Self::CSGO => Engine::new_source(730), - Self::THESHIP => Engine::new_source(2400), - Self::GARRYSMOD => Engine::new_source(4000), - Self::AOC => Engine::new_source(17510), - Self::IMIC => Engine::new_source(17700), - Self::A2OA => Engine::new_source(33930), - Self::PROJECTZOMBOID => Engine::new_source(108_600), - Self::INSURGENCY => Engine::new_source(222_880), - Self::SD2D => Engine::new_source(251_570), - Self::RUST => Engine::new_source(252_490), - Self::CREATIVERSE => Engine::new_source(280_790), - Self::BALLISTICOVERKILL => Engine::new_source(296_300), - Self::DST => Engine::new_source(322_320), - Self::BRAINBREAD2 => Engine::new_source(346_330), - Self::CODENAMECURE => Engine::new_source(355_180), - Self::BLACKMESA => Engine::new_source(362_890), - Self::COLONYSURVIVAL => Engine::new_source(366_090), - Self::AVORION => Engine::new_source(445_220), - Self::DOI => Engine::new_source(447_820), - Self::THEFOREST => Engine::new_source(556_450), - Self::UNTURNED => Engine::new_source(304_930), - Self::ASE => Engine::new_source(346_110), - Self::BATTALION1944 => Engine::new_source(489_940), - Self::INSURGENCYSANDSTORM => Engine::new_source(581_320), - Self::ASRD => Engine::new_source(563_560), - Self::BAROTRAUMA => Engine::new_source(602960), - Self::ROR2 => Engine::new_source(632_360), - Self::OHD => Engine::new_source_with_dedicated(736_590, 950_900), - Self::VALHEIM => Engine::new_source(892_970), - Self::ONSET => Engine::new_source(1_105_810), - Self::VRISING => Engine::new_source(1_604_030), - Self::HLL => Engine::new_source(686_810), - _ => Engine::GoldSrc(false), // CS - 10, TFC - 20, DOD - 30, CSCZ - 80, SC - 225840 - } - } -} - -/// Engine type. +/// Every supported Valve game references this enum, represents the behaviour +/// of server requests and responses. #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)] pub enum Engine { - /// A Source game, the argument represents the possible steam app ids, if - /// its **None**, let the query find it, if its **Some**, the query - /// fails if the response id is not the first one, which is the game app - /// id, or the other one, which is the dedicated server app id. + /// A Source game, the argument represents the possible steam app ids. + /// If its **None**, let the query find it (could come with some drawbacks, + /// some games do not respond on certain protocol versions (CSS on 7), + /// some have additional data (The Ship). + /// If its **Some**, the first value is the main steam app id, the second + /// could be a secondly used id, as some games use a different one for + /// dedicated servers. Beware if **check_app_id** is set to true in + /// [GatheringSettings], as the query will fail if the server doesnt respond + /// with the expected ids. Source(Option<(u32, Option)>), /// A GoldSrc game, the argument indicates whether to enforce /// requesting the obsolete A2S_INFO response or not. @@ -409,9 +270,11 @@ pub enum Engine { } impl Engine { - pub const fn new_source(appid: u32) -> Self { Self::Source(Some((appid, None))) } + pub const fn new(appid: u32) -> Self { Self::Source(Some((appid, None))) } - pub const fn new_source_with_dedicated(appid: u32, dedicated_appid: u32) -> Self { + pub const fn new_gold_src(force: bool) -> Self { Self::GoldSrc(force) } + + pub const fn new_with_dedicated(appid: u32, dedicated_appid: u32) -> Self { Self::Source(Some((appid, Some(dedicated_appid)))) } }