mcdex 0.1.0.dev0__py3-none-any.whl

mcdex/block_entities/_mc_block_entities.py

@@ -0,0 +1,95 @@
+"""
+MCBlockEntities is the catalogue of the game's block entities: an enumeration
+with one member for every block entity of the data file that ships with mcdex,
+each the same block entity in every version, with the id each version knows it
+by: the name it is saved under, the 'id' in its data.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from worktoy.keenum import Kee
+
+from ..base import BlockEntityId, MCThing
+
+
+class MCBlockEntities(MCThing):
+  """
+  The catalogue of the game's block entities, each a member, found by its name
+  in capitals, in any case, or by its unique name:
+
+    chest = MCBlockEntities.CHEST
+    chest is MCBlockEntities['chest']  # True
+    chest['1.10.2']  # BlockEntityId('chest', 'Chest')
+    len(MCBlockEntities)
+
+  Implementation
+  --------------
+
+  All of it is 'MCThing's, reading 'block_entities.json' beside this module.
+  mcdex's tools write the members, one for every name of that file.
+  """
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  NAMESPACE  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  #  Class Variables
+  __data_file__ = 'block_entities.json'
+  __data_key__ = 'block_entities'
+  __id_class__ = BlockEntityId
+  __kind__ = 'block entity'
+
+  #  Members, one for every name of 'block_entities.json'
+  BANNER = Kee[str]('banner')
+  BARREL = Kee[str]('barrel')
+  BEACON = Kee[str]('beacon')
+  BED = Kee[str]('bed')
+  BEEHIVE = Kee[str]('beehive')
+  BELL = Kee[str]('bell')
+  BLAST_FURNACE = Kee[str]('blast_furnace')
+  BREWING_STAND = Kee[str]('brewing_stand')
+  BRUSHABLE_BLOCK = Kee[str]('brushable_block')
+  CALIBRATED_SCULK_SENSOR = Kee[str]('calibrated_sculk_sensor')
+  CAMPFIRE = Kee[str]('campfire')
+  CHEST = Kee[str]('chest')
+  CHISELED_BOOKSHELF = Kee[str]('chiseled_bookshelf')
+  COMMAND_BLOCK = Kee[str]('command_block')
+  COMPARATOR = Kee[str]('comparator')
+  CONDUIT = Kee[str]('conduit')
+  COPPER_GOLEM_STATUE = Kee[str]('copper_golem_statue')
+  CRAFTER = Kee[str]('crafter')
+  CREAKING_HEART = Kee[str]('creaking_heart')
+  DAYLIGHT_DETECTOR = Kee[str]('daylight_detector')
+  DECORATED_POT = Kee[str]('decorated_pot')
+  DISPENSER = Kee[str]('dispenser')
+  DROPPER = Kee[str]('dropper')
+  ENCHANTING_TABLE = Kee[str]('enchanting_table')
+  END_GATEWAY = Kee[str]('end_gateway')
+  END_PORTAL = Kee[str]('end_portal')
+  ENDER_CHEST = Kee[str]('ender_chest')
+  FLOWER_POT = Kee[str]('flower_pot')
+  FURNACE = Kee[str]('furnace')
+  HANGING_SIGN = Kee[str]('hanging_sign')
+  HOPPER = Kee[str]('hopper')
+  JIGSAW = Kee[str]('jigsaw')
+  JUKEBOX = Kee[str]('jukebox')
+  LECTERN = Kee[str]('lectern')
+  MOB_SPAWNER = Kee[str]('mob_spawner')
+  NOTEBLOCK = Kee[str]('noteblock')
+  PISTON = Kee[str]('piston')
+  POTENT_SULFUR = Kee[str]('potent_sulfur')
+  SCULK_CATALYST = Kee[str]('sculk_catalyst')
+  SCULK_SENSOR = Kee[str]('sculk_sensor')
+  SCULK_SHRIEKER = Kee[str]('sculk_shrieker')
+  SHELF = Kee[str]('shelf')
+  SHULKER_BOX = Kee[str]('shulker_box')
+  SIGN = Kee[str]('sign')
+  SKULL = Kee[str]('skull')
+  SMOKER = Kee[str]('smoker')
+  STRUCTURE_BLOCK = Kee[str]('structure_block')
+  TEST_BLOCK = Kee[str]('test_block')
+  TEST_INSTANCE_BLOCK = Kee[str]('test_instance_block')
+  TRAPPED_CHEST = Kee[str]('trapped_chest')
+  TRIAL_SPAWNER = Kee[str]('trial_spawner')
+  VAULT = Kee[str]('vault')

mcdex/block_entities/block_entities.json

@@ -0,0 +1,331 @@
+{
+ "covers": [
+  "1.7.2",
+  "26.3"
+ ],
+ "legend": {
+  "": "vanilla has no such block entity in this version"
+ },
+ "block_entities": {
+  "banner": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "Banner",
+    "1.11": "minecraft:banner"
+   }
+  },
+  "barrel": {
+   "ids": {
+    "1.7.2": "",
+    "1.14": "minecraft:barrel"
+   }
+  },
+  "beacon": {
+   "ids": {
+    "1.7.2": "Beacon",
+    "1.11": "minecraft:beacon"
+   }
+  },
+  "bed": {
+   "ids": {
+    "1.7.2": "",
+    "1.12": "minecraft:bed",
+    "26.2": ""
+   }
+  },
+  "beehive": {
+   "ids": {
+    "1.7.2": "",
+    "1.15": "minecraft:beehive"
+   }
+  },
+  "bell": {
+   "ids": {
+    "1.7.2": "",
+    "1.14": "minecraft:bell"
+   }
+  },
+  "blast_furnace": {
+   "ids": {
+    "1.7.2": "",
+    "1.14": "minecraft:blast_furnace"
+   }
+  },
+  "brewing_stand": {
+   "ids": {
+    "1.7.2": "Cauldron",
+    "1.11": "minecraft:brewing_stand"
+   }
+  },
+  "brushable_block": {
+   "ids": {
+    "1.7.2": "",
+    "1.19.4": "minecraft:suspicious_sand",
+    "1.20": "minecraft:brushable_block"
+   }
+  },
+  "calibrated_sculk_sensor": {
+   "ids": {
+    "1.7.2": "",
+    "1.20": "minecraft:calibrated_sculk_sensor"
+   }
+  },
+  "campfire": {
+   "ids": {
+    "1.7.2": "",
+    "1.14": "minecraft:campfire"
+   }
+  },
+  "chest": {
+   "ids": {
+    "1.7.2": "Chest",
+    "1.11": "minecraft:chest"
+   }
+  },
+  "chiseled_bookshelf": {
+   "ids": {
+    "1.7.2": "",
+    "1.19.3": "minecraft:chiseled_bookshelf"
+   }
+  },
+  "command_block": {
+   "ids": {
+    "1.7.2": "Control",
+    "1.11": "minecraft:command_block"
+   }
+  },
+  "comparator": {
+   "ids": {
+    "1.7.2": "Comparator",
+    "1.11": "minecraft:comparator"
+   }
+  },
+  "conduit": {
+   "ids": {
+    "1.7.2": "",
+    "1.13": "minecraft:conduit"
+   }
+  },
+  "copper_golem_statue": {
+   "ids": {
+    "1.7.2": "",
+    "1.21.9": "minecraft:copper_golem_statue"
+   }
+  },
+  "crafter": {
+   "ids": {
+    "1.7.2": "",
+    "1.20.3": "minecraft:crafter"
+   }
+  },
+  "creaking_heart": {
+   "ids": {
+    "1.7.2": "",
+    "1.21.2": "minecraft:creaking_heart"
+   }
+  },
+  "daylight_detector": {
+   "ids": {
+    "1.7.2": "DLDetector",
+    "1.11": "minecraft:daylight_detector"
+   }
+  },
+  "decorated_pot": {
+   "ids": {
+    "1.7.2": "",
+    "1.19.4": "minecraft:decorated_pot"
+   }
+  },
+  "dispenser": {
+   "ids": {
+    "1.7.2": "Trap",
+    "1.11": "minecraft:dispenser"
+   }
+  },
+  "dropper": {
+   "ids": {
+    "1.7.2": "Dropper",
+    "1.11": "minecraft:dropper"
+   }
+  },
+  "enchanting_table": {
+   "ids": {
+    "1.7.2": "EnchantTable",
+    "1.11": "minecraft:enchanting_table"
+   }
+  },
+  "end_gateway": {
+   "ids": {
+    "1.7.2": "",
+    "1.9": "EndGateway",
+    "1.11": "minecraft:end_gateway"
+   }
+  },
+  "end_portal": {
+   "ids": {
+    "1.7.2": "Airportal",
+    "1.11": "minecraft:end_portal"
+   }
+  },
+  "ender_chest": {
+   "ids": {
+    "1.7.2": "EnderChest",
+    "1.11": "minecraft:ender_chest"
+   }
+  },
+  "flower_pot": {
+   "ids": {
+    "1.7.2": "FlowerPot",
+    "1.11": "minecraft:flower_pot",
+    "1.13": ""
+   }
+  },
+  "furnace": {
+   "ids": {
+    "1.7.2": "Furnace",
+    "1.11": "minecraft:furnace"
+   }
+  },
+  "hanging_sign": {
+   "ids": {
+    "1.7.2": "",
+    "1.19.3": "minecraft:hanging_sign"
+   }
+  },
+  "hopper": {
+   "ids": {
+    "1.7.2": "Hopper",
+    "1.11": "minecraft:hopper"
+   }
+  },
+  "jigsaw": {
+   "ids": {
+    "1.7.2": "",
+    "1.14": "minecraft:jigsaw"
+   }
+  },
+  "jukebox": {
+   "ids": {
+    "1.7.2": "RecordPlayer",
+    "1.11": "minecraft:jukebox"
+   }
+  },
+  "lectern": {
+   "ids": {
+    "1.7.2": "",
+    "1.14": "minecraft:lectern"
+   }
+  },
+  "mob_spawner": {
+   "ids": {
+    "1.7.2": "MobSpawner",
+    "1.11": "minecraft:mob_spawner"
+   }
+  },
+  "noteblock": {
+   "ids": {
+    "1.7.2": "Music",
+    "1.11": "minecraft:noteblock",
+    "1.13": ""
+   }
+  },
+  "piston": {
+   "ids": {
+    "1.7.2": "Piston",
+    "1.11": "minecraft:piston"
+   }
+  },
+  "potent_sulfur": {
+   "ids": {
+    "1.7.2": "",
+    "26.2": "minecraft:potent_sulfur"
+   }
+  },
+  "sculk_catalyst": {
+   "ids": {
+    "1.7.2": "",
+    "1.19": "minecraft:sculk_catalyst"
+   }
+  },
+  "sculk_sensor": {
+   "ids": {
+    "1.7.2": "",
+    "1.17": "minecraft:sculk_sensor"
+   }
+  },
+  "sculk_shrieker": {
+   "ids": {
+    "1.7.2": "",
+    "1.19": "minecraft:sculk_shrieker"
+   }
+  },
+  "shelf": {
+   "ids": {
+    "1.7.2": "",
+    "1.21.9": "minecraft:shelf"
+   }
+  },
+  "shulker_box": {
+   "ids": {
+    "1.7.2": "",
+    "1.11": "minecraft:shulker_box"
+   }
+  },
+  "sign": {
+   "ids": {
+    "1.7.2": "Sign",
+    "1.11": "minecraft:sign"
+   }
+  },
+  "skull": {
+   "ids": {
+    "1.7.2": "Skull",
+    "1.11": "minecraft:skull"
+   }
+  },
+  "smoker": {
+   "ids": {
+    "1.7.2": "",
+    "1.14": "minecraft:smoker"
+   }
+  },
+  "structure_block": {
+   "ids": {
+    "1.7.2": "",
+    "1.9": "Structure",
+    "1.11": "minecraft:structure_block"
+   }
+  },
+  "test_block": {
+   "ids": {
+    "1.7.2": "",
+    "1.21.5": "minecraft:test_block"
+   }
+  },
+  "test_instance_block": {
+   "ids": {
+    "1.7.2": "",
+    "1.21.5": "minecraft:test_instance_block"
+   }
+  },
+  "trapped_chest": {
+   "ids": {
+    "1.7.2": "Chest",
+    "1.11": "minecraft:chest",
+    "1.13": "minecraft:trapped_chest"
+   }
+  },
+  "trial_spawner": {
+   "ids": {
+    "1.7.2": "",
+    "1.20.3": "minecraft:trial_spawner"
+   }
+  },
+  "vault": {
+   "ids": {
+    "1.7.2": "",
+    "1.20.5": "minecraft:vault"
+   }
+  }
+ }
+}

mcdex/blocks/__init__.py

@@ -0,0 +1,16 @@
+"""
+The 'mcdex.blocks' package provides the blocks of the game: the
+'MCBlocks' catalogue, an enumeration of every block of the data file
+'blocks.json' that ships with the package.
+
+- MCBlocks
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from ._mc_blocks import MCBlocks
+
+__all__ = (
+  'MCBlocks',
+)