summaryrefslogtreecommitdiff
path: root/doc/ASSET_SYSTEM.md
diff options
context:
space:
mode:
authorskal <pascal.massimino@gmail.com>2026-02-09 18:37:38 +0100
committerskal <pascal.massimino@gmail.com>2026-02-09 18:37:38 +0100
commit002ab9094f638c46d5db95d478e71c10933aceb2 (patch)
tree56b62717a83c68e10d0f0d40b831e6e9273ffff5 /doc/ASSET_SYSTEM.md
parent0844588c521be6254de7aed62c9d018170b3af5b (diff)
docs: Condense HOWTO.md, move details to technical docs
- HOWTO.md: 184→97 lines (quick reference only) - BUILD.md: Add build modes, header organization, dependency tracking - ASSET_SYSTEM.md: Add developer workflow section - TRACKER.md: Add AudioEngine API documentation Net: -147 lines in HOWTO.md
Diffstat (limited to 'doc/ASSET_SYSTEM.md')
-rw-r--r--doc/ASSET_SYSTEM.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/ASSET_SYSTEM.md b/doc/ASSET_SYSTEM.md
index 4e34378..8f31a6a 100644
--- a/doc/ASSET_SYSTEM.md
+++ b/doc/ASSET_SYSTEM.md
@@ -89,6 +89,21 @@ Runtime: First `GetAsset()` call invokes generator, caches result.
- **Hardcoded procedural dimensions**: Assumes 256×256 RGBA8
- **No integrity checks**: No CRC/hash validation
+## Developer Workflow
+
+**Add new asset:**
+1. Place file in `assets/final/`
+2. Edit `assets/final/demo_assets.txt`:
+ ```
+ MY_ASSET, myfile.ext, NONE, "Description"
+ ```
+3. Regenerate: `./scripts/gen_assets.sh` or rebuild (auto-triggered)
+4. Use in code: `GetAsset(AssetId::MY_ASSET, &size)`
+
+**Modify existing asset:**
+- Edit source file in `assets/final/`
+- CMake auto-detects change and rebuilds
+
## Planned Improvements
See **TODO.md** for detailed task breakdown: