#3060 - Adding version to YAML files within PrimAITE

src/primaite/config/_package_data/basic_lan_network_example.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   ports:
   - ARP

src/primaite/config/_package_data/client_server_p2p_network_example.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   ports:
   - ARP

src/primaite/config/_package_data/data_manipulation.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

src/primaite/config/_package_data/data_manipulation_marl.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

src/primaite/config/_package_data/mini_scenario_with_simulation_variation/base_scenario.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   max_episode_length: 128
   ports: []

src/primaite/config/_package_data/multi_lan_internet_network_example.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   ports:
   - ARP

src/primaite/config/_package_data/scenario_with_placeholders/scenario.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

src/primaite/game/game.py

@@ -247,6 +247,11 @@ class PrimaiteGame:
         game.options = PrimaiteGameOptions(**cfg["game"])
         game.save_step_metadata = cfg.get("io_settings", {}).get("save_step_metadata") or False
 
+        # TODO: Future YAML config should specify the PrimAITE version they are written for.
+        #       For now, we warn that if it is missing, pending a mechanism to handle variations.
+        if not cfg["version"]:
+            _LOGGER.warning("Version definition is missing from provided configuration. ")
+
         # 1. create simulation
         sim = game.simulation
         net = sim.network