Skip to content

Commit f4cb92a

Browse files
committed
plan(parallax-editor): adopt project asset registry integration
1 parent 3cb09fc commit f4cb92a

12 files changed

Lines changed: 157 additions & 130 deletions

docs/dev/CODEX_COMMANDS.md

Lines changed: 9 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,14 @@
11
MODEL: GPT-5.3-codex
22
REASONING: high
33

4-
BUILD_PR_DEMO1208_TOOL_FORMATTED_TILES_PARALLAX
4+
COMMAND:
5+
Create BUILD_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION.
56

6-
THIS IS A MANDATORY CHANGE.
7-
A NO-OP RESULT IS INVALID.
7+
Requirements:
8+
- Integrate Parallax Editor with project asset registry
9+
- Use ID-based references (no direct paths)
10+
- Maintain backward compatibility
11+
- Do not modify engine core APIs
812

9-
PRIMARY GOAL
10-
Implement Demo 1208 - Tool Formatted Tiles Parallax as a runnable authoring-pipeline validation demo.
11-
12-
SECONDARY REQUIRED FIX
13-
Fix samples/index.html so Demo 1207 no longer links to README.md and instead opens the runnable demo entry page.
14-
15-
FOUNDATION TO PRESERVE
16-
- tilemap
17-
- hero movement
18-
- Space-to-jump
19-
- gravity
20-
- grounded behavior
21-
- collision
22-
- camera follow
23-
- parallax
24-
- larger-than-viewport scrolling world
25-
26-
NEW CONCEPT FOR THIS PR
27-
Use content formatted as if it came from the user's tools:
28-
- tile content shaped like Tile Map Editor output
29-
- SVG parallax content shaped like Parallax Editor output
30-
31-
REQUIRED WORK
32-
1. Implement Demo 1208 using repo-consistent demo structure
33-
2. Add actual tile assets for Demo 1208
34-
3. Add actual SVG parallax assets for Demo 1208
35-
4. Add sample-local config/data shaped like tool exports
36-
5. Preserve proven hero movement, jump, gravity, collision, camera follow, and parallax behavior
37-
6. Ensure the world is larger than the viewport and visibly scrolls
38-
7. Update samples/index.html:
39-
- fix Demo 1207 link to point to runnable index.html, not README.md
40-
- point Demo 1208 to runnable index.html
41-
8. Keep README.md accurate
42-
43-
ALLOWED CHANGES
44-
Primary:
45-
- samples/Phase 12 - Demo Games/Demo 1208 - Tool Formatted Tiles Parallax/**
46-
Secondary:
47-
- samples/index.html
48-
Tertiary only if strictly required for the 1207 broken link fix:
49-
- samples/Phase 12 - Demo Games/Demo 1207 - Switch Checkpoint Marker/**
50-
51-
BLOCKED CHANGES
52-
- engine changes
53-
- tool changes
54-
- tests changes
55-
- games changes
56-
- non-Phase-12 changes beyond samples/index.html
57-
- new gameplay systems
58-
- enemies
59-
- inventory
60-
- menus
61-
- save/load
62-
63-
VALIDATION (FAIL IF NOT TRUE)
64-
- Demo 1208 launches
65-
- actual tile assets are used
66-
- actual SVG parallax assets are used
67-
- hero is visible
68-
- Left/Right movement works
69-
- Space triggers jump
70-
- gravity is active
71-
- collision works
72-
- camera follows hero cleanly
73-
- parallax is visible
74-
- tilemap is larger than viewport
75-
- scrolling is visible during play
76-
- Demo 1207 index target opens runnable page, not README.md
77-
- Demo 1208 index target opens runnable page
78-
- no diff outside:
79-
- samples/Phase 12 - Demo Games/Demo 1208 - Tool Formatted Tiles Parallax/**
80-
- samples/index.html
81-
- Demo 1207 files only if strictly required for the link fix
82-
- no engine/tools/tests/games changes
83-
- README matches actual behavior
84-
85-
COMMIT MESSAGE
86-
BUILD_PR: implement Demo 1208 tool-formatted tiles parallax and fix Demo 1207 index link
87-
88-
- add runnable Demo 1208 using tool-shaped tile and SVG parallax assets
89-
- preserve proven movement, jump, collision, camera follow, and parallax behavior
90-
- fix samples/index.html so Demo 1207 opens runnable index.html instead of README.md
91-
- keep change limited to Phase 12 demos and index
92-
- no engine, tools, tests, or games changes
93-
94-
OUTPUT CONTRACT (MANDATORY)
95-
- Produce a repo-structured delta ZIP
96-
- Output path:
97-
<project folder>/tmp/BUILD_PR_DEMO1208_TOOL_FORMATTED_TILES_PARALLAX_delta.zip
98-
- ZIP must contain only changed/added files for this BUILD_PR
99-
- ZIP must not be empty
13+
Package:
14+
HTML-JavaScript-Gaming/tmp/BUILD_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION_delta.zip

docs/dev/COMMIT_COMMENT.txt

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
1-
BUILD_PR: implement Demo 1208 tool-formatted tiles parallax and fix Demo 1207 index link
2-
3-
- add runnable Demo 1208 using tool-shaped tile and SVG parallax assets
4-
- preserve proven movement, jump, collision, camera follow, and parallax behavior
5-
- fix samples/index.html so Demo 1207 opens runnable index.html instead of README.md
6-
- keep change limited to Phase 12 demos and index
7-
- no engine, tools, tests, or games changes
1+
plan(parallax-editor): adopt project asset registry integration

docs/dev/change_summary.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Introduces Parallax Editor adoption of asset registry (docs-only).

docs/dev/file_tree.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
docs/pr/PLAN_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION.md
2+
docs/dev/codex_commands.md
3+
docs/dev/commit_comment.txt
4+
docs/dev/change_summary.txt
5+
docs/dev/validation_checklist.txt
6+
docs/dev/file_tree.txt
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Created APPLY bundle for APPLY_PR_TILEMAP_EDITOR_ASSET_REGISTRY_ADOPTION.
1+
Created implementation bundle for BUILD_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION.
22

33
Summary:
4-
- Confirms the built Tile Map Editor registry adoption slice is ready to apply as implemented.
5-
- Verifies build/package scope stays limited to the approved Tile Map Editor registry files and docs.
6-
- Reaffirms legacy compatibility, additive registry preservation, and no engine or Parallax scope expansion.
4+
- Updates Parallax Editor to save registry-managed layers via ID-based references.
5+
- Preserves additive `images` and `parallaxSources` registry behavior through shared helpers.
6+
- Maintains backward compatibility for legacy direct-path parallax and tilemap documents.

docs/dev/reports/file_tree.txt

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
APPLY_PR_TILEMAP_EDITOR_ASSET_REGISTRY_ADOPTION_delta/
2-
└── docs/
3-
├── dev/
4-
│ └── reports/
5-
│ ├── change_summary.txt
6-
│ ├── file_tree.txt
7-
│ └── validation_checklist.txt
8-
└── pr/
9-
└── APPLY_PR_TILEMAP_EDITOR_ASSET_REGISTRY_ADOPTION.md
1+
BUILD_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION_delta/
2+
├── docs/
3+
│ ├── dev/
4+
│ │ └── reports/
5+
│ │ ├── change_summary.txt
6+
│ │ ├── file_tree.txt
7+
│ │ └── validation_checklist.txt
8+
│ └── pr/
9+
│ └── BUILD_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION.md
10+
└── tools/
11+
└── Parallax Editor/
12+
├── README.md
13+
└── main.js
Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
APPLY VALIDATION CHECKLIST
1+
BUILD VALIDATION CHECKLIST
22

3-
- [x] Build artifact `tmp/BUILD_PR_TILEMAP_EDITOR_ASSET_REGISTRY_ADOPTION_delta.zip` exists
4-
- [x] Build artifact contents confirmed limited to approved PR files
5-
- [x] Plan/build/apply alignment confirmed for Tile Map Editor registry adoption
6-
- [x] Legacy compatibility and additive registry preservation confirmed in apply notes
7-
- [x] No engine core API changes or Parallax Editor scope expansion introduced during APPLY
8-
- [x] Syntax validation re-confirmed for changed JS files
9-
- [x] APPLY bundle is docs-only
3+
- [x] Parallax Editor integrated with project asset registry
4+
- [x] Registry-managed saves use ID-based references instead of direct paths
5+
- [x] Backward compatibility preserved for legacy parallax/tilemap JSON
6+
- [x] No engine core API changes introduced
7+
- [x] Shared registry helpers reused without destructive registry replacement
8+
- [x] Syntax validation passed for changed JS files

docs/dev/validation_checklist.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- No code changes in PLAN
2+
- Contracts clearly defined
3+
- Backward compatibility documented
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Toolbox Aid
2+
David Quesenberry
3+
04/04/2026
4+
BUILD_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION.md
5+
6+
# BUILD_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION
7+
8+
## Goal
9+
Integrate Parallax Editor with the shared project asset registry using ID-based references while preserving backward compatibility and avoiding engine core API changes.
10+
11+
## Implemented scope
12+
- Reused shared registry helpers already used by Sprite Editor and Tile Map Editor.
13+
- Kept additive registry integration for Parallax Editor:
14+
- load/save `project.assets.json`
15+
- additive `images` and `parallaxSources` upserts
16+
- persisted layer-level `parallaxSourceId`
17+
- persisted document-level `assetRefs.parallaxSourceIds`
18+
- Switched registry-managed parallax saves to prefer ID-based references:
19+
- saved parallax JSON omits direct `imageSource` paths for registry-managed layers
20+
- tilemap parallax patch export uses the same ID-first shape
21+
- Preserved backward compatibility:
22+
- legacy parallax and tilemap documents with direct paths still load
23+
- registry resolution restores missing paths lazily when ids are available
24+
- unresolved refs degrade with status messaging instead of hard failure
25+
26+
## Scope boundaries honored
27+
- No engine core API changes
28+
- No Sprite Editor or Tile Map Editor rework
29+
- No destructive registry replacement behavior
30+
31+
## Validation summary
32+
- Syntax checks passed:
33+
- `node --check tools/shared/projectAssetRegistry.js`
34+
- `node --check tools/Parallax Editor/main.js`
35+
- Validation checklist updated and all items marked pass in `docs/dev/reports/validation_checklist.txt`.
36+
37+
## Packaging
38+
- Delta ZIP: `tmp/BUILD_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION_delta.zip`
39+
- ZIP contains only files relevant to this PR.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# PLAN_PR_PARALLAX_EDITOR_ASSET_REGISTRY_ADOPTION
2+
3+
## Goal
4+
Adopt project asset registry within Parallax Editor while maintaining backward compatibility.
5+
6+
## Scope
7+
- Read/write parallax layers via project asset registry
8+
- Reference assets via IDs (not paths)
9+
- Maintain legacy file support
10+
11+
## Constraints
12+
- No engine changes
13+
- No breaking existing tools
14+
- Registry is source of truth
15+
16+
## Contracts
17+
- layer.assetRefs.imageId
18+
- lazy resolution
19+
- fallback for missing assets
20+
21+
## Validation
22+
- Load existing parallax JSON
23+
- Save new registry-based project
24+
- No runtime errors

0 commit comments

Comments
 (0)