koro 1.0.7__py3-none-any.whl → 1.0.8__py3-none-any.whl

koro/item/group.py

@@ -0,0 +1,45 @@
+from abc import ABC
+from collections.abc import Iterable, Sequence
+from typing import Final, Generic, Optional, TypeVar
+
+from .level import Level, LevelNotFoundError
+
+_L = TypeVar("_L", bound=Level)
+
+
+class Group(ABC, Generic[_L], Sequence[_L]):
+    """A group of 20 levels.
+    Note that levels are 0-indexed within this interface, but 1-indexed in-game.
+    """
+
+    __slots__ = ()
+
+    def fill_mask(self) -> Sequence[bool]:
+        """Return which level IDs within this Group exist."""
+        return [bool(l) for l in self]
+
+    def __len__(self) -> int:
+        return 20
+
+    def read(self) -> Iterable[Optional[bytes]]:
+        """Read all of the levels within this Group. Empty slots yield None."""
+        content: Optional[bytes]
+        result: Final[list[Optional[bytes]]] = []
+        for level in self:
+            try:
+                content = level.read()
+            except LevelNotFoundError:
+                content = None
+            result.append(content)
+        return result
+
+    def write(self, new_content: Iterable[Optional[bytes]], /) -> None:
+        """Replace the contents of this Group with the specified new content. None values will empty the slot they correspond to."""
+        for src, dest in zip(new_content, self, strict=True):
+            if src is None:
+                try:
+                    dest.delete()
+                except LevelNotFoundError:
+                    pass
+            else:
+                dest.write(src)

koro/item/level.py

@@ -0,0 +1,100 @@
+from abc import ABC, abstractmethod
+from collections.abc import Sized
+from dataclasses import dataclass
+from enum import Enum, unique
+from typing import Final
+
+
+@unique
+class Theme(Enum):
+    THE_EMPTY_LOT = 0
+    NEIGHBORS_HOUSE = 1
+    SIZZLIN_DESERT = 2
+    CHILL_MOUNTAIN = 3
+    OCEAN_TREASURE = 4
+    SPACE_STATION = 5
+    STUMP_TEMPLE = 6
+    CANDY_ISLAND = 7
+    HAUNTED_HOUSE = 8
+    CITY = 9
+    TUTORIAL = 11
+    HAUNTED_HOUSE_DARKNESS = 12
+    NIGHT_CITY = 13
+
+    def __str__(self) -> str:
+        return (
+            "The Empty Lot",
+            "Neighbor's House",
+            "Sizzlin' Desert",
+            "Chill Mountain",
+            "Ocean Treasure",
+            "Space Station",
+            "Stump Temple",
+            "Candy Island",
+            "Haunted House",
+            "City",
+            None,
+            "Tutorial",
+            "Haunted House Darkness",
+            "Night City",
+        )[self.value]
+
+
+@dataclass(frozen=True, match_args=False, kw_only=True, slots=True)
+class LevelStatistics:
+    crystals: int
+    filesize: int
+    theme: Theme
+
+
+class LevelNotFoundError(LookupError):
+    pass
+
+
+class Level(ABC, Sized):
+    __slots__ = ()
+
+    def about(self) -> LevelStatistics:
+        content: Final[bytes] = self.read()
+        return LevelStatistics(
+            crystals=content.count(b"<anmtype> 49 </anmtype>"),
+            filesize=len(content),
+            theme=Theme(int(content[87:89])),
+        )
+
+    @abstractmethod
+    def __bool__(self) -> bool:
+        """Return whether this level exists."""
+
+    @abstractmethod
+    def delete(self) -> None:
+        """Delete this level if it exists, otherwise raise LevelNotFoundError."""
+        pass
+
+    def encode(self) -> bytes:
+        """Return a bytes object that when written to a file can overwrite an official level."""
+        data: Final[bytearray] = bytearray(self.read())
+        header: Final[bytes] = (
+            b"\x00\x00\x00\x01\x00\x00\x00\x08"
+            + len(data).to_bytes(4, "big")
+            + b"\x00\x00\x00\x01"
+        )
+        i: int = 0
+        while i < len(data):
+            data.insert(i, 255)
+            i += 9
+        return header + data + b"\x00"
+
+    def __len__(self) -> int:
+        """The file size of this level."""
+        return len(self.read())
+
+    @abstractmethod
+    def read(self) -> bytes:
+        """Return the contents of this level if it exists, otherwise raise LevelNotFoundError."""
+        pass
+
+    @abstractmethod
+    def write(self, new_content: bytes, /) -> None:
+        """Replace the contents of this level, or create it if it doesn't exist."""
+        pass

koro/item/save.py

@@ -0,0 +1,27 @@
+from abc import ABC
+from collections.abc import Iterator, Mapping
+from enum import Enum, unique
+from typing import Generic, TypeGuard, TypeVar
+
+from .group import Group
+
+_G = TypeVar("_G", bound=Group)
+
+
+@unique
+class Page(Enum):
+    ORIGINAL = 0
+    FRIEND = 1
+
+
+class Save(ABC, Generic[_G], Mapping[Page, _G]):
+    __slots__ = ()
+
+    def __contains__(self, key: object, /) -> TypeGuard[Page]:
+        return isinstance(key, Page)
+
+    def __iter__(self) -> Iterator[Page]:
+        return iter(Page)
+
+    def __len__(self) -> int:
+        return 2

{koro-1.0.7.dist-info → koro-1.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: koro
-Version: 1.0.7
+Version: 1.0.8
 Summary: Tools for manipulating levels made in Marble Saga: Kororinpa
 Home-page: https://github.com/DigitalDetective47/koro
 Author: DigitalDetective47

koro-1.0.8.dist-info/RECORD

@@ -0,0 +1,14 @@
+koro/__init__.py,sha256=clmcgzd33gY_tOC3U5U-010NYVZZrC-9Og6AYAovIjo,176
+koro/file/__init__.py,sha256=_UIx5h1YBoheqQeorBV5XrbZXusAOipbFsesqUeLJwk,948
+koro/file/dir.py,sha256=sxNM_COlADES3oVnlutApXPd2SvWuANRnxMC6RdQ448,6348
+koro/file/lvl.py,sha256=cxOJGuzzs3yVTAdi-clhXPn1A7-TU3p-FJW3JLZBTyY,752
+koro/file/zip.py,sha256=hK8XemvmM3dhyNPevCt9lXm0p24HYbzyHp40yA5O5cg,5472
+koro/item/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+koro/item/group.py,sha256=TfiC2okh-fIVPics7VxOWEIP3-8K0ixDBIOl9yTjBkE,1515
+koro/item/level.py,sha256=opGy-JnytnsXGYEZDQky9bTwAr_oJFq1mrQsOAr6pOs,2723
+koro/item/save.py,sha256=vwI2b1iUs976ZgTIt3hFxpJajGrGZugDhUxkS7Zl4SE,577
+koro-1.0.8.dist-info/LICENSE,sha256=Q2ptU2E48gOsMzhYz_kqVovmJ5d1KzrblLyqD2_-fvY,1235
+koro-1.0.8.dist-info/METADATA,sha256=Vg519VHrxWxDCrFoTmEnBLtQbTXeflX7UvIvmmS-qfA,628
+koro-1.0.8.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+koro-1.0.8.dist-info/top_level.txt,sha256=Msq6ssMwv56hnBQqwaTdJJkxM7x7BZ-3JfQbkepQAEY,5
+koro-1.0.8.dist-info/RECORD,,

koro-1.0.7.dist-info/RECORD

@@ -1,10 +0,0 @@
-koro/__init__.py,sha256=clmcgzd33gY_tOC3U5U-010NYVZZrC-9Og6AYAovIjo,176
-koro/file/__init__.py,sha256=_UIx5h1YBoheqQeorBV5XrbZXusAOipbFsesqUeLJwk,948
-koro/file/dir.py,sha256=sxNM_COlADES3oVnlutApXPd2SvWuANRnxMC6RdQ448,6348
-koro/file/lvl.py,sha256=cxOJGuzzs3yVTAdi-clhXPn1A7-TU3p-FJW3JLZBTyY,752
-koro/file/zip.py,sha256=hK8XemvmM3dhyNPevCt9lXm0p24HYbzyHp40yA5O5cg,5472
-koro-1.0.7.dist-info/LICENSE,sha256=Q2ptU2E48gOsMzhYz_kqVovmJ5d1KzrblLyqD2_-fvY,1235
-koro-1.0.7.dist-info/METADATA,sha256=crpDh19AkPI1uTIzGUGA1Qr84CvGVhNVUc5DIJchWYI,628
-koro-1.0.7.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-koro-1.0.7.dist-info/top_level.txt,sha256=Msq6ssMwv56hnBQqwaTdJJkxM7x7BZ-3JfQbkepQAEY,5
-koro-1.0.7.dist-info/RECORD,,