mcdex 0.1.0.dev0__py3-none-any.whl

mcdex/banner_patterns/banner_patterns.json

@@ -0,0 +1,310 @@
+{
+ "covers": [
+  "1.7.2",
+  "26.3"
+ ],
+ "legend": {
+  "": "vanilla has no such banner pattern in this version"
+ },
+ "banner_patterns": {
+  "base": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "b",
+    "1.20.5": "minecraft:base"
+   }
+  },
+  "border": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "bo",
+    "1.20.5": "minecraft:border"
+   }
+  },
+  "bricks": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "bri",
+    "1.20.5": "minecraft:bricks"
+   }
+  },
+  "circle": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "mc",
+    "1.20.5": "minecraft:circle"
+   }
+  },
+  "creeper": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "cre",
+    "1.20.5": "minecraft:creeper"
+   }
+  },
+  "cross": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "cr",
+    "1.20.5": "minecraft:cross"
+   }
+  },
+  "curly_border": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "cbo",
+    "1.20.5": "minecraft:curly_border"
+   }
+  },
+  "diagonal_left": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "ld",
+    "1.20.5": "minecraft:diagonal_left"
+   }
+  },
+  "diagonal_right": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "rud",
+    "1.20.5": "minecraft:diagonal_right"
+   }
+  },
+  "diagonal_up_left": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "lud",
+    "1.20.5": "minecraft:diagonal_up_left"
+   }
+  },
+  "diagonal_up_right": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "rd",
+    "1.20.5": "minecraft:diagonal_up_right"
+   }
+  },
+  "flow": {
+   "ids": {
+    "1.7.2": "",
+    "1.20.5": "minecraft:flow"
+   }
+  },
+  "flower": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "flo",
+    "1.20.5": "minecraft:flower"
+   }
+  },
+  "globe": {
+   "ids": {
+    "1.7.2": "",
+    "1.14": "glb",
+    "1.20.5": "minecraft:globe"
+   }
+  },
+  "gradient": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "gra",
+    "1.20.5": "minecraft:gradient"
+   }
+  },
+  "gradient_up": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "gru",
+    "1.20.5": "minecraft:gradient_up"
+   }
+  },
+  "guster": {
+   "ids": {
+    "1.7.2": "",
+    "1.20.5": "minecraft:guster"
+   }
+  },
+  "half_horizontal": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "hh",
+    "1.20.5": "minecraft:half_horizontal"
+   }
+  },
+  "half_horizontal_bottom": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "hhb",
+    "1.20.5": "minecraft:half_horizontal_bottom"
+   }
+  },
+  "half_vertical": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "vh",
+    "1.20.5": "minecraft:half_vertical"
+   }
+  },
+  "half_vertical_right": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "vhr",
+    "1.20.5": "minecraft:half_vertical_right"
+   }
+  },
+  "mojang": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "moj",
+    "1.20.5": "minecraft:mojang"
+   }
+  },
+  "piglin": {
+   "ids": {
+    "1.7.2": "",
+    "1.16": "pig",
+    "1.20.5": "minecraft:piglin"
+   }
+  },
+  "rhombus": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "mr",
+    "1.20.5": "minecraft:rhombus"
+   }
+  },
+  "skull": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "sku",
+    "1.20.5": "minecraft:skull"
+   }
+  },
+  "small_stripes": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "ss",
+    "1.20.5": "minecraft:small_stripes"
+   }
+  },
+  "square_bottom_left": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "bl",
+    "1.20.5": "minecraft:square_bottom_left"
+   }
+  },
+  "square_bottom_right": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "br",
+    "1.20.5": "minecraft:square_bottom_right"
+   }
+  },
+  "square_top_left": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "tl",
+    "1.20.5": "minecraft:square_top_left"
+   }
+  },
+  "square_top_right": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "tr",
+    "1.20.5": "minecraft:square_top_right"
+   }
+  },
+  "straight_cross": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "sc",
+    "1.20.5": "minecraft:straight_cross"
+   }
+  },
+  "stripe_bottom": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "bs",
+    "1.20.5": "minecraft:stripe_bottom"
+   }
+  },
+  "stripe_center": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "cs",
+    "1.20.5": "minecraft:stripe_center"
+   }
+  },
+  "stripe_downleft": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "dls",
+    "1.20.5": "minecraft:stripe_downleft"
+   }
+  },
+  "stripe_downright": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "drs",
+    "1.20.5": "minecraft:stripe_downright"
+   }
+  },
+  "stripe_left": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "ls",
+    "1.20.5": "minecraft:stripe_left"
+   }
+  },
+  "stripe_middle": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "ms",
+    "1.20.5": "minecraft:stripe_middle"
+   }
+  },
+  "stripe_right": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "rs",
+    "1.20.5": "minecraft:stripe_right"
+   }
+  },
+  "stripe_top": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "ts",
+    "1.20.5": "minecraft:stripe_top"
+   }
+  },
+  "triangle_bottom": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "bt",
+    "1.20.5": "minecraft:triangle_bottom"
+   }
+  },
+  "triangle_top": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "tt",
+    "1.20.5": "minecraft:triangle_top"
+   }
+  },
+  "triangles_bottom": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "bts",
+    "1.20.5": "minecraft:triangles_bottom"
+   }
+  },
+  "triangles_top": {
+   "ids": {
+    "1.7.2": "",
+    "1.8": "tts",
+    "1.20.5": "minecraft:triangles_top"
+   }
+  }
+ }
+}

mcdex/base/__init__.py

@@ -0,0 +1,146 @@
+"""
+The 'mcdex.base' package provides what every catalogue is built on: the
+versions of the game, the equipment slots, the base of every catalogue
+('MCThing'), and each kind's id class: the item's, the entity's, the
+block's.
+
+- MCVersion
+- Version
+- EquipmentSlot
+- ItemId
+- NotInVersion
+- GameId
+- CatalogueMeta
+- MCThing
+- EntityId
+- BlockId
+- EffectId
+- EnchantmentId
+- PotionId
+- PotionModifier
+- BiomeId
+- BlockEntityId
+- ParticleId
+- SoundId
+- AttributeId
+- StatisticId
+- GameRuleId
+- VillagerProfessionId
+- VillagerTypeId
+- DimensionId
+- DamageTypeId
+- MusicId
+- TrimPatternId
+- TrimMaterialId
+- WolfVariantId
+- CatVariantId
+- FrogVariantId
+- PigVariantId
+- CowVariantId
+- ChickenVariantId
+- ZombieNautilusVariantId
+- WolfSoundVariantId
+- CatSoundVariantId
+- PigSoundVariantId
+- CowSoundVariantId
+- ChickenSoundVariantId
+- PaintingVariantId
+- BannerPatternId
+- AdvancementId
+- StructureId
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from ._mc_version import MCVersion
+from ._version import Version
+from ._equipment_slot import EquipmentSlot
+from ._item_id import ItemId
+from ._not_in_version import NotInVersion
+from ._game_id import GameId
+from ._catalogue_meta import CatalogueMeta
+from ._mc_thing import MCThing
+from ._entity_id import EntityId
+from ._block_id import BlockId
+from ._effect_id import EffectId
+from ._enchantment_id import EnchantmentId
+from ._potion_id import PotionId
+from ._potion_modifier import PotionModifier
+from ._biome_id import BiomeId
+from ._block_entity_id import BlockEntityId
+from ._particle_id import ParticleId
+from ._sound_id import SoundId
+from ._attribute_id import AttributeId
+from ._statistic_id import StatisticId
+from ._game_rule_id import GameRuleId
+from ._villager_profession_id import VillagerProfessionId
+from ._villager_type_id import VillagerTypeId
+from ._dimension_id import DimensionId
+from ._damage_type_id import DamageTypeId
+from ._music_id import MusicId
+from ._trim_pattern_id import TrimPatternId
+from ._trim_material_id import TrimMaterialId
+from ._wolf_variant_id import WolfVariantId
+from ._cat_variant_id import CatVariantId
+from ._frog_variant_id import FrogVariantId
+from ._pig_variant_id import PigVariantId
+from ._cow_variant_id import CowVariantId
+from ._chicken_variant_id import ChickenVariantId
+from ._zombie_nautilus_variant_id import ZombieNautilusVariantId
+from ._wolf_sound_variant_id import WolfSoundVariantId
+from ._cat_sound_variant_id import CatSoundVariantId
+from ._pig_sound_variant_id import PigSoundVariantId
+from ._cow_sound_variant_id import CowSoundVariantId
+from ._chicken_sound_variant_id import ChickenSoundVariantId
+from ._painting_variant_id import PaintingVariantId
+from ._banner_pattern_id import BannerPatternId
+from ._advancement_id import AdvancementId
+from ._structure_id import StructureId
+
+__all__ = (
+  'MCVersion',
+  'Version',
+  'EquipmentSlot',
+  'ItemId',
+  'NotInVersion',
+  'GameId',
+  'CatalogueMeta',
+  'MCThing',
+  'EntityId',
+  'BlockId',
+  'EffectId',
+  'EnchantmentId',
+  'PotionId',
+  'PotionModifier',
+  'BiomeId',
+  'BlockEntityId',
+  'ParticleId',
+  'SoundId',
+  'AttributeId',
+  'StatisticId',
+  'GameRuleId',
+  'VillagerProfessionId',
+  'VillagerTypeId',
+  'DimensionId',
+  'DamageTypeId',
+  'MusicId',
+  'TrimPatternId',
+  'TrimMaterialId',
+  'WolfVariantId',
+  'CatVariantId',
+  'FrogVariantId',
+  'PigVariantId',
+  'CowVariantId',
+  'ChickenVariantId',
+  'ZombieNautilusVariantId',
+  'WolfSoundVariantId',
+  'CatSoundVariantId',
+  'PigSoundVariantId',
+  'CowSoundVariantId',
+  'ChickenSoundVariantId',
+  'PaintingVariantId',
+  'BannerPatternId',
+  'AdvancementId',
+  'StructureId',
+)

mcdex/base/_advancement_id.py

@@ -0,0 +1,22 @@
+"""
+AdvancementId pairs an advancement's unique name with the id a version of the
+game needs to identify it.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from . import GameId
+
+
+class AdvancementId(GameId):
+  """
+  The id of an advancement in one version: its 'uniqueName', the same in every
+  version, and its 'minecraftId', what /advancement takes in that version.
+
+  Implementation
+  --------------
+
+  All of it is 'GameId's: an 'AdvancementId' is equal only to an
+  'AdvancementId'.
+  """

mcdex/base/_attribute_id.py

@@ -0,0 +1,22 @@
+"""
+AttributeId pairs an attribute's unique name with the id a version of the game
+needs to identify it.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from . import GameId
+
+
+class AttributeId(GameId):
+  """
+  The id of an attribute in one version: its 'uniqueName', the same in every
+  version, and its 'minecraftId', the name an entity's data gives it, and from
+  1.16 what '/attribute' takes in that version.
+
+  Implementation
+  --------------
+
+  All of it is 'GameId's: an 'AttributeId' is equal only to an 'AttributeId'.
+  """

mcdex/base/_banner_pattern_id.py

@@ -0,0 +1,26 @@
+"""
+BannerPatternId pairs a banner pattern's unique name with the id a version of
+the game needs to identify it.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from . import GameId
+
+
+class BannerPatternId(GameId):
+  """
+  The id of a banner pattern in one version: its 'uniqueName', the same in
+  every version, and its 'minecraftId', what a banner's pattern takes in that
+  version.
+
+  A command takes it only inside a banner's data, whose shape changed over
+  the versions: see the README's 'Ids that go inside an item'.
+
+  Implementation
+  --------------
+
+  All of it is 'GameId's: a 'BannerPatternId' is equal only to a
+  'BannerPatternId'.
+  """

mcdex/base/_biome_id.py

@@ -0,0 +1,22 @@
+"""
+BiomeId pairs a biome's unique name with the id a version of the game
+needs to identify it.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from . import GameId
+
+
+class BiomeId(GameId):
+  """
+  The id of a biome in one version: its 'uniqueName', the same in every
+  version, and its 'minecraftId', the biome's number to 1.8.9, its name from
+  1.9 in that version.
+
+  Implementation
+  --------------
+
+  All of it is 'GameId's: a 'BiomeId' is equal only to a 'BiomeId'.
+  """

mcdex/base/_block_entity_id.py

@@ -0,0 +1,22 @@
+"""
+BlockEntityId pairs a block entity's unique name with the id a version of the
+game needs to identify it.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from . import GameId
+
+
+class BlockEntityId(GameId):
+  """
+  The id of a block entity in one version: its 'uniqueName', the same in every
+  version, and its 'minecraftId', the name it is saved under, the 'id' in its
+  data in that version.
+
+  Implementation
+  --------------
+
+  All of it is 'GameId's: a 'BlockEntityId' is equal only to a 'BlockEntityId'.
+  """

mcdex/base/_block_id.py

@@ -0,0 +1,35 @@
+"""
+BlockId pairs a block's unique name with the id a version of the game
+needs to identify it.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from . import GameId
+
+
+class BlockId(GameId):
+  """
+  A user of mcdex names a block once, by its unique name, as
+  'pink_wool', and each version of the game needs its own id for it:
+  what '/setblock' takes. 'BlockId' holds the two: 'uniqueName', the same
+  in every version, and 'minecraftId', all that one version needs to
+  identify the block, as one string in the notation of its era:
+
+    BlockId('pink_wool', 'minecraft:wool:6')       # 1.7.2 to 1.12.2
+    BlockId('pink_wool', 'minecraft:pink_wool')    # since 1.13
+
+  Before 1.13 a block was a name and a meta, the meta part of the id
+  only where it told blocks apart: 'minecraft:oak_stairs' is any oak
+  stairs, but 'minecraft:wool:6' is the pink wool. Where an old version
+  told blocks apart by their block entity, the id carries that data
+  after the name: the creeper head of 1.12.2 is a skull of type 4,
+  'minecraft:skull:1{SkullType:4b}'. The water cauldron of 1.13 to
+  1.16.5 was a cauldron with water in it, 'minecraft:cauldron[level=1]'.
+
+  Implementation
+  --------------
+
+  All of it is 'GameId's: a 'BlockId' is equal only to a 'BlockId'.
+  """

mcdex/base/_cat_sound_variant_id.py

@@ -0,0 +1,23 @@
+"""
+CatSoundVariantId pairs a cat sound variant's unique name with the id a version
+of the game needs to identify it.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from . import GameId
+
+
+class CatSoundVariantId(GameId):
+  """
+  The id of a cat sound variant in one version: its 'uniqueName', the same in
+  every version, and its 'minecraftId', what /summon takes for a cat of that
+  sound variant in that version.
+
+  Implementation
+  --------------
+
+  All of it is 'GameId's: a 'CatSoundVariantId' is equal only to a
+  'CatSoundVariantId'.
+  """

mcdex/base/_cat_variant_id.py

@@ -0,0 +1,22 @@
+"""
+CatVariantId pairs a cat variant's unique name with the id a version of the
+game needs to identify it.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from . import GameId
+
+
+class CatVariantId(GameId):
+  """
+  The id of a cat variant in one version: its 'uniqueName', the same in every
+  version, and its 'minecraftId', what /summon takes for a cat of that variant
+  in that version.
+
+  Implementation
+  --------------
+
+  All of it is 'GameId's: a 'CatVariantId' is equal only to a 'CatVariantId'.
+  """

mcdex/base/_catalogue_meta.py

@@ -0,0 +1,38 @@
+"""
+CatalogueMeta is the metaclass of mcdex's catalogues: worktoy's
+enumeration metaclass, with membership that takes a unique name too.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from worktoy.keenum import KeeMeta
+
+if TYPE_CHECKING:  # pragma: no cover, no mutate
+  from typing import Any
+
+
+class CatalogueMeta(KeeMeta):
+  """
+  A catalogue answers whether it has a thing of a name, as well as
+  whether a thing is its own:
+
+    'pink_wool' in MCItems          # True
+    MCItems.PINK_WOOL in MCItems    # True
+    MCBlocks.PINK_WOOL in MCItems   # False
+
+  Implementation
+  --------------
+
+  All of it is 'KeeMeta's, but for a 'str', which is in the catalogue
+  when it is the unique name of one of its members. The catalogues are
+  built on 'CatalogueMeta.keeNum', the root this metaclass gives its
+  enumerations.
+  """
+
+  def __contains__(cls, identifier: Any) -> bool:
+    if isinstance(identifier, str):
+      return identifier in cls._byUniqueName()
+    return KeeMeta.__contains__(cls, identifier)