Checkpoint initial implementation

tungston/generator/datapack/__init__.py

@@ -0,0 +1,14 @@
+import os
+
+
+# Class ############################################################################################
+
+class Datapack:
+
+    def __init__(self, path:str):
+        self.path = path
+
+    @property
+    def name(self) -> str:
+        return os.path.basename(self.path)
+

tungston/generator/datapack/blockstate.py

@@ -0,0 +1,18 @@
+from typing import Any
+
+
+# Class ############################################################################################
+
+class BlockState:
+
+    def __init__(self, blockId:str, properties:dict[str,str]=None):
+        self.blockId = blockId
+        self.properties = properties
+
+    def asData(self) -> dict[str,Any]:
+        result = { "Name": self.blockId }
+
+        if self.properties:
+            result["Properties"] = self.properties
+
+        return result

tungston/generator/datapack/blockstate_test.py

@@ -0,0 +1,20 @@
+from pytest import fixture
+from tungston.generator.datapack.blockstate import BlockState
+
+
+# Fixtures #########################################################################################
+
+@fixture(name="state")
+def createBlockState():
+    yield BlockState("minecraft:button", {"waterlogged": "true"})
+
+
+# Tests ############################################################################################
+
+def test_asData(state):
+    assert state.asData() == {
+        "Name": "minecraft:button",
+        "Properties": {
+            "waterlogged": "true"
+        }
+    }

tungston/generator/datapack/blockstateprovider/__init__.py

@@ -0,0 +1,7 @@
+# Class ############################################################################################
+
+class BlockStateProvider:
+
+    def __init__(self, gameId:str):
+        self.gameId = gameId
+

tungston/generator/datapack/blockstateprovider/simplestateprovider.py

@@ -0,0 +1,18 @@
+from tungston.generator.datapack.blockstate import BlockState
+from tungston.generator.datapack.blockstateprovider import BlockStateProvider
+from typing import Any
+
+
+# Class ############################################################################################
+
+class SimpleStateProvider(BlockStateProvider):
+
+    def __init__(self, state:BlockState):
+        super().__init__("minecraft:simple_state_provider")
+        self.state = state
+
+    def asData(self) -> dict[str, Any]:
+        return {
+            "type": self.gameId,
+            "state": self.state.asData(),
+        }

tungston/generator/datapack/blockstateprovider/simplestateprovider_test.py

@@ -0,0 +1,28 @@
+from tungston.generator.datapack.blockstate import BlockState
+from tungston.generator.datapack.blockstateprovider.simplestateprovider import SimpleStateProvider
+from pytest import fixture
+
+
+# Fixtures #########################################################################################
+
+@fixture(name="state")
+def createBlockState():
+    yield BlockState("minecraft:button", {"waterlogged": "true"})
+
+@fixture(name="provider")
+def createProvider(state):
+    return SimpleStateProvider(state)
+
+
+# Tests ############################################################################################
+
+def test_asData(provider):
+    assert provider.asData() == {
+        "type": "minecraft:simple_state_provider",
+        "state": {
+            "Name": "minecraft:button",
+            "Properties": {
+                "waterlogged": "true"
+            }
+        }
+    }

tungston/generator/datapack/configuredfeature/__init__.py

@@ -0,0 +1,6 @@
+# Class ############################################################################################
+
+class ConfiguredFeature:
+
+    def __init__(self, gameId:str):
+        self.gameId = gameId

tungston/generator/datapack/configuredfeature/randompatch.py

@@ -0,0 +1,31 @@
+from tungston.generator.datapack.configuredfeature.configuredfeature import ConfiguredFeature
+from typing import Any
+
+
+# Class ############################################################################################
+
+class RandomPatch(ConfiguredFeature):
+
+    def __init__(
+        self,
+        gameId:str,
+        feature:"PlacedFeature",
+        tries:int=128,
+        xzSpread:int=7,
+        ySpread:int=3,
+    ):
+        super().__init__("minecraft:random_patch")
+
+        self.feature = feature
+        self.tries = tries
+        self.xzSpread = xzSpread
+        self.ySpread = ySpread
+
+    def asData(self) -> dict[str,Any]:
+        return {
+            "type": self.type,
+            "feature": self.feature.gameId,
+            "tries": self.tries,
+            "xz_spread": self.xySpread,
+            "y_spread": self.ySpread
+        }

tungston/generator/datapack/configuredfeature/randompatch_test.py

@@ -0,0 +1,38 @@
+from pytest import fixture
+from tungston.generator.datapack.blockstate import BlockState
+from tungston.generator.datapack.blockstateprovider.simplestateprovider import SimpleStateProvider
+from tungston.generator.datapack.configuredfeature.simpleblock import SimpleBlock
+
+
+# Fixtures #########################################################################################
+
+@fixture(name="state")
+def createBlockState():
+    yield BlockState("minecraft:button", {"waterlogged": "true"})
+
+@fixture(name="provider")
+def createProvider(state):
+    return SimpleStateProvider(state)
+
+@fixture(name="feature")
+def createSimpleBlockFeature(provider):
+    return SimpleBlock(provider)
+
+
+# Tests ############################################################################################
+
+def test_asData(feature):
+    assert feature.asData() == {
+        "type": "minecraft:simple_block",
+        "config": {
+            "to_place": {
+                "type": "minecraft:simple_state_provider",
+                "state": {
+                    "Name": "minecraft:button",
+                    "Properties": {
+                        "waterlogged": "true"
+                    }
+                }
+            }
+        }
+    }

tungston/generator/datapack/configuredfeature/simpleblock.py

@@ -0,0 +1,20 @@
+from tungston.generator.datapack.blockstateprovider import BlockStateProvider
+from tungston.generator.datapack.configuredfeature import ConfiguredFeature
+from typing import Any
+
+
+# Class ############################################################################################
+
+class SimpleBlock(ConfiguredFeature):
+
+    def __init__(self, toPlace:BlockStateProvider):
+        super().__init__("minecraft:simple_block")
+        self.toPlace = toPlace
+
+    def asData(self) -> dict[str, Any]:
+        return {
+            "type": self.gameId,
+            "config": {
+                "to_place": self.toPlace.asData()
+            }
+        }

tungston/generator/datapack/configuredfeature/simpleblock_test.py

@@ -0,0 +1,38 @@
+from pytest import fixture
+from tungston.generator.datapack.blockstate import BlockState
+from tungston.generator.datapack.blockstateprovider.simplestateprovider import SimpleStateProvider
+from tungston.generator.datapack.configuredfeature.simpleblock import SimpleBlock
+
+
+# Fixtures #########################################################################################
+
+@fixture(name="state")
+def createBlockState():
+    yield BlockState("minecraft:button", {"waterlogged": "true"})
+
+@fixture(name="provider")
+def createProvider(state):
+    return SimpleStateProvider(state)
+
+@fixture(name="feature")
+def createSimpleBlockFeature(provider):
+    return SimpleBlock(provider)
+
+
+# Tests ############################################################################################
+
+def test_asData(feature):
+    assert feature.asData() == {
+        "type": "minecraft:simple_block",
+        "config": {
+            "to_place": {
+                "type": "minecraft:simple_state_provider",
+                "state": {
+                    "Name": "minecraft:button",
+                    "Properties": {
+                        "waterlogged": "true"
+                    }
+                }
+            }
+        }
+    }

tungston/generator/datapack/heightmaptype.py

@@ -0,0 +1,24 @@
+# Class ############################################################################################
+
+class HeightMapType:
+    """
+    A cached record of the top block at all points in the world.
+
+    see: https://minecraft.wiki/w/Heightmap
+    """
+
+    def __init__(self, gameId:str):
+        self.gameId = gameId
+
+    def asData(self) -> str:
+        return self.gameId
+
+
+# Constants ########################################################################################
+
+MOTION_BLOCKING           = HeightMapType("MOTION_BLOCKING")
+MOTION_BLOCKING_NO_LEAVES = HeightMapType("MOTION_BLOCKING_NO_LEAVES")
+OCEAN_FLOOR               = HeightMapType("OCEAN_FLOOR")
+OCEAN_FLOOR_WG            = HeightMapType("OCEAN_FLOOR_WG")
+WORLD_SURFACE             = HeightMapType("WORLD_SURFACE")
+WORLD_SURFACE_WG          = HeightMapType("WORLD_SURFACE_WG")

tungston/generator/datapack/heightmaptype_test.py

@@ -0,0 +1,7 @@
+from tungston.generator.datapack.heightmaptype import HeightMapType
+
+
+# Tests ############################################################################################
+
+def test_syntax():
+    pass

tungston/generator/datapack/placedfeature.py

@@ -0,0 +1,6 @@
+# Class ############################################################################################
+
+class PlacedFeature:
+
+    def __init__(self, gameId:str):
+        self.gameId = gameId

tungston/generator/datapack/placedfeature_test.py

@@ -0,0 +1,6 @@
+from tungston.generator.datapack.placedfeature import PlacedFeature
+
+# Tests ############################################################################################
+
+def test_syntax():
+    pass

tungston/generator/datapack/placement/__init__.py

@@ -0,0 +1,6 @@
+# Class ############################################################################################
+
+class Placement:
+
+    def __init__(self, gameId:str):
+        self.gameId = gameId

tungston/generator/datapack/placement/biome.py

@@ -0,0 +1,13 @@
+from tungston.generator.datapack.placement import Placement
+from typing import Any
+
+# Class ############################################################################################
+
+class Biome(Placement):
+
+    def __init__(self):
+        super().__init__("minecraft:biome")
+
+    def asData(self) -> dict[str,Any]:
+        return { "type": self.gameId }
+

tungston/generator/datapack/placement/biome_test.py

@@ -0,0 +1,18 @@
+from pytest import fixture
+from tungston.generator.datapack.placement.biome import Biome
+
+
+# Fixtures #########################################################################################
+
+@fixture(name="placement")
+def createPlacement():
+    yield Biome()
+
+
+# Tests ############################################################################################
+
+def test_asData(placement):
+    assert placement.asData() == {
+        "type": "minecraft:biome",
+    }
+

tungston/generator/datapack/placement/heightmap.py

@@ -0,0 +1,17 @@
+from tungston.generator.datapack.placement import Placement
+from tungston.generator.datapack.heightmaptype import HeightMapType
+from typing import Any
+
+# Class ############################################################################################
+
+class HeightMap(Placement):
+
+    def __init__(self, heightMap:HeightMapType):
+        super().__init__("minecraft:heightmap")
+        self.heightMap = heightMap
+
+    def asData(self) -> dict[str,Any]:
+        return {
+            "type": self.gameId,
+            "heightmap": self.heightMap.asData()
+        }

tungston/generator/datapack/placement/heightmap_test.py

@@ -0,0 +1,20 @@
+from pytest import fixture
+from tungston.generator.datapack.placement.heightmap import HeightMap
+from tungston.generator.datapack.heightmaptype import WORLD_SURFACE
+
+
+# Fixtures #########################################################################################
+
+@fixture(name="placement")
+def createPlacement():
+    yield HeightMap(WORLD_SURFACE)
+
+
+# Tests ############################################################################################
+
+def test_asData(placement):
+    assert placement.asData() == {
+        "type": "minecraft:heightmap",
+        "heightmap": "WORLD_SURFACE"
+    }
+

tungston/generator/datapack/placement/insquare.py

@@ -0,0 +1,13 @@
+from tungston.generator.datapack.placement import Placement
+from typing import Any
+
+# Class ############################################################################################
+
+class InSquare(Placement):
+
+    def __init__(self):
+        super().__init__("minecraft:in_square")
+
+    def asData(self) -> dict[str,Any]:
+        return { "type": self.gameId }
+

tungston/generator/datapack/placement/insquare_test.py

@@ -0,0 +1,18 @@
+from pytest import fixture
+from tungston.generator.datapack.placement.insquare import InSquare
+
+
+# Fixtures #########################################################################################
+
+@fixture(name="placement")
+def createPlacement():
+    yield InSquare()
+
+
+# Tests ############################################################################################
+
+def test_asData(placement):
+    assert placement.asData() == {
+        "type": "minecraft:in_square",
+    }
+

tungston/generator/datapack/placement/rarityfilter.py

@@ -0,0 +1,17 @@
+from tungston.generator.datapack.placement import Placement
+from typing import Any
+
+# Class ############################################################################################
+
+class RarityFilter(Placement):
+
+    def __init__(self, chance:int):
+        super().__init__("minecraft:rarity_filter")
+        self.chance = chance
+
+    def asData(self) -> dict[str,Any]:
+        return {
+            "type": self.gameId,
+            "chance": self.chance
+        }
+

tungston/generator/datapack/placement/rarityfilter_test.py

@@ -0,0 +1,19 @@
+from pytest import fixture
+from tungston.generator.datapack.placement.rarityfilter import RarityFilter
+
+
+# Fixtures #########################################################################################
+
+@fixture(name="placement")
+def createPlacement():
+    yield RarityFilter(4)
+
+
+# Tests ############################################################################################
+
+def test_asData(placement):
+    assert placement.asData() == {
+        "type": "minecraft:rarity_filter",
+        "chance": 4
+    }
+