Adding new Games

README.md

@@ -18,8 +18,10 @@ from opengsq.protocols import (
     ASE,
     Battlefield,
     Doom3,
+    ElDewrito,
     EOS,
     FiveM,
+    Flatout2,
     GameSpy1,
     GameSpy2,
     GameSpy3,

docs/tests/protocols/index.rst

@@ -4,34 +4,46 @@ Protocols Tests
 ===============
 
 .. toctree::
-	test_gamespy4/index
-	test_teamspeak3/index
+	test_cod4/index
+	test_halo1/index
+	test_flatout2/index
+	test_battlefield2/index
+	test_ssc/index
+	test_source/index
 	test_won/index
-	test_toxikk/index
-	test_gamespy1/index
-	test_minecraft/index
-	test_raknet/index
+	test_fivem/index
+	test_gamespy2/index
+	test_nadeo/index
+	test_trackmania_nations/index
+	test_ut3/index
+	test_eldewrito/index
 	test_eos/index
 	test_renegadex/index
+	test_stronghold_ce/index
+	test_quake2/index
+	test_gamespy3/index
+	test_stronghold_crusader/index
 	test_kaillera/index
-	test_ase/index
-	test_quake1/index
-	test_killingfloor/index
-	test_source/index
-	test_samp/index
+	test_toxikk/index
+	test_avp2/index
+	test_gamespy1/index
 	test_scum/index
-	test_ut3/index
-	test_unreal2/index
-	test_quake3/index
-	test_warcraft3/index
-	test_nadeo/index
+	test_raknet/index
+	test_killingfloor/index
 	test_battlefield/index
-	test_fivem/index
 	test_palworld/index
-	test_quake2/index
-	test_gamespy2/index
-	test_flatout2/index
+	test_tmn/index
 	test_doom3/index
+	test_w40kdow/index
+	test_samp/index
+	test_ase/index
+	test_teamspeak3/index
 	test_vcmp/index
+	test_minecraft/index
+	test_quake3/index
+	test_warcraft3/index
+	test_quake1/index
+	test_unreal2/index
+	test_gamespy4/index
+	test_cod1/index
 	test_satisfactory/index
-	test_gamespy3/index

docs/tests/protocols/test_avp2/index.rst

@@ -0,0 +1,11 @@
+.. _test_avp2:
+
+test_avp2
+=========
+
+.. toctree::
+	test_get_basic
+	test_get_players
+	test_get_status
+	test_get_info
+	test_get_rules

docs/tests/protocols/test_avp2/test_get_basic.rst

@@ -0,0 +1,12 @@
+test_get_basic
+==============
+
+Here are the results for the test method.
+
+.. code-block:: json
+
+	{
+	    "gamename": "avp2",
+	    "gamever": "1.0.9.6",
+	    "location": "0"
+	}

docs/tests/protocols/test_avp2/test_get_info.rst

@@ -0,0 +1,21 @@
+test_get_info
+=============
+
+Here are the results for the test method.
+
+.. code-block:: json
+
+	{
+	    "mspatch": "2.4",
+	    "website": "www.avp2msp.com",
+	    "hostname": "Aliens vs. Predator 2 [D]",
+	    "hostport": "27888",
+	    "mapname": "dm_verloc",
+	    "gametype": "Team DM",
+	    "gamemode": "openplaying",
+	    "numplayers": "1",
+	    "maxplayers": "16",
+	    "lock": "0",
+	    "ded": "1",
+	    "bandwidth": "10000000"
+	}

docs/tests/protocols/test_avp2/test_get_players.rst

@@ -0,0 +1,15 @@
+test_get_players
+================
+
+Here are the results for the test method.
+
+.. code-block:: json
+
+	[
+	    {
+	        "player": "1-NoName",
+	        "race": "1",
+	        "score": "0",
+	        "ping": "10"
+	    }
+	]

docs/tests/protocols/test_avp2/test_get_rules.rst

@@ -0,0 +1,38 @@
+test_get_rules
+==============
+
+Here are the results for the test method.
+
+.. code-block:: json
+
+	{
+	    "maxa": "8",
+	    "maxm": "8",
+	    "maxp": "8",
+	    "maxc": "8",
+	    "frags": "0",
+	    "score": "0",
+	    "time": "1800",
+	    "rounds": "0",
+	    "lc": "0",
+	    "hrace": "0",
+	    "prace": "0",
+	    "ratio": "0",
+	    "srace": "0",
+	    "mrace": "0",
+	    "drace": "0",
+	    "dlive": "0",
+	    "arace": "0",
+	    "alive": "0",
+	    "speed": "100",
+	    "respawn": "100",
+	    "damage": "100",
+	    "hitloc": "1",
+	    "ff": "0",
+	    "fn": "0",
+	    "mask": "0",
+	    "class": "1",
+	    "exosuit": "4",
+	    "queen": "1",
+	    "cscore": "0"
+	}

docs/tests/protocols/test_avp2/test_get_status.rst

@@ -0,0 +1,64 @@
+test_get_status
+===============
+
+Here are the results for the test method.
+
+.. code-block:: json
+
+	{
+	    "info": {
+	        "gamename": "avp2",
+	        "gamever": "1.0.9.6",
+	        "location": "0",
+	        "mspatch": "2.4",
+	        "website": "www.avp2msp.com",
+	        "hostname": "Aliens vs. Predator 2 [D]",
+	        "hostport": "27888",
+	        "mapname": "dm_verloc",
+	        "gametype": "Team DM",
+	        "gamemode": "openplaying",
+	        "numplayers": "1",
+	        "maxplayers": "16",
+	        "lock": "0",
+	        "ded": "1",
+	        "bandwidth": "10000000",
+	        "maxa": "8",
+	        "maxm": "8",
+	        "maxp": "8",
+	        "maxc": "8",
+	        "frags": "0",
+	        "score": "0",
+	        "time": "1800",
+	        "rounds": "0",
+	        "lc": "0",
+	        "hrace": "0",
+	        "prace": "0",
+	        "ratio": "0",
+	        "srace": "0",
+	        "mrace": "0",
+	        "drace": "0",
+	        "dlive": "0",
+	        "arace": "0",
+	        "alive": "0",
+	        "speed": "100",
+	        "respawn": "100",
+	        "damage": "100",
+	        "hitloc": "1",
+	        "ff": "0",
+	        "fn": "0",
+	        "mask": "0",
+	        "class": "1",
+	        "exosuit": "4",
+	        "queen": "1",
+	        "cscore": "0"
+	    },
+	    "players": [
+	        {
+	            "player": "1-NoName",
+	            "race": "1",
+	            "score": "0",
+	            "ping": "10"
+	        }
+	    ],
+	    "teams": []
+	}

docs/tests/protocols/test_battlefield2/index.rst

@@ -0,0 +1,7 @@
+.. _test_battlefield2:
+
+test_battlefield2
+=================
+
+.. toctree::
+	test_get_status

docs/tests/protocols/test_battlefield2/test_get_status.rst

@@ -0,0 +1,71 @@
+test_get_status
+===============
+
+Here are the results for the test method.
+
+.. code-block:: json
+
+	{
+	    "info": {
+	        "hostname": "Default Server Name",
+	        "gamename": "battlefield2",
+	        "gamever": "1.0.2442.0",
+	        "mapname": "Daqing_oilfields",
+	        "gametype": "gpm_cq",
+	        "gamevariant": "bf2",
+	        "numplayers": "1",
+	        "maxplayers": "64",
+	        "gamemode": "openplaying",
+	        "password": "0",
+	        "timelimit": "0",
+	        "roundtime": "3",
+	        "hostport": "16567",
+	        "bf2_dedicated": "0",
+	        "bf2_ranked": "0",
+	        "bf2_anticheat": "0",
+	        "bf2_os": "win32",
+	        "bf2_autorec": "0",
+	        "bf2_d_idx": "http://",
+	        "bf2_d_dl": "http://",
+	        "bf2_voip": "1",
+	        "bf2_autobalanced": "0",
+	        "bf2_friendlyfire": "1",
+	        "bf2_tkmode": "Punish",
+	        "bf2_startdelay": "15",
+	        "bf2_spawntime": "15.000000",
+	        "bf2_sponsortext": "",
+	        "bf2_sponsorlogo_url": "",
+	        "bf2_communitylogo_url": "",
+	        "bf2_scorelimit": "0",
+	        "bf2_ticketratio": "100",
+	        "bf2_teamratio": "100.000000",
+	        "bf2_team1": "CH",
+	        "bf2_team2": "US",
+	        "bf2_bots": "0",
+	        "bf2_pure": "1",
+	        "bf2_mapsize": "32",
+	        "bf2_globalunlocks": "0",
+	        "bf2_fps": ""
+	    },
+	    "players": [
+	        {
+	            "name": "Gamie",
+	            "score": "0",
+	            "ping": "0",
+	            "team": "2",
+	            "deaths": "0",
+	            "pid": "0",
+	            "skill": "0"
+	        }
+	    ],
+	    "teams": [
+	        {
+	            "name": "CH",
+	            "score": "0"
+	        },
+	        {
+	            "name": "US",
+	            "score": "0"
+	        }
+	    ]
+	}

docs/tests/protocols/test_cod1/index.rst

@@ -0,0 +1,10 @@
+.. _test_cod1:
+
+test_cod1
+=========
+
+.. toctree::
+	test_get_status
+	test_get_info
+	test_protocol_properties
+	test_get_full_status

docs/tests/protocols/test_cod1/test_get_full_status.rst

@@ -0,0 +1,37 @@
+test_get_full_status
+====================
+
+Here are the results for the test method.
+
+.. code-block:: json
+
+	{
+	    "info": {
+	        "challenge": "xxx",
+	        "protocol": "5",
+	        "hostname": "Garasch",
+	        "mapname": "mp_bocage",
+	        "clients": "1",
+	        "sv_maxclients": "20",
+	        "gametype": "dm",
+	        "pure": "1",
+	        "hw": "4",
+	        "mod": "0",
+	        "gametype_translated": "Death Match"
+	    },
+	    "status": {
+	        "g_gametype": "dm",
+	        "gamename": "Call of Duty",
+	        "mapname": "mp_bocage",
+	        "protocol": "5",
+	        "shortversion": "1.4",
+	        "sv_hostname": "Garasch",
+	        "sv_maxclients": "20",
+	        "sv_maxPing": "0",
+	        "sv_maxRate": "0",
+	        "sv_minPing": "0",
+	        "sv_privateClients": "0",
+	        "sv_pure": "1",
+	        "g_gametype_translated": "Death Match"
+	    }
+	}

docs/tests/protocols/test_cod1/test_get_info.rst

@@ -0,0 +1,20 @@
+test_get_info
+=============
+
+Here are the results for the test method.
+
+.. code-block:: json
+
+	{
+	    "challenge": "xxx",
+	    "protocol": "5",
+	    "hostname": "Garasch",
+	    "mapname": "mp_bocage",
+	    "clients": "1",
+	    "sv_maxclients": "20",
+	    "gametype": "dm",
+	    "pure": "1",
+	    "hw": "4",
+	    "mod": "0",
+	    "gametype_translated": "Death Match"
+	}