convert: Refactor AoCProcessor into separate files.

Author: heinezen

openage/convert/processor/conversion/aoc/CMakeLists.txt

@@ -21,6 +21,7 @@ add_subdirectory(ability)
 add_subdirectory(auxiliary)
 add_subdirectory(civ)
 add_subdirectory(effect)
+add_subdirectory(main)
 add_subdirectory(media)
 add_subdirectory(modifier)
 add_subdirectory(modpack)

openage/convert/processor/conversion/aoc/main/CMakeLists.txt

@@ -0,0 +1,7 @@
+add_py_modules(
+    __init__.py
+)
+
+add_subdirectory(extract)
+add_subdirectory(groups)
+add_subdirectory(link)

openage/convert/processor/conversion/aoc/main/__init__.py

@@ -0,0 +1,5 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+Routines for the main AoC conversion process.
+"""

openage/convert/processor/conversion/aoc/main/extract/CMakeLists.txt

@@ -0,0 +1,11 @@
+add_py_modules(
+    __init__.py
+    civ.py
+    connection.py
+    effect_bundle.py
+    graphics.py
+    sound.py
+    tech.py
+    terrain.py
+    unit.py
+)

openage/convert/processor/conversion/aoc/main/extract/__init__.py

@@ -0,0 +1,5 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+Extract AoC data from the game dataset and prepares it for conversion.
+"""

openage/convert/processor/conversion/aoc/main/extract/civ.py

@@ -0,0 +1,41 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+Extract civs from the AoC data.
+"""
+from __future__ import annotations
+import typing
+
+from ......entity_object.conversion.aoc.genie_civ import GenieCivilizationObject
+
+if typing.TYPE_CHECKING:
+    from ......value_object.read.value_members import ArrayMember
+    from ......entity_object.conversion.aoc.genie_object_container import GenieObjectContainer
+
+
+def extract_genie_civs(
+    gamespec: ArrayMember,
+    full_data_set: GenieObjectContainer
+) -> None:
+    """
+    Extract civs from the game data.
+
+    :param gamespec: Gamedata from empires.dat file.
+    :type gamespec: class: ...dataformat.value_members.ArrayMember
+    """
+    raw_civs = gamespec[0]["civs"].value
+
+    index = 0
+    for raw_civ in raw_civs:
+        civ_id = index
+
+        civ_members = raw_civ.value
+        units_member = civ_members.pop("units")
+        units_member = units_member.get_container("id0")
+
+        civ_members.update({"units": units_member})
+
+        civ = GenieCivilizationObject(civ_id, full_data_set, members=civ_members)
+        full_data_set.genie_civs.update({civ.get_id(): civ})
+
+        index += 1

openage/convert/processor/conversion/aoc/main/extract/connection.py

@@ -0,0 +1,95 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+Extract connection objects from the AoC data.
+"""
+from __future__ import annotations
+import typing
+
+from ......entity_object.conversion.aoc.genie_connection import GenieAgeConnection, \
+    GenieBuildingConnection, GenieUnitConnection, GenieTechConnection
+
+if typing.TYPE_CHECKING:
+    from ......value_object.read.value_members import ArrayMember
+    from ......entity_object.conversion.aoc.genie_object_container import GenieObjectContainer
+
+
+def extract_age_connections(gamespec: ArrayMember, full_data_set: GenieObjectContainer) -> None:
+    """
+    Extract age connections from the game data.
+
+    :param gamespec: Gamedata from empires.dat file.
+    :type gamespec: class: ...dataformat.value_members.ArrayMember
+    """
+    raw_connections = gamespec[0]["age_connections"].value
+
+    for raw_connection in raw_connections:
+        age_id = raw_connection["id"].value
+        connection_members = raw_connection.value
+
+        connection = GenieAgeConnection(age_id, full_data_set, members=connection_members)
+        full_data_set.age_connections.update({connection.get_id(): connection})
+
+
+@staticmethod
+def extract_building_connections(
+    gamespec: ArrayMember,
+    full_data_set: GenieObjectContainer
+) -> None:
+    """
+    Extract building connections from the game data.
+
+    :param gamespec: Gamedata from empires.dat file.
+    :type gamespec: class: ...dataformat.value_members.ArrayMember
+    """
+    raw_connections = gamespec[0]["building_connections"].value
+
+    for raw_connection in raw_connections:
+        building_id = raw_connection["id"].value
+        connection_members = raw_connection.value
+
+        connection = GenieBuildingConnection(building_id, full_data_set,
+                                             members=connection_members)
+        full_data_set.building_connections.update({connection.get_id(): connection})
+
+
+@staticmethod
+def extract_unit_connections(
+    gamespec: ArrayMember,
+    full_data_set: GenieObjectContainer
+) -> None:
+    """
+    Extract unit connections from the game data.
+
+    :param gamespec: Gamedata from empires.dat file.
+    :type gamespec: class: ...dataformat.value_members.ArrayMember
+    """
+    raw_connections = gamespec[0]["unit_connections"].value
+
+    for raw_connection in raw_connections:
+        unit_id = raw_connection["id"].value
+        connection_members = raw_connection.value
+
+        connection = GenieUnitConnection(unit_id, full_data_set, members=connection_members)
+        full_data_set.unit_connections.update({connection.get_id(): connection})
+
+
+@staticmethod
+def extract_tech_connections(
+    gamespec: ArrayMember,
+    full_data_set: GenieObjectContainer
+) -> None:
+    """
+    Extract tech connections from the game data.
+
+    :param gamespec: Gamedata from empires.dat file.
+    :type gamespec: class: ...dataformat.value_members.ArrayMember
+    """
+    raw_connections = gamespec[0]["tech_connections"].value
+
+    for raw_connection in raw_connections:
+        tech_id = raw_connection["id"].value
+        connection_members = raw_connection.value
+
+        connection = GenieTechConnection(tech_id, full_data_set, members=connection_members)
+        full_data_set.tech_connections.update({connection.get_id(): connection})

openage/convert/processor/conversion/aoc/main/extract/effect_bundle.py

@@ -0,0 +1,98 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+Extract effect objects from the AoC data.
+"""
+from __future__ import annotations
+import typing
+
+from ......entity_object.conversion.aoc.genie_effect import GenieEffectObject, GenieEffectBundle
+
+if typing.TYPE_CHECKING:
+    from ......value_object.read.value_members import ArrayMember
+    from ......entity_object.conversion.aoc.genie_object_container import GenieObjectContainer
+
+
+def extract_genie_effect_bundles(
+    gamespec: ArrayMember,
+    full_data_set: GenieObjectContainer
+) -> None:
+    """
+    Extract effects and effect bundles from the game data.
+
+    :param gamespec: Gamedata from empires.dat file.
+    :type gamespec: ...dataformat.value_members.ArrayMember
+    """
+    raw_effect_bundles = gamespec[0]["effect_bundles"].value
+
+    index_bundle = 0
+    for raw_effect_bundle in raw_effect_bundles:
+        bundle_id = index_bundle
+
+        # call hierarchy: effect_bundle->effects
+        raw_effects = raw_effect_bundle["effects"].value
+
+        effects = {}
+
+        index_effect = 0
+        for raw_effect in raw_effects:
+            effect_id = index_effect
+            effect_members = raw_effect.value
+
+            effect = GenieEffectObject(effect_id, bundle_id, full_data_set,
+                                       members=effect_members)
+
+            effects.update({effect_id: effect})
+
+            index_effect += 1
+
+        # Pass everything to the bundle
+        effect_bundle_members = raw_effect_bundle.value
+        # Remove effects we store them as separate objects
+        effect_bundle_members.pop("effects")
+
+        bundle = GenieEffectBundle(bundle_id, effects, full_data_set,
+                                   members=effect_bundle_members)
+        full_data_set.genie_effect_bundles.update({bundle.get_id(): bundle})
+
+        index_bundle += 1
+
+
+def sanitize_effect_bundles(full_data_set: GenieObjectContainer) -> None:
+    """
+    Remove garbage data from effect bundles.
+
+    :param full_data_set: GenieObjectContainer instance that
+                            contains all relevant data for the conversion
+                            process.
+    :type full_data_set: class: ...dataformat.aoc.genie_object_container.GenieObjectContainer
+    """
+    effect_bundles = full_data_set.genie_effect_bundles
+
+    for bundle in effect_bundles.values():
+        sanitized_effects = {}
+
+        effects = bundle.get_effects()
+
+        index = 0
+        for effect in effects:
+            effect_type = effect["type_id"].value
+            if effect_type < 0:
+                # Effect has no type
+                continue
+
+            if effect_type == 3:
+                if effect["attr_b"].value < 0:
+                    # Upgrade to invalid unit
+                    continue
+
+            if effect_type == 102:
+                if effect["attr_d"].value < 0:
+                    # Tech disable effect with no tech id specified
+                    continue
+
+            sanitized_effects.update({index: effect})
+            index += 1
+
+        bundle.effects = sanitized_effects
+        bundle.sanitized = True

openage/convert/processor/conversion/aoc/main/extract/graphics.py

@@ -0,0 +1,43 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+Extract graphics from the AoC data.
+"""
+from __future__ import annotations
+import typing
+
+from ......entity_object.conversion.aoc.genie_graphic import GenieGraphic
+
+if typing.TYPE_CHECKING:
+    from ......value_object.read.value_members import ArrayMember
+    from ......entity_object.conversion.aoc.genie_object_container import GenieObjectContainer
+
+
+def extract_genie_graphics(gamespec: ArrayMember, full_data_set: GenieObjectContainer) -> None:
+    """
+    Extract graphic definitions from the game data.
+
+    :param gamespec: Gamedata from empires.dat file.
+    :type gamespec: class: ...dataformat.value_members.ArrayMember
+    """
+    raw_graphics = gamespec[0]["graphics"].value
+
+    for raw_graphic in raw_graphics:
+        # Can be ignored if there is no filename associated
+        filename = raw_graphic["filename"].value
+        if not filename:
+            continue
+
+        graphic_id = raw_graphic["graphic_id"].value
+        graphic_members = raw_graphic.value
+
+        graphic = GenieGraphic(graphic_id, full_data_set, members=graphic_members)
+        slp_id = raw_graphic["slp_id"].value
+        if str(slp_id) not in full_data_set.existing_graphics:
+            graphic.exists = False
+
+        full_data_set.genie_graphics.update({graphic.get_id(): graphic})
+
+    # Detect subgraphics
+    for genie_graphic in full_data_set.genie_graphics.values():
+        genie_graphic.detect_subgraphics()

openage/convert/processor/conversion/aoc/main/extract/sound.py

@@ -0,0 +1,30 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+Extract sounds from the AoC data.
+"""
+from __future__ import annotations
+import typing
+
+from ......entity_object.conversion.aoc.genie_sound import GenieSound
+
+if typing.TYPE_CHECKING:
+    from ......value_object.read.value_members import ArrayMember
+    from ......entity_object.conversion.aoc.genie_object_container import GenieObjectContainer
+
+
+def extract_genie_sounds(gamespec: ArrayMember, full_data_set: GenieObjectContainer) -> None:
+    """
+    Extract sound definitions from the game data.
+
+    :param gamespec: Gamedata from empires.dat file.
+    :type gamespec: class: ...dataformat.value_members.ArrayMember
+    """
+    raw_sounds = gamespec[0]["sounds"].value
+
+    for raw_sound in raw_sounds:
+        sound_id = raw_sound["sound_id"].value
+        sound_members = raw_sound.value
+
+        sound = GenieSound(sound_id, full_data_set, members=sound_members)
+        full_data_set.genie_sounds.update({sound.get_id(): sound})