Adding Halo1 Support

Author: Hornochs

docs/tests/protocols/index.rst

@@ -5,6 +5,7 @@ Protocols Tests
 
 .. toctree::
 	test_cod4/index
+	test_halo1/index
 	test_flatout2/index
 	test_battlefield2/index
 	test_source/index

docs/tests/protocols/test_halo1/index.rst

@@ -0,0 +1,7 @@
+.. _test_halo1:
+
+test_halo1
+==========
+
+.. toctree::
+	test_get_status

docs/tests/protocols/test_halo1/test_get_status.rst

@@ -0,0 +1,36 @@
+test_get_status
+===============
+
+Here are the results for the test method.
+
+.. code-block:: json
+
+	{
+	    "info": {
+	        "hostname": "YoMama",
+	        "gamever": "01.00.00.0564",
+	        "hostport": "",
+	        "maxplayers": "4",
+	        "password": "0",
+	        "mapname": "beavercreek",
+	        "dedicated": "0",
+	        "gamemode": "openplaying",
+	        "game_classic": "0",
+	        "numplayers": "1",
+	        "gametype": "Oddball",
+	        "teamplay": "0",
+	        "gamevariant": "Juggernaut",
+	        "fraglimit": "15",
+	        "player_flags": "1129320516,2",
+	        "game_flags": "12579"
+	    },
+	    "players": [
+	        {
+	            "player": "New001",
+	            "score": ":00",
+	            "ping": "",
+	            "team": "0"
+	        }
+	    ],
+	    "teams": []
+	}

opengsq/protocols/__init__.py

@@ -17,6 +17,7 @@
 from opengsq.protocols.gamespy2 import GameSpy2
 from opengsq.protocols.gamespy3 import GameSpy3
 from opengsq.protocols.gamespy4 import GameSpy4
+from opengsq.protocols.halo1 import Halo1
 from opengsq.protocols.kaillera import Kaillera
 from opengsq.protocols.killingfloor import KillingFloor
 from opengsq.protocols.minecraft import Minecraft

opengsq/protocols/halo1.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from opengsq.protocols.gamespy2 import GameSpy2
+
+
+class Halo1(GameSpy2):
+    """Halo 1 Multiplayer Protocol (based on GameSpy2)"""
+
+    full_name = "Halo 1 Multiplayer"
+
+    def __init__(self, host: str, port: int = 2302, timeout: float = 5.0):
+        """
+        Initialize the Halo 1 protocol.
+
+        :param host: The server host address
+        :param port: The server port (default: 2302)
+        :param timeout: The timeout for the connection (default: 5.0 seconds)
+        """
+        super().__init__(host, port, timeout)
+
+
+if __name__ == "__main__":
+    import asyncio
+
+    async def main_async():
+        halo1 = Halo1(host="172.29.100.29", port=2302, timeout=5.0)
+        status = await halo1.get_status()
+        print(status)
+
+    asyncio.run(main_async())
+

tests/protocols/test_halo1.py

@@ -0,0 +1,16 @@
+import pytest
+from opengsq.protocols.halo1 import Halo1
+
+from ..result_handler import ResultHandler
+
+handler = ResultHandler(__file__)
+handler.enable_save = True
+
+# bfv
+test = Halo1(host="172.29.100.29", port=2302)
+
+
+@pytest.mark.asyncio
+async def test_get_status():
+    result = await test.get_status()
+    await handler.save_result("test_get_status", result)