Support WON Query Protocol

Author: BattlefieldDuck

opengsq/protocols/__init__.py

@@ -6,3 +6,4 @@
 from opengsq.protocols.quake2 import Quake2
 from opengsq.protocols.quake3 import Quake3
 from opengsq.protocols.source import Source
+from opengsq.protocols.won import WON

opengsq/protocols/source.py

@@ -12,10 +12,11 @@ class Source(ProtocolBase):
     """Source Engine Query Protocol"""
     full_name = 'Source Engine Query Protocol'
 
+    _A2S_INFO = b'\x54Source Engine Query\0'
+    _A2S_PLAYER = b'\x55'
+    _A2S_RULES = b'\x56'
+
     class __RequestHeader():
-        A2S_INFO = b'\x54Source Engine Query\0'
-        A2S_PLAYER = b'\x55'
-        A2S_RULES = b'\x56'
         A2A_PING = b'\x69'
         A2S_SERVERQUERY_GETCHALLENGE = b'\x57'
 
@@ -37,7 +38,7 @@ async def get_info(self) -> dict:
         
         See: https://developer.valvesoftware.com/wiki/Server_queries#A2S_INFO
         """
-        response_data = await self.__connect_and_send_challenge(self.__RequestHeader.A2S_INFO)
+        response_data = await self.__connect_and_send_challenge(self._A2S_INFO)
 
         br = BinaryReader(response_data)
         header = br.read_byte()
@@ -132,9 +133,9 @@ async def get_players(self) -> list:
         """
         This query retrieves information about the players currently on the server.
         
-        See: https://developer.valvesoftware.com/wiki/Server_queries#A2S_INFO
+        See: https://developer.valvesoftware.com/wiki/Server_queries#A2S_PLAYER
         """
-        response_data = await self.__connect_and_send_challenge(self.__RequestHeader.A2S_PLAYER)
+        response_data = await self.__connect_and_send_challenge(self._A2S_PLAYER)
 
         br = BinaryReader(response_data)
         header = br.read_byte()
@@ -170,7 +171,7 @@ async def get_rules(self) -> dict:
         
         See: https://developer.valvesoftware.com/wiki/Server_queries#A2S_RULES
         """
-        response_data = await self.__connect_and_send_challenge(self.__RequestHeader.A2S_RULES)
+        response_data = await self.__connect_and_send_challenge(self._A2S_RULES)
 
         br = BinaryReader(response_data)
         header = br.read_byte()
@@ -196,7 +197,7 @@ async def __connect_and_send_challenge(self, header: __RequestHeader) -> bytes:
             request_base = b'\xFF\xFF\xFF\xFF' + header
             request_data = request_base
 
-            if header != self.__RequestHeader.A2S_INFO:
+            if header != self._A2S_INFO:
                 request_data += b'\xFF\xFF\xFF\xFF'
 
             sock.send(request_data)

opengsq/protocols/won.py

@@ -0,0 +1,26 @@
+from opengsq.protocols.source import Source
+
+
+class WON(Source):
+    """World Opponent Network (WON) Query Protocol"""
+    full_name = 'World Opponent Network (WON) Protocol'
+
+    _A2S_INFO = b'details\0'
+    _A2S_PLAYER = b'players'
+    _A2S_RULES = b'rules'
+
+
+if __name__ == '__main__':
+    import asyncio
+    import json
+
+    async def main_async():
+        won = WON(address='212.227.190.150', query_port=27020, timeout=5.0)
+        info = await won.get_info()
+        players = await won.get_players()
+        rules = await won.get_rules()
+        print(json.dumps(info, indent=None, ensure_ascii=False) + '\n')
+        print(json.dumps(players, indent=None, ensure_ascii=False) + '\n')
+        print(json.dumps(rules, indent=None, ensure_ascii=False) + '\n')
+
+    asyncio.run(main_async())

opengsq/version.py

@@ -1 +1 @@
-__version__ = '1.2.3'
+__version__ = '1.3.0'