explain item models / client items

Author: lineargraph

web/.vitepress/config.mts

@@ -7,7 +7,7 @@ export default defineConfig({
   cleanUrls: true,
   markdown: {
     config: (md) => {
-//      md.use(minecraftHoverPlugin)
+      //      md.use(minecraftHoverPlugin)
     }
   },
   themeConfig: {
@@ -19,9 +19,10 @@ export default defineConfig({
 
     sidebar: [
       {
-        text: 'Developers',
+        text: 'Resource Packs',
         items: [
-          { text: 'Resource Packs', link: '/developers/texture-packs' },
+          { text: 'Basics', link: '/developers/texture-packs' },
+          { text: 'Item Retexturing', link: '/developers/texture-packs/items' },
         ]
       }
     ],

web/.vitepress/theme/index.ts

@@ -26,7 +26,7 @@ const orEmpty = (str: string | null | undefined, seperator: string = " ") => str
 function inject() {
 	for (const [attr, appl] of attrs) {
 		document.querySelectorAll(`code[${attr}]`).forEach(entry => {
-			const [ns, path] = parseIdent(entry.textContent)
+			const [ns, path] = parseIdent(entry.innerHTML)
 			const attrValue = entry.getAttribute(attr)
 			tippy(entry, {
 				content: appl(ns, path, attrValue),

web/developers/texture-packs.md

@@ -1,6 +1,9 @@
 
 # Custom SkyBlock Items Texture Pack Format
 
+> [!WARNING]
+> This wiki is currently being reworked. Most information should still be correct, but i cant be sure.
+
 Firmament generally tries to emulate the vanilla structure of resourcepacks whenever possible. Because of that it is extremely helpful to know the general structure of vanilla resource packs. The [minecraft wiki](https://minecraft.wiki/w/Resource_pack) is a good starting place to learn, but some basic terms will be explained here as well.
 
 ## Identifiers

web/developers/texture-packs/items.md

@@ -4,6 +4,41 @@ Firmament allows you to replace the models of items in a couple of ways.
 
 ## By SkyBlock ID
 
-Firmament allows you to remodel 
+Firmament allows you to entirely replace the item model of a SkyBlock item based on its SkyBlock ID. To do this, you can place a model at `firmskyblock:<itemid>`{model=item}.
 
+On older versions (before 1.21) Minecraft had system for specifying custom predicates inside of models:
 
+```json
+{
+    "parent": "minecraft:item/handheld",
+    "textures": {
+        "layer0": "firmskyblock:item/bat_wand"
+    },
+    "overrides": [
+        {
+            "predicate": {
+                "firmament:display_name": {
+                    "regex": ".*§d.*",
+                    "color": "preserve"
+                }
+            },
+            "model": "firmskyblock:item/recombobulated_bat_wand"
+        }
+    ]
+}
+```
+
+Nowadays, these types of `overrides` / `predicate` combos are instead seperated out into a client item. The client item is located at `<namespace>:items/<itemid>.json`{fqfi}, which then references the actual rendered item model in its definition. Firmament supports exclusively for the `firmskyblock` namespace an automatic conversion from the old format to the new format. Users are nevertheless encouraged to instead of just creating a renderable item model (at `firmskyblock:<skyblockid>`{model=item}) to also create a client item definition (at `firmskyblock:items/<skyblockid>.json`{fqfi}).
+
+That item definition would then reference the actual model file (at any location you want, but i for now have just chosen to reference the default legacy location):
+
+```json{4}
+{
+    "model": {
+        "type": "minecraft:model",
+        "model": "firmskyblock:item/<skyblockid>"
+    }
+}
+```
+
+Note that the inner `model` refers to any model, so you need to explicitly specify the `item/` prefix, which is implicit in the legacy item model system.