2.5 KiB
Glyph Bank Artifact Naming Alignment
The graphical bank artifact, which stores indexed graphical data (glyphs) for runtime consumption, has been aligned with the unified project vocabulary across packer, studio, and runtime.
Original Problem
Previously, the project used inconsistent terminology for the same concrete artifact:
tile_bankin some packer configurations.TILES/indexed_v1as an output format.TILESas a runtime-facingbank_type.TileBankortile bankin Studio UI and internal code.
This created a conceptual overlap with the "tile" domain, which properly refers to geometric sizes, map layers, and grid-based rendering logic. Keeping the artifact named "tile bank" made it difficult to distinguish between the storage container (the bank) and the geometric entities (the tiles) stored within or referenced by it.
Consolidated Decision
Following DEC-0025 (this repository) and DEC-0006 (runtime repository), the concrete graphical bank artifact is now exclusively referred to as Glyph Bank.
- Artifact Name:
glyph_bank(serialized asset-family). - Output Format:
GLYPH/indexed_v1. - Runtime ID:
GLYPH(bank_type). - Vocabulary Split:
- Use Glyph when referring to the graphical data bank, its capacity, or its storage format.
- Use Tile only for geometric concepts (tile size, tile maps, tile layers, coordinate grids).
Implementation Results
- Packer: All
AssetFamilyCatalog,OutputFormatCatalog, and walker implementations now use theGlyph*vocabulary. Parser validation now expectstype: glyph_bank. - Studio: UI labels, composition coordinators, and internal services have been renamed to
Glyph Bankto match the packer and runtime contracts. - Contract: No compatibility layer was introduced. All fixtures and test assets were migrated in a single wave to ensure a clean, unified contract.
Common Pitfalls and Anti-patterns
- Incorrect Rename: Do not rename
tileSizetoglyphSize. A tile is a geometric unit; a glyph is the graphical content within that unit or the bank that stores it. - Legacy Fixtures: Since there is no compatibility layer, old
asset.jsonfiles withtype: tile_bankwill fail to parse. They must be updated totype: glyph_bank.
References
DEC-0025: Local decision for Glyph Bank alignment.PLN-0048: Implementation plan for the naming migration.docs/specs/packer/: Updated specifications for asset declarations.