Document the focal frame

Author: object-Object

.vscode/settings.json

@@ -14,9 +14,7 @@
         "editor.rulers": [120],
     },
     "ruff.organizeImports": true,
-    "ruff.lint.args": [
-        "--extend-ignore=I", // format on save is enabled, so don't show the squiggles
-    ],
+    "ruff.lint.ignore": ["I"],
     "python.languageServer": "Pylance",
     "python.analysis.diagnosticMode": "workspace",
     "python.analysis.packageIndexDepths": [

Common/src/main/resources/assets/hexcasting/patchouli_books/thehexbook/en_us/entries/items/focus_holder.json5

@@ -0,0 +1,31 @@
+{
+  name: "hexdebug.category.items.entry.focus_holder",
+  category: "hexcasting:items",
+  icon: "hexdebug:focus_holder",
+  advancement: "hexcasting:root",
+  pages: [
+    {
+      type: "patchouli:text",
+      text: "hexdebug.category.items.entry.focus_holder.page.1",
+    },
+    {
+      type: "patchouli:text",
+      text: "hexdebug.category.items.entry.focus_holder.page.2",
+    },
+    {
+      type: "patchouli:crafting",
+      recipe: "hexdebug:focus_holder",
+      anchor: "focus_holder",
+      text: "hexdebug.category.items.entry.focus_holder.page.recipe",
+    },
+    {
+      type: "patchouli:crafting",
+      recipe: "hexdebug:focus_holder_filling_shaped/new_holder",
+      recipe2: "hexdebug:focus_holder_filling_shaped/new_focus",
+    },
+    {
+      type: "patchouli:text",
+      text: "hexdebug.category.items.entry.focus_holder.page.3",
+    }
+  ],
+}

Common/src/main/resources/assets/hexdebug/lang/en_us.flatten.json5

@@ -186,6 +186,16 @@
               thwonk: "$(italic)Thwonk!/$"
             },
           },
+          focus_holder: {
+            "": "Focal Frame",
+            page: {
+              "1": "$(l:items/focus)$(thing)Foci/$ are useful for storing _Hexes and other iotas in my inventory, but I sometimes find myself in need of a way to store iotas in the world. Item frames are too fragile, and $(l:greatwork/akashiclib)other methods/$ are inefficient and... distasteful. A cleaner solution is necessary, and I've devised one in the form of the $(thing)Focal Frame/$.",
+              "2": "A $(thing)Focal Frame/$ by itself is useless; a $(l:items/focus)$(thing)Focus/$ must first be inserted. I can do that through crafting, or by right-clicking a placed $(thing)Focal Frame/$ with a $(l:items/focus)$(thing)Focus/$. Right-clicking with an empty hand removes the $(l:items/focus)$(thing)Focus/$ from the frame.$(br2)\
+                As an item, I can use a filled $(thing)Focal Frame/$ anywhere I would normally use a $(l:items/focus)$(thing)Focus/$, including patterns such as $(l:patterns/readwrite#hexcasting:read)$(action)Scribe's Reflection/$. When placed in the world, I can access it using patterns like $(l:patterns/readwrite_blocks#hexcasting:read/entity)$(action)Chronicler's Purification/$.",
+              recipe: "$(italic)Two thousand movies, four thousand albums, music and words and pictures like voices whispering from a sweet, sunny past./$",
+              "3": "In addition to these recipes, I can craft an empty $(thing)Focal Frame/$ with a $(l:items/focus)$(thing)Focus/$ to insert it; and I can craft a filled $(thing)Focal Frame/$ by itself to remove the $(l:items/focus)$(thing)Focus/$ from it, leaving the empty frame behind."
+            },
+          },
           splicing_table: {
             "": "Splicing Table",
             page: {

doc/resources/assets/hexcasting/lang/en_us.flatten.json5

@@ -4,5 +4,7 @@
       title: "HexDebug Book",
       description: "The HexDebug Book, all in one place.",
     },
-  }
+  },
+
+  "block.hexdebug.focus_holder.full": "Focal Frame",
 }

doc/resources/assets/hexdebug/models/item/focus_holder/full.json

@@ -0,0 +1,3 @@
+{
+  "parent": "hexdebug:block/focus_holder/full"
+}

doc/src/hexdoc_hexdebug/_hooks.py

@@ -2,6 +2,7 @@
 
 from hexdoc.plugin import (
     HookReturn,
+    LoadTaggedUnionsImpl,
     ModPlugin,
     ModPluginImpl,
     ModPluginWithBook,
@@ -11,11 +12,17 @@
 
 import hexdoc_hexdebug
 
+from . import recipes
 from .__gradle_version__ import FULL_VERSION, MINECRAFT_VERSION, MOD_VERSION
 from .__version__ import PY_VERSION
 
 
-class HexDebugPlugin(ModPluginImpl):
+class HexDebugPlugin(LoadTaggedUnionsImpl, ModPluginImpl):
+    @staticmethod
+    @hookimpl
+    def hexdoc_load_tagged_unions() -> HookReturn[Package]:
+        return [recipes]
+
     @staticmethod
     @hookimpl
     def hexdoc_mod_plugin(branch: str) -> ModPlugin:

doc/src/hexdoc_hexdebug/recipes.py

@@ -0,0 +1,19 @@
+from typing import Any
+
+from hexdoc.minecraft.recipe import CraftingShapedRecipe, ItemResult
+from pydantic import field_validator
+
+
+class FocusHolderFillingShapedRecipe(
+    CraftingShapedRecipe, type="hexdebug:focus_holder_filling_shaped"
+):
+    @field_validator("result", mode="before")
+    @classmethod
+    def _replace_result(cls, value: Any):
+        # hack: hexdoc doesn't support predicates, so add a fake model for the filled variant
+        result = {"item": "hexdebug:focus_holder/full"}
+        match value:
+            case {"count": count} | ItemResult(count=count):
+                return result | {"count": count}
+            case _:
+                return result

pyproject.toml

@@ -40,7 +40,7 @@ dependencies = [
 
 [tool.hatch.metadata.hooks.version-catalog.optional-dependencies]
 dev = [
-    "ruff~=0.3.7",
+    "ruff~=0.13.1",
 ]
 
 # directory inclusion
@@ -103,7 +103,7 @@ exclude = [
     "**/__pycache__",
 ]
 
-typeCheckingMode = "basic"
+typeCheckingMode = "standard"
 
 strictDictionaryInference = true
 strictListInference = true