docs: item-authoring guide for paintable item GLBs#431
Merged
Conversation
Documents the content-author contract for catalog item GLBs: slot_ material naming + deriveSlotId rules, authored defaults and pascal_material extras, the cutout reserved mesh, the ~1 UV unit/m world scale, vertex colours for fixed detail, and the validated Blender + glTF export recipe (Custom Properties export gotcha, gltfpack -ke extras preservation). Indexes the page in the architecture README and links it from materials-and-themes.md (previously a dangling "phase-6 Blender recipe" reference). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds the previously-missing item authoring guide for catalog item GLBs —
wiki/architecture/item-authoring.md. It documents the content-author contract that makes a GLB's parts paintable while keeping authored materials as the default look:slot_<part>material naming and thederiveSlotIdrules (prefix strip,.001dedupe, merge-by-id), sourced frompackages/core/src/lib/slots.tspascal_materialglTF extras (read at runtime frommaterial.userData)cutoutreserved mesh name (hidden boolean-cut helper, never a slot)slot_*→ Cube Projection size 1.0 / Texel Density 10.24 px/cm) and the critical export gotchas: enable Include → Custom Properties or extras are lost, and optimise with gltfpack-keto preserve themAlso indexes the page in
wiki/architecture/README.mdand turns the dangling "phase-6 Blender recipe" reference inmaterials-and-themes.mdinto a real link.Fills Remaining work #2 in the
editor-paint-slotsplan (private-editor). Docs-only — no code changes.How to test
wiki/architecture/item-authoring.mdfor accuracy againstpackages/core/src/lib/slots.ts(SLOT_MATERIAL_PREFIX,deriveSlotId) andpackages/nodes/src/item/renderer.tsx(thecutoutmesh handling anduserData.pascal_materialread).wiki/architecture/README.mdPages table.item-authoringlink inmaterials-and-themes.md→ Texture world scale resolves.Screenshots / screen recording
N/A — documentation-only change.
Checklist
bun dev— N/A, docs-onlybun checkto verify) — N/A, no codemainbranch