pylitematic 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

pylitematic/resource_location.py

@@ -50,8 +50,8 @@ class ResourceLocation:
     def to_string(self) -> str:
         return str(self)
 
-    @staticmethod
-    def from_string(string: str) -> ResourceLocation:
+    @classmethod
+    def from_string(cls, string: str) -> ResourceLocation:
         match = LOCATION_PATTERN.fullmatch(string)
         if not match:
             raise ValueError(f"Invalid resource location string {string!r}")
@@ -59,15 +59,11 @@ class ResourceLocation:
         namespace = match.group("namespace")
         path = match.group("path")
 
-        return ResourceLocation(path=path, namespace=namespace)
+        return cls(path=path, namespace=namespace)
 
     def to_nbt(self) -> nbtlib.String:
         return nbtlib.String(self)
 
-    @staticmethod
-    def from_nbt(nbt: nbtlib.String) -> ResourceLocation:
-        return ResourceLocation.from_string(str(nbt))
-
-
-class BlockId(ResourceLocation):
-    ...
+    @classmethod
+    def from_nbt(cls, nbt: nbtlib.String) -> ResourceLocation:
+        return cls.from_string(str(nbt))

pylitematic/schematic.py

@@ -9,7 +9,8 @@ import twos
 from typing import Iterator
 
 from pylitematic.geometry import BlockPosition, Size3D
-from pylitematic.region import Region
+from pylitematic.region import AIR, Region
+from pylitematic.block_state import AIR
 
 
 DEFAULT_VERSION_MAJOR: int = 7
@@ -70,12 +71,11 @@ class Schematic:
         self._created_at = round(time.time() * 1000)
         self._modified_at = self._created_at
 
+        # TODO: use packaging.version.Version
         self.version_major = version_major
         self.version_minor = version_minor
         self.mc_version = mc_version
 
-        self.modified: bool = True
-
     def __getitem__(self, key):
         return self._regions[key]
 
@@ -104,10 +104,11 @@ class Schematic:
 
     @property
     def bounds(self) -> tuple[BlockPosition, BlockPosition]:
+        # TODO: make cached and update on region add / remove
         lowers = []
         uppers = []
         for reg in self._regions.values():
-            lower, upper = reg.global_bounds
+            lower, upper = reg.world.bounds
             lowers.append(lower)
             uppers.append(upper)
         return (
@@ -121,7 +122,8 @@ class Schematic:
 
     @property
     def blocks(self) -> int:
-        return sum(reg.block_count for reg in self._regions.values())
+        return sum(
+            reg.volume - reg.count(AIR) for reg in self._regions.values())
 
     @property
     def region_count(self) -> int:
@@ -142,9 +144,11 @@ class Schematic:
 
     def add_region(self, name: str, region: Region) -> None:
         self._regions[name] = region
+        # TODO: re-calculate bounding box
 
     def remove_region(self, name: str) -> Region:
         return self._regions.pop(name)
+        # TODO: re-calculate bounding box
 
     @property
     def created_at(self) -> datetime:
@@ -154,19 +158,26 @@ class Schematic:
     def modified_at(self) -> datetime:
         return datetime.fromtimestamp(int(self._modified_at / 1000))
 
+    def clear(self) -> None:
+        self._regions = {}
+
     def save(self, path: pathlib.Path | str) -> None:
+        self._modified_at = int(time.time() * 1000)
         file = nbtlib.File(self.to_nbt())
         file.save(path, gzipped=True, byteorder="big")
 
-    @staticmethod
-    def load(path: pathlib.Path | str) -> Schematic:
+    @classmethod
+    def load(cls, path: pathlib.Path | str) -> Schematic:
         if isinstance(path, str):
             path = pathlib.Path(path)
         nbt = nbtlib.File.load(path.expanduser(), True)
-        return Schematic.from_nbt(nbt)
+        return cls.from_nbt(nbt)
 
     def to_nbt(self) -> nbtlib.Compound:
-        # self._update()
+        if not self.region_count:
+            raise ValueError(
+                f"Schematic {self.name!r} needs at least one region")
+
         nbt = nbtlib.Compound()
 
         # meta data
@@ -190,7 +201,7 @@ class Schematic:
         # regions
         regions = nbtlib.Compound()
         for name, region in self.regions():
-            region.compact_palette()
+            region.reduce_palette()
             regions[name] = region.to_nbt()
         nbt["Regions"] = regions
 
@@ -202,8 +213,8 @@ class Schematic:
 
         return nbt
 
-    @staticmethod
-    def from_nbt(nbt: nbtlib.Compound) -> Schematic:
+    @classmethod
+    def from_nbt(cls, nbt: nbtlib.Compound) -> Schematic:
         # meta data
         try:
             meta = nbt["Metadata"]
@@ -247,7 +258,7 @@ class Schematic:
 
         mc_version = nbt.get("MinecraftDataVersion")
 
-        schem = Schematic(
+        schem = cls(
             name=name,
             author=author,
             description=desc,

pylitematic/test.py

@@ -1,71 +1,79 @@
-import numpy as np
-import pathlib
-from pylitematic import BlockPosition, BlockId, BlockState, Region, Schematic, Size3D
+from pylitematic import (
+    BlockPosition,
+    BlockId,
+    BlockState,
+    Region,
+    Schematic,
+    Size3D,
+)
 
-# path = pathlib.Path("/mnt/d/minecraft/schematics/Litematica/test/subs.litematic")
-# path = pathlib.Path("/mnt/d/minecraft/schematics/Litematica/test/regions.litematic")
-# path = pathlib.Path("/mnt/d/minecraft/schematics/Litematica/test/creeper_test.litematic")
-# stone = BlockState.from_string("minecraft:stone")
-# dirt = BlockState.from_string("minecraft:dirt")
-# s = Schematic.load(path)
-# print(f"{s.volume=} {s.size=} {s.bounds=}")
-# for name, reg in s.regions():
-#     print(name)
-#     print(f"\t{reg.shape=} {reg.volume=} {reg.block_count=}")
-#     print(f"\t{reg.origin=!s} {reg.limit=!s}")
-#     print(f"\t{reg.start=!s} {reg.end=!s}")
-#     print(f"\t{reg.lower=!s} {reg.upper=!s} {reg.size=}")
-#     # print(f"\t{reg[..., 1, 0]}")
-#     # print(f"\t{reg[:][1][0]}")
-#     # print(f"\t{reg[BlockPosition(0, 1, 0)]}")
-#     # reg[1,1,1] = BlockState.from_string("minecraft:stone")
-#     # print("lol: ", reg[reg.end])
-#     # reg[0,:,0] = BlockState("minecraft:obsidian")
-#     # reg[0,:,0] = [dirt, stone, dirt]
-#     # print(reg[...,0])
-#     # print(reg[np.array([BlockPosition(0, 0, 0), BlockPosition(1, 1, 1)])])
-#     # print(f"\t{reg[:]}")
-#     # for pos, state in reg.blocks(exclude_air=True):
-#     #     print(pos, state)
-#     # for pos, state in reg.blocks((BlockState("oak_log", axis="x"), BlockState("spruce_log", axis="z")), ignore_props=True):
-#     # reg[...,-1] = stone
-#     for pos, state in reg.blocks(exclude=BlockState("air")):
-#         print(f"\t{pos} {reg._to_internal(pos)}: {state}")
-#     for pos, state in reg.blocks(include=BlockState("lime_wool")):
-#         reg[pos] = BlockState("minecraft:blue_wool")
-#     for pos, state in reg.blocks(include=BlockState("tripwire"), ignore_props=True):
-#         reg[pos] = BlockState("minecraft:glass")
-#     # print(BlockState("oak_log", axis="x") in reg)
-#     # print(BlockPosition(1, 1, 0) in reg)
-#     # print(ResourceLocation("birch_log") in reg)
-#     # print(reg[0,:,2])
-# s.save("/mnt/d/minecraft/schematics/Litematica/test/aaa.litematic")
 
 air = BlockState("air")
 stone = BlockState("stone")
 dirt = BlockState("dirt")
 grass = BlockState("grass_block")
-cobble = BlockState("mossy_cobblestone")
+water = BlockState("water")
+lava = BlockState("lava")
+sand = BlockState("sand")
+
+cobble = BlockState("cobblestone")
+mossy_cobble = BlockState("mossy_cobblestone")
+
 snow = BlockState("snow_block")
+ice = BlockState("ice")
 pumpkin = BlockState("carved_pumpkin", facing="west")
+jack = BlockState("jack_o_lantern", facing="west")
 
-ground = Region(size=Size3D(16, 9, 16), origin=BlockPosition(0, 0, 0))
-ground[:,:5,:] = stone
-ground[:,5:8,:] = dirt
-ground[:,8:,:] = grass
+ground = Region(size=Size3D(16, 9, 16))
+ground.local[:,:5,:] = stone # 4 stone layers
+ground.local[:,5:8,:] = dirt # 3 dirt layers
+ground[(ground > dirt) & (ground == BlockId("air"))] = grass # grass above exposed dirt
+ground.numpy[2:5,-1,2:5] = water # small pond
+ground[ground.relative_to(water, BlockPosition(4, 0, 0))] = lava # lava pool
 
 boulder = Region(size=(4, 4, 4), origin=ground.origin+[6, ground.height, 6])
-boulder[:] = cobble
+boulder[:] = mossy_cobble # fill with mossy cobblestone
+boulder.numpy[:,-2:,:] = cobble # upper two layers of cobblestone
+
+snow_man = Region(
+    size=(1, -3, 1), origin=boulder.origin+[2, boulder.upper.y+3, 1])
+snow_man.set_default_view(snow_man.numpy)
+snow_man[...] = snow # fill with snow
+snow_man[0,-1,0] = pumpkin # pumpkin on top
 
-# snow_man = Region(size=(1, 3, 1), origin=boulder.origin+[1, boulder.height, 1])
-snow_man = Region(size=(-1, -3, -1), origin=boulder.origin+[1, boulder.height+2, 1])
-snow_man[:] = snow
-snow_man[0,snow_man.upper.y,0] = pumpkin
+snow_woman = snow_man.copy(origin=snow_man.origin+[-1, 0, 1])
+# snow_woman[snow_woman == snow] = ice # replace snow with ice
+snow_woman.where(snow, ice, jack) # replace snow with ice and rest with lanterns
 
-schem = Schematic(name="scene", author="Boscawinks", description="A simple scene")
+clones = []
+start = BlockPosition(1, ground.upper.y, ground.upper.z-1)
+for i in range(5):
+    clones.append(
+        snow_man.copy(origin=start+(i * 3, 3, -i)))
+
+cuboid = Region(origin=(14, ground.upper.y+3, 4), size=(-2,-3,-4))
+cuboid[:,-2:0,:] = sand
+cuboid.where((cuboid < air) & (cuboid == sand), stone)
+for pos, block in cuboid.numpy.items():
+    print(f"{pos}:\t{block}")
+
+schem = Schematic(
+    name="a_scene", author="Boscawinks", description="A simple scene")
 schem.add_region("ground", ground)
 schem.add_region("boulder", boulder)
 schem.add_region("snow_man", snow_man)
-schem.save(f"/mnt/d/minecraft/schematics/Litematica/test/{schem.name}.litematic")
+schem.add_region("snow_woman", snow_woman)
+for i, clone in enumerate(clones):
+    schem.add_region(f"clone_{i+1}", clone)
+schem.add_region("cuboid", cuboid)
+schem.save(
+    f"/mnt/d/minecraft/schematics/Litematica/test/{schem.name}.litematic")
+
+# print(boulder[...,-1])
 
-print(snow_man == snow)
+# from pathlib import Path
+# path = Path("/mnt/d/minecraft/schematics/Litematica/turtle/turtle_8x8.litematic")
+# turtle = Schematic.load(path)
+# for name, reg in turtle.regions():
+#     reg[reg != BlockState("air")] = BlockState("blue_wool")
+# turtle.save(path.with_suffix(".blue.litematic"))

{pylitematic-0.0.3.dist-info → pylitematic-0.0.5.dist-info}/METADATA

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: pylitematic
-Version: 0.0.3
+Version: 0.0.5
 Summary: Load, modify, and save Litematica schematics
 Author-email: Boscawinks <bosca.winks@gmx.de>
 License: GPL-3.0-only
 Project-URL: Homepage, https://github.com/boscawinks/pylitematic
 Project-URL: Repository, https://github.com/boscawinks/pylitematic
 Project-URL: Issues, https://github.com/boscawinks/pylitematic/issues
+Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Utilities
 Requires-Python: >=3.10.12
 Description-Content-Type: text/markdown
 Requires-Dist: bitpacking>=0.1.0

pylitematic-0.0.5.dist-info/RECORD

@@ -0,0 +1,14 @@
+pylitematic/__init__.py,sha256=KlmeOfpqQ64bSbOTEj2IcLwARfwzg3kTbUtBpRAgpU0,188
+pylitematic/block_palette.py,sha256=9k1rzLgmoUK2jkuKo4v0nuE37wVFvDF3jja59NqYY_Y,4280
+pylitematic/block_property.py,sha256=HGxDSngEr-tcwuZPGn6ohHQQ65OL4MaTP9ytDAvuSCw,7714
+pylitematic/block_state.py,sha256=4CQ5V6dbXuGY3vRp2wXJCqPIV9xIHZbuzJ7JgY7oLA4,4064
+pylitematic/geometry.py,sha256=gPsvjnp6tSpQ1uA9hbsKO4EdjdMuxV2wm6KwxFaedSQ,4211
+pylitematic/property_cache.py,sha256=BFY-fh6xDBpJTZ2QBndeJKYVAObVwMLA4TYfXiiCBcA,1358
+pylitematic/region.py,sha256=_08u-lbR3MxBQIngRZq-72lS9X73ynUR1Vpu0J_jtN4,20468
+pylitematic/resource_location.py,sha256=VgTPayrTc0xJNM6smG9vseajFGVccL2wwtLKUyG9qYo,2125
+pylitematic/schematic.py,sha256=Nm7gV6e0ayYSJK8lhcjnm5_c5KGC-MSRTzpTbqfvKcA,8367
+pylitematic/test.py,sha256=9OQzQONGjs6TqyinwdSk6o9yysXe2EKSiOeHM45hGIM,2663
+pylitematic-0.0.5.dist-info/METADATA,sha256=dOGSClod9zp_e8LFQiNHDKM8lzZNE7QIxNZCXyoaT6I,1159
+pylitematic-0.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pylitematic-0.0.5.dist-info/top_level.txt,sha256=sYUxm6O7Dh5TzuP-kPFe2FHJWUuwHFO69vN2VBiEG4A,12
+pylitematic-0.0.5.dist-info/RECORD,,

pylitematic-0.0.3.dist-info/RECORD

@@ -1,12 +0,0 @@
-pylitematic/__init__.py,sha256=-yLTtTzD7kRpeKMbUTYNy67zkFkxUP8V1DnPXhS3ZFY,202
-pylitematic/block_property.py,sha256=4wwsQrxyNGDcrktpd4tD0Vzv-a1OxWYMj0H05GDiT-I,7739
-pylitematic/block_state.py,sha256=tMRoY6jPtt2M85DR9U9dnQh2Ukp6pP_65xXzMIFeUEo,3546
-pylitematic/geometry.py,sha256=kt2buIJovAymAtaGQYmmWj7ypOt1xI8s--LHkbTPUlM,5399
-pylitematic/region.py,sha256=0bUcK9oVyhNDzfxTjZmVLwMddrIdxvJX-cXkWL8BRSE,11097
-pylitematic/resource_location.py,sha256=gHVE1RTRHtc8DWSlXa0WUom68tRlJy8LU5dOzuONV98,2186
-pylitematic/schematic.py,sha256=SLz4NQNBJkLXV9Oj0fVOE-daP4MRsdYAnnl1vKzJv_Q,7928
-pylitematic/test.py,sha256=9uch5L58o9QVJI50jUcbuulEswYzDgtYnRiIP991jFo,3162
-pylitematic-0.0.3.dist-info/METADATA,sha256=ES-4UDWi6DQU6fCSNrgf5FLMDX_jh1g7k6kx9fmiX70,1033
-pylitematic-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pylitematic-0.0.3.dist-info/top_level.txt,sha256=sYUxm6O7Dh5TzuP-kPFe2FHJWUuwHFO69vN2VBiEG4A,12
-pylitematic-0.0.3.dist-info/RECORD,,