stewbeet 2.2.2__tar.gz → 2.2.3__tar.gz

{stewbeet-2.2.2 → stewbeet-2.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stewbeet
-Version: 2.2.2
+Version: 2.2.3
 Summary: Beet Framework made to help generating advanced Minecraft datapack contents
 Project-URL: Homepage, https://github.com/Stoupy51/stewbeet
 Project-URL: Issues, https://github.com/Stoupy51/stewbeet/issues

{stewbeet-2.2.2 → stewbeet-2.2.3}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stewbeet"
-version = "2.2.2"
+version = "2.2.3"
 description = "Beet Framework made to help generating advanced Minecraft datapack contents"
 readme = "README.md"
 license = "MIT"

{stewbeet-2.2.2 → stewbeet-2.2.3}/stewbeet/all.py

@@ -9,6 +9,7 @@ GENERATION_PLUGINS = (
     "stewbeet.plugins.resource_pack.item_models",
     "stewbeet.plugins.resource_pack.check_power_of_2",
     "stewbeet.plugins.custom_recipes",
+    "stewbeet.plugins.custom_paintings",
     "stewbeet.plugins.ingame_manual",
     "stewbeet.plugins.datapack.loading",
     "stewbeet.plugins.datapack.custom_blocks",

{stewbeet-2.2.2 → stewbeet-2.2.3}/stewbeet/core/constants.py

@@ -64,6 +64,7 @@ VANILLA_BLOCK_FOR_ORES: JsonDict = {"id":"minecraft:polished_deepslate", "apply_
 OVERRIDE_MODEL: str = "override_model"					# Key to a dictionnary that will be used to override the whole model
 PULVERIZING: str = "simplenergy_pulverizing"			# Value of a recipe type, used to generate dusts from ores (used by SimplEnergy)
 SMITHED_CRAFTER_COMMAND: str = "smithed_crafter_command"	# Key to a command that will be used in a recipe in the Smithed Crafter library. If not present, the command will be defaulted to a loot table. Ex: {"result":...,SMITHED_CRAFTER_COMMAND: "function your_namespace:calls/smithed_crafter/do_something_else"}
+PAINTING_DATA: str = "painting_data"					# Key to a dict that contains the painting data, like {"author":"","title":"","width":1,"height":1} where author and title defaults to beet config values if not given
 GROWING_SEED: str = "staged_seed"						# Key to a seed that has multiple growth stages, value needs to be a dict like {"texture_basename":"wheat","stages":8,"seconds":600,"planted_on":"stone","loots":[{"id":"minecraft:wheat_seeds","min_count":1,"max_count":3}]} where loots can be either this format or a loot table path "namespace:blocks/loot_table_name"
 WIKI_COMPONENT: str = "wiki_components"					# Key to a text component that will be used to generate the wiki button in the manual
 RESULT_OF_CRAFTING: str = "result_of_crafting"			# Key to a list of recipes to craft the item, ex: "adamantium": {RESULT_OF_CRAFTING: [...]}
@@ -78,6 +79,7 @@ NOT_COMPONENTS: list[str] = [							# Keys that should not be considered as comp
 	NO_SILK_TOUCH_DROP,
 	OVERRIDE_MODEL,
 	SMITHED_CRAFTER_COMMAND,
+	PAINTING_DATA,
 	GROWING_SEED,
 ]
 

{stewbeet-2.2.2 → stewbeet-2.2.3}/stewbeet/core/definitions_helper/completion.py

@@ -3,6 +3,8 @@
 # Imports
 from __future__ import annotations
 
+from typing import cast
+
 from beet.core.utils import JsonDict, TextComponent
 from box import Box
 
@@ -10,17 +12,20 @@ from ..__memory__ import Mem
 
 
 # Add item model component
-def add_item_model_component(black_list: list[str] | None = None) -> None:
+def add_item_model_component(black_list: list[str] | None = None, ignore_paintings: bool = True) -> None:
 	""" Add an item model component to all items in the definitions.
 
 	Args:
-		black_list	(list[str]):		The list of items to ignore.
+		black_list			(list[str]):	The list of items to ignore.
+		ignore_paintings	(bool):			Whether to ignore items that are paintings (have PAINTING_DATA).
 	"""
 	if black_list is None:
 		black_list = []
 	for item, data in Mem.definitions.items():
 		if item in black_list or data.get("item_model", None) is not None:
 			continue
+		if ignore_paintings and data.get("painting_data", None) is not None:
+			continue
 		data["item_model"] = f"{Mem.ctx.project_id}:{item}"
 	return
 
@@ -52,7 +57,7 @@ def add_item_name_and_lore_if_missing(is_external: bool = False, black_list: lis
 
 		# Apply namespaced lore if none
 		if not data.get("lore"):
-			data["lore"] = []
+			data["lore"] = cast(list[TextComponent], [])
 
 		# If item is not external,
 		if not is_external:
@@ -83,7 +88,7 @@ def add_private_custom_data_for_namespace(is_external: bool = False) -> None:
 	"""
 	for item, data in Mem.definitions.items():
 		if not data.get("custom_data"):
-			data["custom_data"] = {}
+			data["custom_data"] = cast(JsonDict, {})
 		if is_external and ":" in item:
 			ns, id = item.split(":")
 		else:
@@ -101,6 +106,6 @@ def add_smithed_ignore_vanilla_behaviours_convention() -> None:
 	"""
 	for data in Mem.definitions.values():
 		data["custom_data"] = Box(data.get("custom_data", {}), default_box=True, default_box_attr={}, default_box_create_on_get=True)
-		data["custom_data"].smithed.ignore.functionality = True
-		data["custom_data"].smithed.ignore.crafting = True
+		data["custom_data"].smithed.ignore.functionality = True # pyright: ignore[reportUnknownMemberType]
+		data["custom_data"].smithed.ignore.crafting = True # pyright: ignore[reportUnknownMemberType]
 

stewbeet-2.2.3/stewbeet/plugins/custom_paintings/__init__.py

@@ -0,0 +1,83 @@
+
+# Imports
+import os
+
+from beet import Context, PaintingVariant, PaintingVariantTag, Texture
+from beet.core.utils import JsonDict
+from stouputils.decorators import measure_time
+from stouputils.io import relative_path, super_json_load
+from stouputils.print import error, progress, warning
+
+from ...core.__memory__ import Mem
+from ...core.constants import PAINTING_DATA
+from ...core.utils.io import set_json_encoder
+
+
+# Main entry point
+@measure_time(progress, message="Execution time of 'stewbeet.plugins.custom_paintings'")
+def beet_default(ctx: Context) -> None:
+    """ Main entry point for the custom paintings plugin.
+    This plugin handles the generation of custom paintings for the datapack and resource pack.
+
+    Requires a valid definitions in Mem.definitions in order to function properly using constant 'PAINTING_DATA'.
+
+    Args:
+        ctx (Context): The beet context.
+    """
+    if Mem.ctx is None: # pyright: ignore[reportUnnecessaryComparison]
+        Mem.ctx = ctx
+    ns: str = ctx.project_id
+    textures_folder: str = Mem.ctx.meta.get("stewbeet", {}).get("textures_folder", "")
+    placeable_values: list[str] = []
+
+    # Assertions
+    assert textures_folder, "The 'textures_folder' key is missing in the 'stewbeet' section of the beet.yml file."
+
+    # For each item definition that has painting data,
+    for item, data in Mem.definitions.items():
+        painting_data: JsonDict = data.get(PAINTING_DATA, {})
+        if painting_data:
+
+            ## Datapack
+            # Add the item id to the list of painting variants values
+            if not painting_data.get("not_placeable", False):
+                placeable_values.append(f"{ns}:{item}")
+
+            # Set default author and title if not provided
+            if "author" not in painting_data:
+                painting_data["author"] = {"text": Mem.ctx.project_author or "Unknown"}
+            if "title" not in painting_data:
+                painting_data["title"] = data.get("item_name") or {"text": item.replace("_", " ").title()}
+
+            # Create ordered painting data with asset_id first
+            ordered_painting_data = {"asset_id": f"{ns}:{item}"}
+            ordered_painting_data.update(painting_data)
+            ordered_painting_data.pop("not_placeable", None)
+
+            # Create the painting definition
+            Mem.ctx.data[ns].painting_variants[item] = set_json_encoder(PaintingVariant(ordered_painting_data))
+
+            ## Resource pack
+            # Get the texture path
+            matching_textures: list[str] = [
+                relative_path(f"{root}/{file}")
+                for root, _, files in os.walk(textures_folder)
+                for file in files if file == f"{item}.png"
+            ]
+            if not matching_textures:
+                error(f"No texture found for painting '{item}' in the textures folder '{textures_folder}'. Expected a file named '{item}.png'.")
+                continue
+            elif len(matching_textures) > 1:
+                warning(f"Multiple textures found for painting '{item}' in the textures folder '{textures_folder}'. Using the first one found: '{matching_textures[0]}'.")
+            src: str = matching_textures[0]
+            dst: str = f"painting/{item}"
+
+            # Check if the texture is not already registered
+            if not Mem.ctx.assets[ns].textures.get(dst):
+                mcmeta: JsonDict | None = None if not os.path.exists(src + ".mcmeta") else super_json_load(f"{src}.mcmeta")
+                Mem.ctx.assets[ns].textures[dst] = Texture(source_path=src, mcmeta=mcmeta)
+
+    # Add the painting variant tag to the context data
+    if placeable_values:
+        Mem.ctx.data["minecraft"].painting_variant_tags["placeable"] = set_json_encoder(PaintingVariantTag({"values": placeable_values}))
+

{stewbeet-2.2.2 → stewbeet-2.2.3}/stewbeet/plugins/ingame_manual/iso_renders.py

@@ -1,6 +1,7 @@
 
 # Imports
 import os
+import shutil
 from typing import cast
 
 import requests
@@ -92,8 +93,9 @@ def generate_all_iso_renders():
 		pass
 
 	# Download all the vanilla textures from the wiki
-	def download_item(item: str):
-		destination = f"{path}/minecraft/{item}.png"
+	def download_item(item: str, destination: str = ""):
+		if not destination:
+			destination = f"{path}/minecraft/{item}.png"
 		if not (os.path.exists(destination) and cache_assets):	# If not downloaded yet or not using cache
 			link: str = f"{DOWNLOAD_VANILLA_ASSETS_RAW}/item/{item}.png"
 			response = requests.get(link)
@@ -113,3 +115,14 @@ def generate_all_iso_renders():
 	# Multithread the download
 	multithreading(download_item, used_vanilla_items, max_workers=min(32, len(used_vanilla_items)))
 
+	# Download painting texture for custom paintings
+	last_painting_path: str = ""
+	for item, data in Mem.definitions.items():
+		if data["id"] == "minecraft:painting" and not data.get("item_model"):
+			if not last_painting_path:
+				last_painting_path = f"{path}/{ns}/{item}.png"
+				download_item("painting", last_painting_path)
+			else:
+				# Just copy the last painting downloaded
+				shutil.copy(last_painting_path, f"{path}/{ns}/{item}.png")
+

{stewbeet-2.2.2 → stewbeet-2.2.3}/stewbeet/plugins/initialize/__init__.py

@@ -56,6 +56,10 @@ def beet_default(ctx: Context):
 	ctx.data.pack_format_registry.update(MORE_DATA_PACK_FORMATS)
 	ctx.assets.pack_format_registry.update(MORE_ASSETS_PACK_FORMATS)
 	ctx.meta["data_version"] = MORE_DATA_VERSIONS
+	if ctx.minecraft_version:
+		tuple_version: tuple[int, ...] = tuple(int(x) for x in ctx.minecraft_version.split(".") if x.isdigit())
+		ctx.data.pack_format = ctx.data.pack_format_registry.get(tuple_version, ctx.data.pack_format)
+		ctx.assets.pack_format = ctx.assets.pack_format_registry.get(tuple_version, ctx.assets.pack_format)
 
 	# Helper function to setup pack.mcmeta
 	def setup_pack_mcmeta(pack: Pack[Any], pack_format: int):

{stewbeet-2.2.2 → stewbeet-2.2.3}/stewbeet/plugins/verify_definitions/__init__.py

@@ -16,6 +16,7 @@ from ...core.constants import (
 	CUSTOM_BLOCK_ALTERNATIVE,
 	CUSTOM_BLOCK_VANILLA,
 	NO_SILK_TOUCH_DROP,
+	PAINTING_DATA,
 	RESULT_OF_CRAFTING,
 	USED_FOR_CRAFTING,
 	VANILLA_BLOCK,
@@ -241,6 +242,27 @@ def beet_default(ctx: Context) -> None:
 					if (not recipe.get("result_count") or not isinstance(recipe["result_count"], int)) and (recipe.get("type") not in ("smithing_trim",)):
 						errors.append(f"Recipe #{i} in RESULT_OF_CRAFTING should have an int 'result_count' key for '{item}'")
 
+		# Check the PAINTING_DATA key
+		if data.get(PAINTING_DATA):
+			if data["id"] != "minecraft:painting":
+				errors.append(f"PAINTING_DATA key should only be used with 'id' equal to 'minecraft:painting' for '{item}', found '{data['id']}' instead")
+			elif not isinstance(data[PAINTING_DATA], dict):
+				errors.append(f"PAINTING_DATA key should be a dictionary for '{item}'")
+			else:
+				painting_data = cast(JsonDict, data[PAINTING_DATA])
+				if painting_data.get("author") and not isinstance(painting_data["author"], dict | list | str):
+					errors.append(f"PAINTING_DATA 'author' key should be a Text Component for '{item}', got '{painting_data['author']}'")
+				if painting_data.get("title") and not isinstance(painting_data["title"], dict | list | str):
+					errors.append(f"PAINTING_DATA 'title' key should be a Text Component for '{item}', got '{painting_data['title']}'")
+				if not painting_data.get("width") or not isinstance(painting_data["width"], int) or painting_data["width"] < 1 or painting_data["width"] > 16:
+					errors.append(f"PAINTING_DATA should have an integer 'width' key between 1 and 16 for '{item}'")
+				if not painting_data.get("height") or not isinstance(painting_data["height"], int) or painting_data["height"] < 1 or painting_data["height"] > 16:
+					errors.append(f"PAINTING_DATA should have an integer 'height' key between 1 and 16 for '{item}'")
+
+				# Add missing data if needed
+				if "painting/variant" not in data:
+					data["painting/variant"] = f"{ctx.project_id}:{item}"
+
 	# Log errors if any
 	if errors:
 		error("Errors found in the definitions during verification:\n- " + "\n- ".join(errors))