mcdex 0.1.0.dev0__py3-none-any.whl

mcdex/music/__init__.py

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

mcdex/music/_music.py

@@ -0,0 +1,65 @@
+"""
+Music is the catalogue of the game's songs: an enumeration with one
+member for every song of the data file that ships with mcdex, each the
+same song in every version, with the id each version knows it by:
+the song a jukebox_playable component plays.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from worktoy.keenum import Kee
+
+from ..base import MCThing, MusicId
+
+
+class Music(MCThing):
+  """
+  The catalogue of the game's songs, each a member, found by its name in
+  capitals, in any case, or by its unique name:
+
+    pigstep = Music.PIGSTEP
+    pigstep is Music['pigstep']  # True
+    pigstep['1.21']  # MusicId('pigstep', 'minecraft:pigstep')
+    len(Music)
+
+  Implementation
+  --------------
+
+  All of it is 'MCThing's, reading 'music.json' beside this module.
+  mcdex's tools write the members, one for every name of that file.
+  """
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  NAMESPACE  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  #  Class Variables
+  __data_file__ = 'music.json'
+  __data_key__ = 'music'
+  __id_class__ = MusicId
+  __kind__ = 'song'
+
+  #  Members, one for every name of 'music.json'
+  ELEVEN = Kee[str]('11')
+  THIRTEEN = Kee[str]('13')
+  FIVE = Kee[str]('5')
+  BLOCKS = Kee[str]('blocks')
+  BOUNCE = Kee[str]('bounce')
+  CAT = Kee[str]('cat')
+  CHIRP = Kee[str]('chirp')
+  CREATOR = Kee[str]('creator')
+  CREATOR_MUSIC_BOX = Kee[str]('creator_music_box')
+  FAR = Kee[str]('far')
+  LAVA_CHICKEN = Kee[str]('lava_chicken')
+  MALL = Kee[str]('mall')
+  MELLOHI = Kee[str]('mellohi')
+  OTHERSIDE = Kee[str]('otherside')
+  PIGSTEP = Kee[str]('pigstep')
+  PRECIPICE = Kee[str]('precipice')
+  RELIC = Kee[str]('relic')
+  STAL = Kee[str]('stal')
+  STRAD = Kee[str]('strad')
+  TEARS = Kee[str]('tears')
+  WAIT = Kee[str]('wait')
+  WARD = Kee[str]('ward')

mcdex/music/music.json

@@ -0,0 +1,143 @@
+{
+ "covers": [
+  "1.7.2",
+  "26.3"
+ ],
+ "legend": {
+  "": "vanilla has no such song in this version"
+ },
+ "music": {
+  "11": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:11"
+   }
+  },
+  "13": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:13"
+   }
+  },
+  "5": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:5"
+   }
+  },
+  "blocks": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:blocks"
+   }
+  },
+  "bounce": {
+   "ids": {
+    "1.7.2": "",
+    "26.2": "minecraft:bounce"
+   }
+  },
+  "cat": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:cat"
+   }
+  },
+  "chirp": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:chirp"
+   }
+  },
+  "creator": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:creator"
+   }
+  },
+  "creator_music_box": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:creator_music_box"
+   }
+  },
+  "far": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:far"
+   }
+  },
+  "lava_chicken": {
+   "ids": {
+    "1.7.2": "",
+    "1.21.7": "minecraft:lava_chicken"
+   }
+  },
+  "mall": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:mall"
+   }
+  },
+  "mellohi": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:mellohi"
+   }
+  },
+  "otherside": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:otherside"
+   }
+  },
+  "pigstep": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:pigstep"
+   }
+  },
+  "precipice": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:precipice"
+   }
+  },
+  "relic": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:relic"
+   }
+  },
+  "stal": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:stal"
+   }
+  },
+  "strad": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:strad"
+   }
+  },
+  "tears": {
+   "ids": {
+    "1.7.2": "",
+    "1.21.6": "minecraft:tears"
+   }
+  },
+  "wait": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:wait"
+   }
+  },
+  "ward": {
+   "ids": {
+    "1.7.2": "",
+    "1.21": "minecraft:ward"
+   }
+  }
+ }
+}

mcdex/painting_variants/__init__.py

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

mcdex/painting_variants/_mc_painting_variants.py

@@ -0,0 +1,96 @@
+"""
+MCPaintingVariants is the catalogue of the game's painting variants: an
+enumeration with one member for every painting variant of the data file that
+ships with mcdex, each the same painting variant in every version, with the id
+each version knows it by: what /summon takes for a painting of that variant.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from worktoy.keenum import Kee
+
+from ..base import MCThing, PaintingVariantId
+
+
+class MCPaintingVariants(MCThing):
+  """
+  The catalogue of the game's painting variants, each a member, found by its
+  name in capitals, in any case, or by its unique name:
+
+    donkeyKong = MCPaintingVariants.DONKEY_KONG
+    donkeyKong is MCPaintingVariants['donkey_kong']  # True
+    donkeyKong['1.12.2']
+    # PaintingVariantId('donkey_kong',
+    #   'minecraft:painting{Motive:"DonkeyKong"}')
+    len(MCPaintingVariants)
+
+  Implementation
+  --------------
+
+  All of it is 'MCThing's, reading 'painting_variants.json' beside this module.
+  mcdex's tools write the members, one for every name of that file.
+  """
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  NAMESPACE  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  #  Class Variables
+  __data_file__ = 'painting_variants.json'
+  __data_key__ = 'painting_variants'
+  __id_class__ = PaintingVariantId
+  __kind__ = 'painting variant'
+
+  #  Members, one for every name of 'painting_variants.json'
+  ALBAN = Kee[str]('alban')
+  AZTEC = Kee[str]('aztec')
+  AZTEC2 = Kee[str]('aztec2')
+  BACKYARD = Kee[str]('backyard')
+  BAROQUE = Kee[str]('baroque')
+  BOMB = Kee[str]('bomb')
+  BOUQUET = Kee[str]('bouquet')
+  BURNING_SKULL = Kee[str]('burning_skull')
+  BUST = Kee[str]('bust')
+  CAVEBIRD = Kee[str]('cavebird')
+  CHANGING = Kee[str]('changing')
+  COTAN = Kee[str]('cotan')
+  COURBET = Kee[str]('courbet')
+  CREEBET = Kee[str]('creebet')
+  DENNIS = Kee[str]('dennis')
+  DONKEY_KONG = Kee[str]('donkey_kong')
+  EARTH = Kee[str]('earth')
+  ENDBOSS = Kee[str]('endboss')
+  FERN = Kee[str]('fern')
+  FIGHTERS = Kee[str]('fighters')
+  FINDING = Kee[str]('finding')
+  FIRE = Kee[str]('fire')
+  GRAHAM = Kee[str]('graham')
+  HUMBLE = Kee[str]('humble')
+  KEBAB = Kee[str]('kebab')
+  LOWMIST = Kee[str]('lowmist')
+  MATCH = Kee[str]('match')
+  MEDITATIVE = Kee[str]('meditative')
+  ORB = Kee[str]('orb')
+  OWLEMONS = Kee[str]('owlemons')
+  PASSAGE = Kee[str]('passage')
+  PIGSCENE = Kee[str]('pigscene')
+  PLANT = Kee[str]('plant')
+  POINTER = Kee[str]('pointer')
+  POND = Kee[str]('pond')
+  POOL = Kee[str]('pool')
+  PRAIRIE_RIDE = Kee[str]('prairie_ride')
+  SEA = Kee[str]('sea')
+  SKELETON = Kee[str]('skeleton')
+  SKULL_AND_ROSES = Kee[str]('skull_and_roses')
+  STAGE = Kee[str]('stage')
+  SUNFLOWERS = Kee[str]('sunflowers')
+  SUNSET = Kee[str]('sunset')
+  TIDES = Kee[str]('tides')
+  UNPACKED = Kee[str]('unpacked')
+  VOID = Kee[str]('void')
+  WANDERER = Kee[str]('wanderer')
+  WASTELAND = Kee[str]('wasteland')
+  WATER = Kee[str]('water')
+  WIND = Kee[str]('wind')
+  WITHER = Kee[str]('wither')