stewbeet 3.4.3__tar.gz → 3.4.4__tar.gz

{stewbeet-3.4.3 → stewbeet-3.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stewbeet
-Version: 3.4.3
+Version: 3.4.4
 Summary: Beet Framework made to help generating advanced Minecraft datapack contents
 Author: Stoupy51
 Author-email: Stoupy51 <stoupy51@gmail.com>

{stewbeet-3.4.3 → stewbeet-3.4.4}/pyproject.toml

@@ -8,7 +8,7 @@ module-root = ""
 
 [project]
 name = "stewbeet"
-version = "3.4.3"
+version = "3.4.4"
 description = "Beet Framework made to help generating advanced Minecraft datapack contents"
 readme = "README.md"
 license = "MIT"

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/core/__memory__.py

@@ -14,6 +14,8 @@ if TYPE_CHECKING:
 
 # Shared variables among plugins
 class Mem:
+
+    # Public and should be used
     ctx: Context = None
     """ Global context object that holds the beet project configuration.
     This is set during plugins.initialize and used throughout the codebase. """
@@ -24,7 +26,14 @@ class Mem:
     external_definitions: dict[str, ExternalItem] = {}
     """ Secondary JsonDict for storing external items or blocks most likely for recipes. """
 
+
+    # Very internal,
     manual: Manual | None = None
     """ The ingame_manual Manual handle, used to register pages/hooks during setup.
     Created lazily via stewbeet.get_manual(); reset after each build (for `beet watch`). """
 
+    used_textures: set[str] = set()
+    """ Source texture paths consumed by generators (e.g. manual book_texture / TexturePage
+    backgrounds) that get re-encoded under new names. The check_unused_textures plugin treats
+    them as used. Reset by plugins.initialize (for `beet watch`). """
+

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/core/__memory__.pyi

@@ -8,3 +8,4 @@ class Mem:
     definitions: dict[str, Item]
     external_definitions: dict[str, ExternalItem]
     manual: Manual | None
+    used_textures: set[str]

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/finalyze/check_unused_textures/__init__.py

@@ -8,6 +8,8 @@ import stouputils as stp
 from beet import Context, Texture
 from stouputils.typing import JsonDict
 
+from ....core.__memory__ import Mem
+
 
 # Main entry point
 @stp.measure_time(message="Execution time of 'stewbeet.plugins.finalyze.check_unused_textures'")
@@ -29,8 +31,15 @@ def beet_default(ctx: Context) -> None:
 	textures: set[str] = {stp.relative_path(str(p), textures_folder) for p in Path(textures_folder).rglob("*.png")}
 
 	# 2) For each texture, check if any of the ctx.assets.textures matches the texture filename.
+	# Textures consumed as source files by generators (e.g. manual book_texture / TexturePage
+	# backgrounds) are re-encoded under new names, so they never appear in ctx.assets.textures:
+	# they are recorded in Mem.used_textures and skipped here.
+	consumed: set[str] = {stp.clean_path(p) for p in Mem.used_textures}
 	unused_paths: set[str] = set()
 	for path in textures:
+		full_path: str = stp.clean_path(f"{textures_folder}/{path}")
+		if any(u == full_path or u.endswith("/" + path) for u in consumed):
+			continue
 		# Get just the filename without extension for comparison
 		filename_no_ext: str = os.path.splitext(os.path.basename(path))[0]
 		no_extension_path: str = os.path.splitext(path)[0]

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/api.py

@@ -19,6 +19,7 @@ from .pages import (
 	RawPage,
 	TexturePage,
 )
+from .paths import template_path
 from .recipes import CraftRenderer, WikiButtonRender, register_craft_renderer
 from .refs import PageRef
 
@@ -41,6 +42,7 @@ __all__ = [
 	"WikiButtonRender",
 	"get_manual",
 	"register_craft_renderer",
+	"template_path",
 ]
 
 

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/dialog.py

@@ -132,10 +132,19 @@ class DialogEmitter:
 				"click_event": {"action": "show_dialog", "dialog": next_dialog_id},
 				"hover_event": {"action": "show_text", "value": [{"text": "Go to next page"}, f" ({next_index + 1})"]},
 			}
-			nav_contents: list[TextComponent] = [{"text": BOOK_FONT + NONE_FONT * 3, "font": f"{ns}:manual", "color": "white"}]
+			# Book background & home button: the page's own override glyphs if set, else the shared ones.
+			book_font: str = page_obj.book_font if page_obj is not None and page_obj.book_font else BOOK_FONT
+			home_font: str = page_obj.home_font if page_obj is not None and page_obj.home_font else HOME_FONT
+			nav_contents: list[TextComponent] = [{"text": book_font + NONE_FONT * 3, "font": f"{ns}:manual", "color": "white"}]
+			# No home button on the first page (it IS the home page) or when the page opts out.
+			hide_home: bool = page_index == 0 or (page_obj is not None and not page_obj.home_button)
 			for row in range(2):
 				nav_contents.append({"text": "\n" + NONE_FONT * 3, **prev_event})
-				nav_contents.append({"text": (HOME_FONT if row == 0 else NONE_FONT), "font": f"{ns}:manual", "color": "white", **home_event})
+				if hide_home:
+					# Keep the spacing but drop the button
+					nav_contents.append({"text": NONE_FONT, "font": f"{ns}:manual", "color": "white"})
+				else:
+					nav_contents.append({"text": (home_font if row == 0 else NONE_FONT), "font": f"{ns}:manual", "color": "white", **home_event})
 				nav_contents.append({"text": NONE_FONT * 3, **next_event})
 
 			dialog: JsonDict = {
@@ -183,3 +192,4 @@ execute if items entity @s weapon.* *[custom_data~{{{ns}:{{manual:true}}}}] run
 			"dialogs": dialog_ids,
 			"exit_action": {"label": {"translate": "gui.back"}, "width": 200},
 		}))
+

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/glyphs.py

@@ -85,6 +85,14 @@ HOVER_EQUIVALENTS: dict[str, str] = {
 # First dynamically-allocated code point (high-res item icons, wiki result icons, page glyphs...)
 DEFAULT_NEXT_CRAFT_FONT: int = 0x8000
 
+# Bitmap placement of the book background glyph (shared BOOK_FONT and per-page overrides)
+BOOK_ASCENT: int = 25
+BOOK_HEIGHT: int = 300
+
+# Bitmap placement of the home button glyph (shared HOME_FONT and per-page overrides)
+HOME_ASCENT: int = 8
+HOME_HEIGHT: int = 20
+
 # Misc constants
 SQUARE_SIZE: int = 32
 FONT_FILE: str = "manual"

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/images.py

@@ -134,6 +134,8 @@ class GlyphImageBuilder:
 	""" Cache for :meth:`get_border_color`. """
 	_wiki_icons_generated: set[str] = field(default_factory=set[str])
 	""" Wiki icon files already generated this build (skip re-encoding identical PNGs). """
+	_spacer_chars: dict[int, str] = field(default_factory=dict[int, str])
+	""" Invisible spacer glyph per pixel width (see :meth:`invisible_spacer`). """
 
 	# --- helpers ---
 	def get_border_color(self) -> tuple[int, int, int, int]:
@@ -290,6 +292,22 @@ class GlyphImageBuilder:
 		return font
 
 	# --- new texture-page helpers ---
+	def invisible_spacer(self, width_px: int) -> str:
+		""" Return an invisible glyph advancing exactly ``width_px`` pixels ("" if <= 0).
+
+		The square ``none`` texture rendered at height ``H`` advances ``H + 1`` pixels, so one
+		provider (ascent 0, height ``width_px - 1``) is registered per distinct width, then reused.
+		Used by :class:`~.pages.texture_page.TexturePage` left/right paddings.
+		"""
+		if width_px <= 0:
+			return ""
+		char: str | None = self._spacer_chars.get(width_px)
+		if char is None:
+			char = self.glyphs.allocate()
+			self.glyphs.add_provider(char, f"{self.config.project_id}:font/none.png", ascent=0, height=width_px - 1)
+			self._spacer_chars[width_px] = char
+		return char
+
 	def bake_text_onto(self, background: Image.Image, baked_texts: list[BakedText]) -> Image.Image:
 		""" Draw a list of :class:`BakedText` onto a copy of ``background`` and return it. """
 		out = background.convert("RGBA").copy()

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/manual.py

@@ -459,6 +459,7 @@ class Manual:
 		from .showcase import generate_showcase_images
 
 		manual_emit.register_static_assets(self)
+		manual_emit.register_nav_overrides(self)
 		manual_emit.write_font(self)
 		manual_emit.copy_generated_textures(self)
 		manual_emit.validate_providers(self)

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/manual_emit.py

@@ -11,6 +11,7 @@ from typing import TYPE_CHECKING
 
 import stouputils as stp
 from beet import Font, Texture
+from PIL import Image
 
 from ...core.__memory__ import Mem
 from ...core.cls.item import Item
@@ -18,9 +19,13 @@ from .glyphs import (
 	AWAKENED_3X3_FONT,
 	AWAKENED_3X4_FONT,
 	AWAKENED_FORGE_STRUCT_FONT,
+	BOOK_ASCENT,
 	BOOK_FONT,
+	BOOK_HEIGHT,
 	FURNACE_FONT,
+	HOME_ASCENT,
 	HOME_FONT,
+	HOME_HEIGHT,
 	HOVER_AWAKENED_3X3_FONT,
 	HOVER_AWAKENED_3X4_FONT,
 	HOVER_FURNACE_FONT,
@@ -46,7 +51,7 @@ from .glyphs import (
 	WIKI_NONE_FONT,
 	WIKI_RESULT_OF_CRAFT_FONT,
 )
-from .paths import TEMPLATES_PATH
+from .paths import TEMPLATES_PATH, template_path
 
 if TYPE_CHECKING:
 	from .manual import Manual
@@ -122,8 +127,36 @@ def register_static_assets(manual: Manual) -> None:
 		if manual.has_forge_3x3 or manual.has_forge_3x4:
 			add(AWAKENED_FORGE_STRUCT_FONT[0], f("awakened_forge_1"), 8, 56)
 			add(AWAKENED_FORGE_STRUCT_FONT[1], f("awakened_forge_2"), 8, 56)
-	add(BOOK_FONT, f("book"), 25, 300)
-	add(HOME_FONT, f("home"), 8, 20)  # same advance as NONE_FONT so the prev/next gap stays aligned
+	add(BOOK_FONT, f("book"), BOOK_ASCENT, BOOK_HEIGHT)
+	add(HOME_FONT, f("home"), HOME_ASCENT, HOME_HEIGHT)  # same advance as NONE_FONT so the prev/next gap stays aligned
+
+
+def load_page_texture(texture: str | Image.Image) -> Image.Image:
+	""" Open a per-page override texture. A string resolves as a project path first, then
+	against the templates dir (so a ``manual_overrides`` filename works); the source is marked
+	used because it gets re-encoded under a new name. """
+	if isinstance(texture, str):
+		source: str = texture if os.path.exists(texture) else template_path(texture)
+		Mem.used_textures.add(source)
+		return Image.open(source)
+	return texture
+
+
+def register_nav_overrides(manual: Manual) -> None:
+	""" Register dedicated glyphs for every page overriding ``book_texture`` / ``home_texture``.
+
+	Each glyph replaces ``BOOK_FONT`` / ``HOME_FONT`` in that page's dialog navigation row, with
+	the same ascent/height as the shared provider so the layout stays put (a home texture should
+	keep the default's 16x16 proportions, since the glyph advance follows the image content).
+	"""
+	for page in manual.pages:
+		glyph_suffix: str = page.anchor.replace(":", "_").replace(" ", "_").lower()
+		if page.book_texture is not None:
+			image = load_page_texture(page.book_texture)
+			page.book_font = manual.images.register_full_page_glyph(image.convert("RGBA"), f"book_{glyph_suffix}", ascent=BOOK_ASCENT, height=BOOK_HEIGHT)
+		if page.home_texture is not None:
+			image = load_page_texture(page.home_texture)
+			page.home_font = manual.images.register_full_page_glyph(image.convert("RGBA"), f"home_{glyph_suffix}", ascent=HOME_ASCENT, height=HOME_HEIGHT)
 
 
 def write_font(manual: Manual) -> None:

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/pages/base.py

@@ -12,6 +12,7 @@ from dataclasses import dataclass, field
 from typing import TYPE_CHECKING
 
 from beet.core.utils import TextComponent
+from PIL import Image
 
 from ..button_layout import ButtonLayout
 
@@ -29,11 +30,20 @@ class Page:
 
 	Attributes:
 		anchor			(str):	Stable identity used for ordering and deferred links (e.g. "intro",
-						"category:Materials", "item:wrench"). Must be unique within a manual.
+			"category:Materials", "item:wrench"). Must be unique within a manual.
 		title			(str):	Human-readable page title.
 		item_id			(str|None):	If this page represents an item, its id (drives ``PageRef(item=...)``
-						resolution and dialog atlas sprites).
+			resolution and dialog atlas sprites).
 		button_layout	(ButtonLayout|None):	Per-page override of the manual-wide button layout.
+		book_texture	(str|Image.Image|None):	Per-page override of the book background ("book.png").
+						A path (project path, or a filename resolved against the templates dir so
+						``manual_overrides`` files work) or a ready PIL image. None = shared book.
+		home_texture	(str|Image.Image|None):	Per-page override of the home button ("home.png"),
+			same accepted values as ``book_texture``. Keep the default's 16x16
+			proportions so the navigation row stays aligned. None = shared home.
+		home_button	(bool):	Whether this page shows the home button in its navigation row
+			(an invisible spacer keeps the prev/next layout when hidden).
+			The first page never shows it regardless of this flag.
 		transformers	(list):	Developer hooks applied to the rendered content, in order.
 
 	>>> page = Page(anchor="demo", transformers=[lambda content, manual: [*content, "!"]])
@@ -44,6 +54,13 @@ class Page:
 	title: str = ""
 	item_id: str | None = None
 	button_layout: ButtonLayout | None = None
+	book_texture: str | Image.Image | None = None
+	book_font: str = field(default="", init=False, repr=False)
+	""" Glyph char registered for :attr:`book_texture` (set during emit, "" = shared BOOK_FONT). """
+	home_texture: str | Image.Image | None = None
+	home_font: str = field(default="", init=False, repr=False)
+	""" Glyph char registered for :attr:`home_texture` (set during emit, "" = shared HOME_FONT). """
+	home_button: bool = True
 	transformers: list[Transformer] = field(default_factory=list[Transformer])
 	optimize: bool = True
 	""" Whether the optimizer may merge this page's components. Set False for pre-built

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/pages/item_page.py

@@ -7,6 +7,8 @@ emitted as deferred :class:`~..refs.PageRef`.
 """
 
 # Imports
+from __future__ import annotations
+
 import copy
 from dataclasses import dataclass, field
 from typing import TYPE_CHECKING, Any, cast
@@ -44,6 +46,9 @@ class ItemPage(Page):
 	""" Every craft related to the item, gathered by :meth:`prepare`. """
 	buttons: list[WikiButtonRender] = field(default_factory=list[WikiButtonRender])
 	""" The wiki buttons rendered on the page (populated during :meth:`build`). """
+	extra_buttons: list[WikiButtonRender] = field(default_factory=list[WikiButtonRender])
+	""" Developer-added buttons appended after the automatic ones (e.g. another item's recipe
+	via ``manual.recipes.button_for_item(...)`` or a page link via ``manual.recipes.link_button(...)``). """
 
 	@classmethod
 	def for_item(cls, item_id: str, **kwargs: Any) -> ItemPage:
@@ -128,6 +133,9 @@ class ItemPage(Page):
 				previous_result = current_result
 				info_buttons.append(recipes.render_button(craft, name, idx))
 
+		# Developer-added buttons (cross-page recipe buttons, page links...)
+		info_buttons += self.extra_buttons
+
 		# Combine with the page's button layout
 		self.buttons = info_buttons
 		layout = self.resolve_button_layout(manual)

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/pages/texture_page.py

@@ -14,6 +14,7 @@ from typing import TYPE_CHECKING
 from beet.core.utils import TextComponent
 from PIL import Image
 
+from ....core.__memory__ import Mem
 from ..images import BakedText
 from .base import Page
 
@@ -29,26 +30,36 @@ class TexturePage(Page):
 		background	(str|Image.Image):	Background image path, or a ready PIL image.
 		baked_texts	(list[BakedText]):	Texts drawn onto the background with PIL.
 		body		(list[TextComponent]):	Optional MC text shown under the texture.
-		glyph_ascent / glyph_height	(int):	Bitmap placement of the page texture.
+		glyph_ascent / glyph_height	(int):	Bitmap placement of the page texture (size and Y offset).
+		left_padding / right_padding	(int):	Invisible pixels emitted before/after the texture glyph.
+						The dialog centers the line, so ``left_padding`` shifts the texture right
+						and ``right_padding`` shifts it left, each by half the padding.
 	"""
 	background: str | Image.Image = ""
 	baked_texts: list[BakedText] = field(default_factory=list[BakedText])
 	body: list[TextComponent] = field(default_factory=list[TextComponent])
 	glyph_ascent: int = 1
 	glyph_height: int = 131
+	left_padding: int = 0
+	right_padding: int = 0
 
 	def build(self, manual: Manual) -> list[TextComponent]:
 		""" Composite the background + baked texts, register it as one glyph, append the body. """
 		config = manual.config
-		bg = Image.open(self.background) if isinstance(self.background, str) else self.background
+		if isinstance(self.background, str):
+			Mem.used_textures.add(self.background)  # the file is re-encoded under a new name, mark the source as used
+			bg = Image.open(self.background)
+		else:
+			bg = self.background
 		composited = manual.images.bake_text_onto(bg, self.baked_texts) if self.baked_texts else bg.convert("RGBA")
 
 		glyph_name = self.anchor.replace(":", "_").replace(" ", "_").lower()
 		page_font = manual.images.register_full_page_glyph(composited, glyph_name, ascent=self.glyph_ascent, height=self.glyph_height)
+		page_text: str = manual.images.invisible_spacer(self.left_padding) + page_font + manual.images.invisible_spacer(self.right_padding)
 
 		# Neutral base (default font, no shadow) so the developer body keeps its own font; only the
 		# page-texture glyph is drawn in the manual font. The title is shown by the dialog itself.
 		content: list[TextComponent] = [{"text": "", "shadow_color": [0,0,0,0]}]
-		content.append({"text": page_font + "\n", "font": config.font, "color": "white"})
+		content.append({"text": page_text + "\n", "font": config.font, "color": "white"})
 		content += list(self.body)
 		return content

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/ingame_manual/recipes/renderer.py

@@ -184,6 +184,40 @@ class RecipeRenderer:
 				button.target = PageRef(item=craft_ingredient)
 		return button
 
+	# --- cross-page buttons (add another item's recipe/link to any page's extra_buttons) ---
+	def button_for_item(self, item_id: str, index: int = 0) -> WikiButtonRender | None:
+		""" Build the wiki button of another item's craft, linking to that item's page.
+
+		Use it to cross-link related pages, e.g. show the Starlight Infuser's recipe button on
+		the Stardust Pillar page. ``index`` selects which of the item's crafts to render (same
+		order as its own page). Returns None (with a warning) if the item has no such craft.
+		"""
+		obj = self.manual.object_for(item_id)
+		if obj is None:
+			stp.warning(f"button_for_item: no item '{item_id}' in the definitions")
+			return None
+		page = self.manual.get_page_for_item(item_id)
+		crafts: list[JsonDict] = page.crafts if page is not None and page.crafts \
+			else self.collect_for_item(item_id, obj, self.manual.definitions_as_objects)
+		if not 0 <= index < len(crafts):
+			stp.warning(f"button_for_item: no craft at index {index} for '{item_id}' ({len(crafts)} available)")
+			return None
+		button = self.render_button(crafts[index], item_id, index)
+		if button.target is None:  # crafts producing the item itself get no target on their own page
+			button.target = PageRef(item=item_id)
+		return button
+
+	def link_button(self, item_id: str, hover: TextComponent | None = None) -> WikiButtonRender:
+		""" Build a wiki button that simply links to another item's page (no recipe).
+
+		The icon shows the item in a wiki slot; ``hover`` defaults to its name plus a click hint.
+		"""
+		ingr = Ingr(item_id)
+		glyph: str = self.images.wiki_result_icon(item_id, {"type": "page_link", "result": ingr})
+		if hover is None:
+			hover = [{"text": ingr.to_name(), "color": "yellow"}, {"text": "\nClick to open this page", "color": "gray"}]
+		return WikiButtonRender(glyph=glyph, hover=hover, target=PageRef(item=item_id), is_info=True)
+
 	# --- growing seed info button (button-only pseudo, built from block metadata) ---
 	def growing_seed_button(self, item_obj: Item) -> WikiButtonRender | None:
 		""" Build an info button describing a block's :class:`GrowingSeed` drops, if any. """

{stewbeet-3.4.3 → stewbeet-3.4.4}/stewbeet/plugins/initialize/__init__.py

@@ -31,6 +31,7 @@ def beet_default(ctx: Context, silent: bool = False) -> Generator[None]:
 		Mem.ctx = ctx
 		Mem.definitions = {}
 		Mem.external_definitions = {}
+		Mem.used_textures = set()
 
 		# Reset per-build module state so consecutive builds in one process (`stewbeet watch`) behave like fresh runs
 		stp.clear_simple_caches()