arkparser 0.1.1__tar.gz → 0.1.2__tar.gz

{arkparser-0.1.1 → arkparser-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arkparser
-Version: 0.1.1
+Version: 0.1.2
 Summary: Pure Python parser for ARK: Survival Evolved and ARK: Survival Ascended save files
 Author: Vertyco
 License-Expression: MIT

{arkparser-0.1.1 → arkparser-0.1.2}/arkparser/files/cloud_inventory.py

@@ -56,13 +56,19 @@ class CloudInventory(ArkFile):
         - Object headers (ASE format)
         - Properties
 
-        ASA format:
-        - Int32 version
-        - Int32 unknown1 (extra field)
-        - Int32 unknown2 (extra field)
+        ASA v7 format:
+        - Int32 version (7)
+        - Int32 unknown1 (extra field, v7+ only)
+        - Int32 unknown2 (extra field, v7+ only)
         - Int32 object_count
         - Object headers (ASA format with GUIDs)
         - Properties
+
+        ASA v6 format (solo-cluster / cross-ARK transfer files):
+        - Int32 version (6)
+        - Int32 object_count
+        - Object headers (ASA format with GUIDs — no extra header fields)
+        - Properties
         """
         # Read version
         version = reader.read_int32()
@@ -73,8 +79,8 @@ class CloudInventory(ArkFile):
         # Detect ASE vs ASA
         is_asa = cls._detect_asa(reader, version)
 
-        if is_asa:
-            # ASA has extra header fields
+        if is_asa and version >= 7:
+            # v7+ ASA has two extra header fields before object_count
             _unknown1 = reader.read_int32()
             _unknown2 = reader.read_int32()
 
@@ -88,17 +94,23 @@ class CloudInventory(ArkFile):
         objects: list[GameObject] = []
         for i in range(object_count):
             if is_asa:
-                obj = cls._read_asa_object_header(reader, obj_id=i)
+                obj = cls._read_asa_object_header(reader, obj_id=i, version=version)
             else:
                 obj = GameObject.read_header(reader, obj_id=i, is_asa=False)
             objects.append(obj)
 
-        # Load properties for each object
+        # Load properties for each object.
+        # Version 6 ASA (cross-ARK / solecluster) uses ASA-style object headers
+        # but ASE-style (is_asa=False) properties. Only v7+ uses ASA properties.
+        properties_is_asa = version >= 7
         properties_block_offset = 0
         for i, obj in enumerate(objects):
             next_obj = objects[i + 1] if i + 1 < len(objects) else None
             obj.load_properties(
-                reader, properties_block_offset=properties_block_offset, is_asa=is_asa, next_object=next_obj
+                reader,
+                properties_block_offset=properties_block_offset,
+                is_asa=properties_is_asa,
+                next_object=next_obj,
             )
 
         # Build container with lookups
@@ -113,7 +125,7 @@ class CloudInventory(ArkFile):
         )
 
     @classmethod
-    def _read_asa_object_header(cls, reader: BinaryReader, obj_id: int) -> GameObject:
+    def _read_asa_object_header(cls, reader: BinaryReader, obj_id: int, version: int = 7) -> GameObject:
         """
         Read an ASA object header.
 
@@ -123,7 +135,10 @@ class CloudInventory(ArkFile):
         - Field1 (int32)
         - Field2 (int32)
         - Instance name (string)
-        - Padding (21 bytes)
+        - Padding (21 bytes for v7+, 20 bytes for v6)
+
+        Version 6 (cross-ARK / solecluster files) uses a slightly older format
+        with one fewer padding byte before the properties block.
         """
         obj = GameObject(id=obj_id)
 
@@ -142,8 +157,9 @@ class CloudInventory(ArkFile):
         instance_name = reader.read_string()
         obj.names = [instance_name] if instance_name else []
 
-        # Skip 21 bytes of padding
-        reader.skip(21)
+        # v7+ uses 21 bytes of padding; v6 (cross-ARK / solecluster) uses 20
+        padding_size = 21 if version >= 7 else 20
+        reader.skip(padding_size)
 
         # Properties offset will be set by sequential reading
         obj.properties_offset = reader.position

{arkparser-0.1.1 → arkparser-0.1.2}/arkparser.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arkparser
-Version: 0.1.1
+Version: 0.1.2
 Summary: Pure Python parser for ARK: Survival Evolved and ARK: Survival Ascended save files
 Author: Vertyco
 License-Expression: MIT

{arkparser-0.1.1 → arkparser-0.1.2}/arkparser.egg-info/SOURCES.txt

@@ -51,4 +51,5 @@ tests/test_cloud_inventory.py
 tests/test_models.py
 tests/test_profile.py
 tests/test_tribe.py
-tests/test_version_detection.py
+tests/test_version_detection.py
+tests/test_world_save.py

{arkparser-0.1.1 → arkparser-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "arkparser"
-version = "0.1.1"
+version = "0.1.2"
 description = "Pure Python parser for ARK: Survival Evolved and ARK: Survival Ascended save files"
 readme = "README.md"
 license = "MIT"

{arkparser-0.1.1 → arkparser-0.1.2}/tests/test_cloud_inventory.py

@@ -2,9 +2,10 @@
 Tests for cloud inventory (obelisk) parsing - both ASE and ASA formats.
 """
 
-import pytest
 from pathlib import Path
 
+import pytest
+
 from arkparser import CloudInventory
 
 
@@ -126,6 +127,7 @@ class TestCloudInventoryStats:
     def test_ase_base_stats_object(self, ase_obelisk_path: Path) -> None:
         """Stats should return a DinoStats object."""
         from arkparser import DinoStats
+
         inv = CloudInventory.load(ase_obelisk_path)
         creature = inv.uploaded_creatures[0]
         assert isinstance(creature.stats, DinoStats)
@@ -133,6 +135,7 @@ class TestCloudInventoryStats:
     def test_asa_base_stats_object(self, asa_obelisk_path: Path) -> None:
         """Stats should return a DinoStats object."""
         from arkparser import DinoStats
+
         inv = CloudInventory.load(asa_obelisk_path)
         creature = inv.uploaded_creatures[0]
         assert isinstance(creature.stats, DinoStats)
@@ -146,3 +149,87 @@ class TestCloudInventoryStats:
         assert "level" in d
         assert "stats" in d
 
+
+class TestASESolecluster:
+    """
+    Tests for ASE solecluster (cross-ARK transfer) files.
+
+    The solecluster directory contains 128 files; 15 are 0-byte empties.
+    All non-empty files must parse without errors.
+    """
+
+    def test_all_parse_without_errors(self, ase_solecluster_dir: Path) -> None:
+        """Every non-empty ASE solecluster file should load without raising."""
+        failures: list[str] = []
+        for f in sorted(ase_solecluster_dir.iterdir()):
+            if f.stat().st_size == 0:
+                continue
+            try:
+                CloudInventory.load(f)
+            except Exception as e:
+                failures.append(f"{f.name}: {e}")
+        assert failures == [], "Parse failures:\n" + "\n".join(failures)
+
+    def test_format_is_ase(self, ase_solecluster_dir: Path) -> None:
+        """All non-empty ASE solecluster files should be identified as ASE."""
+        for f in sorted(ase_solecluster_dir.iterdir())[:20]:
+            if f.stat().st_size == 0:
+                continue
+            inv = CloudInventory.load(f)
+            assert not inv.is_asa, f"{f.name} was wrongly detected as ASA"
+
+    def test_have_objects(self, ase_solecluster_dir: Path) -> None:
+        """Every non-empty ASE solecluster file should contain at least 1 object."""
+        for f in sorted(ase_solecluster_dir.iterdir())[:20]:
+            if f.stat().st_size == 0:
+                continue
+            inv = CloudInventory.load(f)
+            assert len(inv.objects) >= 1, f"{f.name} has no objects"
+
+    def test_nonempty_count(self, ase_solecluster_dir: Path) -> None:
+        """Sanity check: at least 100 non-empty files in the ASE solecluster dir."""
+        nonempty = [f for f in ase_solecluster_dir.iterdir() if f.stat().st_size > 0]
+        assert len(nonempty) >= 100
+
+
+class TestASASolecluster:
+    """
+    Tests for ASA solecluster (cross-ARK transfer) files.
+
+    These are version-6 ASA files: GUID-based object headers but ASE-style
+    properties. The solecluster directory contains 173 files; 35 are 0-byte empties.
+    All non-empty files must parse without errors.
+    """
+
+    def test_all_parse_without_errors(self, asa_solecluster_dir: Path) -> None:
+        """Every non-empty ASA solecluster file should load without raising."""
+        failures: list[str] = []
+        for f in sorted(asa_solecluster_dir.iterdir()):
+            if f.stat().st_size == 0:
+                continue
+            try:
+                CloudInventory.load(f)
+            except Exception as e:
+                failures.append(f"{f.name}: {e}")
+        assert failures == [], "Parse failures:\n" + "\n".join(failures)
+
+    def test_format_is_asa(self, asa_solecluster_dir: Path) -> None:
+        """All non-empty ASA solecluster files should be identified as ASA."""
+        for f in sorted(asa_solecluster_dir.iterdir())[:20]:
+            if f.stat().st_size == 0:
+                continue
+            inv = CloudInventory.load(f)
+            assert inv.is_asa, f"{f.name} was wrongly detected as ASE"
+
+    def test_have_objects(self, asa_solecluster_dir: Path) -> None:
+        """Every non-empty ASA solecluster file should contain at least 1 object."""
+        for f in sorted(asa_solecluster_dir.iterdir())[:20]:
+            if f.stat().st_size == 0:
+                continue
+            inv = CloudInventory.load(f)
+            assert len(inv.objects) >= 1, f"{f.name} has no objects"
+
+    def test_nonempty_count(self, asa_solecluster_dir: Path) -> None:
+        """Sanity check: at least 130 non-empty files in the ASA solecluster dir."""
+        nonempty = [f for f in asa_solecluster_dir.iterdir() if f.stat().st_size > 0]
+        assert len(nonempty) >= 130

arkparser-0.1.2/tests/test_world_save.py

@@ -0,0 +1,252 @@
+"""
+Comprehensive tests for WorldSave parsing across multiple maps and formats.
+
+Baselines (verified against example save files):
+  ASE Extinction  – objects=77392, tamed=37, wild=30074, pawns=65
+                    terminals=32, artifacts=3, resources=37
+  ASE Ragnarok    – objects=93194, tamed=1,  wild=1,     pawns=1245
+                    terminals=3,  artifacts=11, resources=118
+  ASA Extinction  – objects=128751, tamed=181, wild=32438, pawns=67
+                    terminals=31, artifacts=3, resources=18
+"""
+
+from pathlib import Path
+
+import pytest
+
+from arkparser import WorldSave
+from arkparser.game_objects.game_object import GameObject
+from arkparser.game_objects.location import LocationData
+
+_EXAMPLES = Path(__file__).parent.parent / "references" / "examples"
+_ASE_EXTINCTION = _EXAMPLES / "ase" / "maps" / "extinction" / "Extinction.ark"
+_ASE_RAGNAROK = _EXAMPLES / "ase" / "maps" / "ragnarok" / "Ragnarok.ark"
+_ASA_EXTINCTION = _EXAMPLES / "asa" / "maps" / "extinction" / "Extinction_WP.ark"
+
+
+# ---------------------------------------------------------------------------
+# Shared fixtures – the world-save objects are expensive to load, so we
+# cache them at module scope via session-scoped fixtures.
+# ---------------------------------------------------------------------------
+
+
+@pytest.fixture(scope="session")
+def ase_extinction() -> WorldSave:
+    return WorldSave.load(_ASE_EXTINCTION)
+
+
+@pytest.fixture(scope="session")
+def ase_ragnarok() -> WorldSave:
+    return WorldSave.load(_ASE_RAGNAROK)
+
+
+@pytest.fixture(scope="session")
+def asa_extinction() -> WorldSave:
+    return WorldSave.load(_ASA_EXTINCTION)
+
+
+# ---------------------------------------------------------------------------
+# ASE Extinction
+# ---------------------------------------------------------------------------
+
+
+class TestASEWorldSaveExtinction:
+    """Tests against the ASE Extinction world save (Extinction.ark)."""
+
+    def test_loads(self, ase_extinction: WorldSave) -> None:
+        assert ase_extinction is not None
+
+    def test_is_not_asa(self, ase_extinction: WorldSave) -> None:
+        assert not ase_extinction.is_asa
+
+    def test_object_count(self, ase_extinction: WorldSave) -> None:
+        assert len(ase_extinction.objects) == 77392
+
+    def test_zero_parse_errors(self, ase_extinction: WorldSave) -> None:
+        assert ase_extinction.parse_error_count == 0
+
+    def test_tamed_creature_count(self, ase_extinction: WorldSave) -> None:
+        assert len(ase_extinction.get_tamed_creatures()) == 37
+
+    def test_wild_creature_count(self, ase_extinction: WorldSave) -> None:
+        assert len(ase_extinction.get_wild_creatures()) == 30074
+
+    def test_player_pawn_count(self, ase_extinction: WorldSave) -> None:
+        assert len(ase_extinction.get_player_pawns()) == 65
+
+    def test_terminal_count(self, ase_extinction: WorldSave) -> None:
+        assert len(ase_extinction.get_terminals()) == 32
+
+    def test_artifact_crate_count(self, ase_extinction: WorldSave) -> None:
+        assert len(ase_extinction.get_artifact_crates()) == 3
+
+    def test_map_resource_count(self, ase_extinction: WorldSave) -> None:
+        assert len(ase_extinction.get_map_resources()) == 37
+
+    def test_supply_drops_empty(self, ase_extinction: WorldSave) -> None:
+        """No active supply drops in this save."""
+        assert len(ase_extinction.get_supply_drops()) == 0
+
+    def test_creatures_have_class_name(self, ase_extinction: WorldSave) -> None:
+        for creature in ase_extinction.get_tamed_creatures():
+            assert isinstance(creature.class_name, str)
+            assert len(creature.class_name) > 0
+
+    def test_tamed_creatures_have_location(self, ase_extinction: WorldSave) -> None:
+        for creature in ase_extinction.get_tamed_creatures():
+            assert isinstance(creature.location, LocationData)
+
+    def test_wild_creature_is_game_object(self, ase_extinction: WorldSave) -> None:
+        for c in ase_extinction.get_wild_creatures()[:10]:
+            assert isinstance(c, GameObject)
+
+    def test_terminals_have_class_name(self, ase_extinction: WorldSave) -> None:
+        for terminal in ase_extinction.get_terminals():
+            cn = terminal.class_name.lower()
+            assert "terminal" in cn or "tribute" in cn or "city" in cn
+
+    def test_artifacts_have_class_name(self, ase_extinction: WorldSave) -> None:
+        for art in ase_extinction.get_artifact_crates():
+            assert "artifact" in art.class_name.lower()
+
+    def test_resources_have_class_name(self, ase_extinction: WorldSave) -> None:
+        valid_patterns = ("oilvein", "watervein", "gasvein", "chargenode", "elementvein", "beaverdam")
+        for r in ase_extinction.get_map_resources():
+            cn = r.class_name.lower()
+            assert any(p in cn for p in valid_patterns), f"Unexpected resource class: {r.class_name}"
+
+    def test_version_is_valid_ase(self, ase_extinction: WorldSave) -> None:
+        assert ase_extinction.version in (5, 6, 7, 8, 9, 10, 11, 12)
+        assert not ase_extinction.is_asa
+
+    def test_to_dict(self, ase_extinction: WorldSave) -> None:
+        d = ase_extinction.to_dict()
+        assert isinstance(d, dict)
+        assert "version" in d
+        assert "is_asa" in d
+        assert d["is_asa"] is False
+
+
+# ---------------------------------------------------------------------------
+# ASE Ragnarok
+# ---------------------------------------------------------------------------
+
+
+class TestASEWorldSaveRagnarok:
+    """Tests against the ASE Ragnarok world save (Ragnarok.ark)."""
+
+    def test_loads(self, ase_ragnarok: WorldSave) -> None:
+        assert ase_ragnarok is not None
+
+    def test_is_not_asa(self, ase_ragnarok: WorldSave) -> None:
+        assert not ase_ragnarok.is_asa
+
+    def test_object_count(self, ase_ragnarok: WorldSave) -> None:
+        assert len(ase_ragnarok.objects) == 93194
+
+    def test_zero_parse_errors(self, ase_ragnarok: WorldSave) -> None:
+        assert ase_ragnarok.parse_error_count == 0
+
+    def test_tamed_creature_count(self, ase_ragnarok: WorldSave) -> None:
+        assert len(ase_ragnarok.get_tamed_creatures()) == 1
+
+    def test_wild_creature_count(self, ase_ragnarok: WorldSave) -> None:
+        assert len(ase_ragnarok.get_wild_creatures()) == 1
+
+    def test_player_pawn_count(self, ase_ragnarok: WorldSave) -> None:
+        assert len(ase_ragnarok.get_player_pawns()) == 1245
+
+    def test_terminal_count(self, ase_ragnarok: WorldSave) -> None:
+        assert len(ase_ragnarok.get_terminals()) == 3
+
+    def test_artifact_crate_count(self, ase_ragnarok: WorldSave) -> None:
+        assert len(ase_ragnarok.get_artifact_crates()) == 11
+
+    def test_map_resource_count(self, ase_ragnarok: WorldSave) -> None:
+        assert len(ase_ragnarok.get_map_resources()) == 118
+
+    def test_supply_drops_empty(self, ase_ragnarok: WorldSave) -> None:
+        assert len(ase_ragnarok.get_supply_drops()) == 0
+
+    def test_version_is_valid_ase(self, ase_ragnarok: WorldSave) -> None:
+        assert ase_ragnarok.version in (5, 6, 7, 8, 9, 10, 11, 12)
+        assert not ase_ragnarok.is_asa
+
+    def test_to_dict(self, ase_ragnarok: WorldSave) -> None:
+        d = ase_ragnarok.to_dict()
+        assert isinstance(d, dict)
+        assert d["is_asa"] is False
+
+
+# ---------------------------------------------------------------------------
+# ASA Extinction
+# ---------------------------------------------------------------------------
+
+
+class TestASAWorldSaveExtinction:
+    """Tests against the ASA Extinction world save (Extinction_WP.ark)."""
+
+    def test_loads(self, asa_extinction: WorldSave) -> None:
+        assert asa_extinction is not None
+
+    def test_is_asa(self, asa_extinction: WorldSave) -> None:
+        assert asa_extinction.is_asa
+
+    def test_object_count(self, asa_extinction: WorldSave) -> None:
+        assert len(asa_extinction.objects) == 128751
+
+    def test_zero_parse_errors(self, asa_extinction: WorldSave) -> None:
+        assert asa_extinction.parse_error_count == 0
+
+    def test_tamed_creature_count(self, asa_extinction: WorldSave) -> None:
+        assert len(asa_extinction.get_tamed_creatures()) == 181
+
+    def test_wild_creature_count(self, asa_extinction: WorldSave) -> None:
+        assert len(asa_extinction.get_wild_creatures()) == 32438
+
+    def test_player_pawn_count(self, asa_extinction: WorldSave) -> None:
+        assert len(asa_extinction.get_player_pawns()) == 67
+
+    def test_terminal_count(self, asa_extinction: WorldSave) -> None:
+        assert len(asa_extinction.get_terminals()) == 31
+
+    def test_artifact_crate_count(self, asa_extinction: WorldSave) -> None:
+        assert len(asa_extinction.get_artifact_crates()) == 3
+
+    def test_map_resource_count(self, asa_extinction: WorldSave) -> None:
+        assert len(asa_extinction.get_map_resources()) == 18
+
+    def test_supply_drops_empty(self, asa_extinction: WorldSave) -> None:
+        assert len(asa_extinction.get_supply_drops()) == 0
+
+    def test_creatures_have_class_name(self, asa_extinction: WorldSave) -> None:
+        for creature in asa_extinction.get_tamed_creatures()[:10]:
+            assert isinstance(creature.class_name, str)
+            assert len(creature.class_name) > 0
+
+    def test_tamed_creatures_have_location(self, asa_extinction: WorldSave) -> None:
+        for creature in asa_extinction.get_tamed_creatures()[:10]:
+            assert isinstance(creature.location, LocationData)
+
+    def test_terminals_have_class_name(self, asa_extinction: WorldSave) -> None:
+        for terminal in asa_extinction.get_terminals():
+            cn = terminal.class_name.lower()
+            assert "terminal" in cn or "tribute" in cn or "city" in cn
+
+    def test_artifacts_have_class_name(self, asa_extinction: WorldSave) -> None:
+        for art in asa_extinction.get_artifact_crates():
+            assert "artifact" in art.class_name.lower()
+
+    def test_resources_have_class_name(self, asa_extinction: WorldSave) -> None:
+        valid_patterns = ("oilvein", "watervein", "gasvein", "chargenode", "elementvein", "beaverdam")
+        for r in asa_extinction.get_map_resources():
+            cn = r.class_name.lower()
+            assert any(p in cn for p in valid_patterns), f"Unexpected resource class: {r.class_name}"
+
+    def test_version_is_asa(self, asa_extinction: WorldSave) -> None:
+        assert asa_extinction.version >= 7
+
+    def test_to_dict(self, asa_extinction: WorldSave) -> None:
+        d = asa_extinction.to_dict()
+        assert isinstance(d, dict)
+        assert d["is_asa"] is True