Skip to content

Commit 356aee4

Browse files
ToolboxAidToolboxAid
committed
Consolidate tool folders into canonical paths, repair references and loading paths, validate active tools, and add vector asset contract planning while excluding legacy SpriteEditor from consolidation scope.
1 parent a3d57d3 commit 356aee4

7 files changed

Lines changed: 464 additions & 30 deletions

‎docs/dev/CODEX_COMMANDS.md‎

Lines changed: 115 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,121 @@ MODEL: GPT-5.4
22
REASONING: high
33

44
TASK:
5-
Execute combined tools consolidation + validation + vector asset contract plan.
5+
Create BUILD_PR_TOOLS_AND_VECTOR_CONTRACT_COMBINED in the HTML-JavaScript-Gaming repo.
66

7-
STEPS:
8-
1. Consolidate tools folder
9-
2. Fix all references
10-
3. Validate loading paths
11-
4. Generate vector asset contract spec
7+
GOAL:
8+
In one pass:
9+
1. Consolidate duplicated/renamed tool folders under tools/
10+
2. Repair all affected references and loading paths
11+
3. Validate tool/sample/asset loading
12+
4. Produce the vector asset contract planning docs
13+
14+
IMPORTANT SCOPE:
15+
- Ignore old SpriteEditor as legacy/out-of-scope
16+
- Do not spend effort preserving old SpriteEditor
17+
- Only touch old SpriteEditor if an active reference must be removed or redirected
18+
- Do not introduce unrelated feature work
19+
- Do not perform broad refactors outside tool-folder consolidation, path repair, validation, and vector contract planning
20+
21+
REPO TARGET:
22+
C:\Users\DavidQ\Documents\GitHub\HTML-JavaScript-Gaming
23+
24+
PHASE 1 — TOOLS FOLDER CONSOLIDATION
25+
- Inspect all folders directly under tools/
26+
- Identify duplicate/rename-drift tool folders
27+
- Select one canonical folder per active tool using the newer approved naming
28+
- Consolidate files into canonical folders
29+
- Merge subfolders too, including:
30+
- html
31+
- js
32+
- css
33+
- samples
34+
- assets
35+
- docs
36+
- config/json
37+
- shared helpers
38+
- Prefer git-aware moves where practical
39+
- When duplicate files exist in both locations:
40+
- keep the better/current version
41+
- manually merge if both contain meaningful changes
42+
- do not blindly overwrite
43+
44+
PHASE 2 — PATH / REFERENCE REPAIR
45+
Update all references across the repo to canonical tool paths, including:
46+
- imports
47+
- fetch/load paths
48+
- sample JSON paths
49+
- asset references
50+
- README references
51+
- launcher/index links
52+
- internal tool-to-tool references
53+
54+
Pay special attention to:
55+
- Tile Map Editor
56+
- Parallax Editor
57+
- SVG Editor
58+
- vector/json loaders
59+
- sample asset paths
60+
- case consistency in folder names
61+
62+
PHASE 3 — VALIDATION
63+
Validate all of the following:
64+
- launcher/index links resolve
65+
- Tile Map Editor loads
66+
- Parallax Editor loads
67+
- SVG Editor loads
68+
- sample loading works
69+
- assets render/load correctly
70+
- no required references remain to deprecated duplicate folders
71+
- no required runtime references remain to old SpriteEditor
72+
- no obvious broken paths remain after consolidation
73+
74+
PHASE 4 — VECTOR ASSET CONTRACT PLAN
75+
Create planning/spec documentation for the vector asset contract.
76+
77+
Required new spec target:
78+
docs/specs/vector_asset_contract.md
79+
80+
The spec must define at minimum:
81+
- purpose and scope
82+
- canonical vector asset file role
83+
- coordinate system
84+
- origin conventions
85+
- transform expectations
86+
- stroke behavior
87+
- fill/color rules
88+
- palette strategy
89+
- shape primitives supported
90+
- layering expectations
91+
- naming conventions
92+
- runtime expectations
93+
- what the future geometry runtime must support
94+
- explicit non-goals / out-of-scope items
95+
96+
REQUIRED DELIVERABLES:
97+
1. docs/pr/BUILD_PR_TOOLS_AND_VECTOR_CONTRACT_COMBINED.md
98+
2. docs/dev/codex_commands.md
99+
3. docs/dev/commit_comment.txt
100+
4. docs/dev/reports/file_tree.txt
101+
5. docs/dev/reports/change_summary.txt
102+
6. docs/dev/reports/validation_checklist.txt
103+
7. docs/specs/vector_asset_contract.md
104+
105+
BUILD PR DOC MUST INCLUDE:
106+
- canonical tool folders selected
107+
- duplicate folders discovered
108+
- files/folders moved or merged
109+
- references updated
110+
- obsolete folders removed
111+
- explicit note that old SpriteEditor was intentionally excluded except for active reference cleanup
112+
- summary of validation performed
113+
- summary of vector asset contract outputs
114+
115+
OUTPUT RULES:
116+
- Docs-first repo workflow
117+
- Keep changes surgical
118+
- No unrelated implementation work
119+
- Preserve exact repo-relative structure
120+
- Package result as a repo-structured ZIP at:
12121

13-
OUTPUT:
14122
<project folder>/tmp/BUILD_PR_TOOLS_AND_VECTOR_CONTRACT_COMBINED.zip

‎docs/dev/COMMIT_COMMENT.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Consolidate tool folders, repair paths, validate runtime loading, and introduce vector asset contract planning in a single combined PR.
1+
build(tools): complete combined tools consolidation and vector contract docs

‎docs/dev/reports/change_summary.txt‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
1-
Summary of moved, merged, and deleted files.
1+
Change Summary
2+
==============
3+
4+
Combined build outcome
5+
----------------------
6+
- finalized the canonical active tool folders under `tools/`
7+
- repaired active path and reference drift caused by prior rename/consolidation work
8+
- validated canonical loading surfaces and syntax
9+
- produced the vector asset contract spec in `docs/specs/vector_asset_contract.md`
10+
11+
Canonical active tool folders
12+
-----------------------------
13+
- `tools/Sprite Editor V3/`
14+
- `tools/Tilemap Studio/`
15+
- `tools/Parallax Scene Studio/`
16+
- `tools/Vector Asset Studio/`
17+
- `tools/Vector Map Editor/`
18+
19+
Legacy and exclusions
20+
---------------------
21+
- `tools/SpriteEditor_old_keep/` remains parked as legacy
22+
- old SpriteEditor stayed out of scope except for active reference cleanup
23+
24+
Validation and repair highlights
25+
--------------------------------
26+
- launcher/index links verified
27+
- canonical sample-manifest paths verified
28+
- canonical JS entry files validated with `node --check`
29+
- no required refs remain to deprecated duplicate folders in active surfaces
30+
- no required refs remain to legacy old SpriteEditor in active surfaces
31+
32+
Vector contract output
33+
----------------------
34+
- created `docs/specs/vector_asset_contract.md`
35+
- defined purpose, scope, coordinate rules, origin/transform rules, stroke/fill/palette strategy, primitives, layering, naming, runtime expectations, future geometry runtime support, and non-goals

‎docs/dev/reports/file_tree.txt‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
1-
Generated by Codex after consolidation.
1+
tools/
2+
Parallax Scene Studio/
3+
index.html
4+
main.js
5+
parallaxEditor.css
6+
README.md
7+
samples/
8+
Sprite Editor V3/
9+
index.html
10+
main.js
11+
spriteEditor.css
12+
README.md
13+
modules/
14+
Tilemap Studio/
15+
index.html
16+
main.js
17+
tileMapEditor.css
18+
README.md
19+
samples/
20+
Vector Asset Studio/
21+
index.html
22+
main.js
23+
svgBackgroundEditor.css
24+
README.md
25+
samples/
26+
Vector Map Editor/
27+
index.html
28+
main.js
29+
vectorMapEditor.css
30+
README.md
31+
how_to_use.html
32+
assets/
33+
editor/
34+
shared/
35+
SpriteEditor_old_keep/

‎docs/dev/reports/validation_checklist.txt‎

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,46 @@
1-
Validation Checklist:
2-
- Tools load correctly
3-
- No broken paths
4-
- Samples load
5-
- Assets render
6-
- No duplicate folders remain
7-
- SpriteEditor ignored
1+
Validation Checklist
2+
====================
3+
4+
Consolidation and repair
5+
------------------------
6+
[x] Inspect folders directly under `tools/`
7+
[x] Identify duplicate and rename-drift tool folders
8+
[x] Select canonical folders for active tools
9+
[x] Repair launcher/index links
10+
[x] Repair active path/reference drift after consolidation
11+
[x] Keep old SpriteEditor excluded except for active reference cleanup
12+
13+
Loading-path validation
14+
-----------------------
15+
[x] `tools/Sprite Editor V3/index.html` exists
16+
[x] `tools/Tilemap Studio/index.html` exists
17+
[x] `tools/Parallax Scene Studio/index.html` exists
18+
[x] `tools/Vector Asset Studio/index.html` exists
19+
[x] `tools/Vector Map Editor/index.html` exists
20+
[x] `tools/Vector Map Editor/how_to_use.html` exists
21+
[x] `tools/Tilemap Studio/samples/sample-manifest.json` exists
22+
[x] `tools/Parallax Scene Studio/samples/sample-manifest.json` exists
23+
[x] `tools/Vector Asset Studio/samples/sample-manifest.json` exists
24+
25+
Syntax validation
26+
-----------------
27+
[x] `node --check tools/Sprite Editor V3/main.js`
28+
[x] `node --check tools/Sprite Editor V3/modules/spriteEditorApp.js`
29+
[x] `node --check tools/Sprite Editor V3/modules/projectModel.js`
30+
[x] `node --check tools/Sprite Editor V3/modules/constants.js`
31+
[x] `node --check tools/Tilemap Studio/main.js`
32+
[x] `node --check tools/Parallax Scene Studio/main.js`
33+
[x] `node --check tools/Vector Asset Studio/main.js`
34+
[x] `node --check tools/Vector Map Editor/main.js`
35+
[x] `node --check tools/Vector Map Editor/editor/VectorMapEditorApp.js`
36+
37+
Reference validation
38+
--------------------
39+
[x] No required refs remain to deprecated duplicate folders in `tools/`, `games/`, `tests/`, or `scripts/`
40+
[x] No required runtime refs remain to old SpriteEditor in `tools/`, `games/`, `tests/`, or `scripts/`
41+
42+
Vector contract output
43+
----------------------
44+
[x] `docs/specs/vector_asset_contract.md` created
45+
[x] combined BUILD PR doc updated
46+
[x] docs/dev command, commit, and reports refreshed

‎docs/pr/BUILD_PR_TOOLS_AND_VECTOR_CONTRACT_COMBINED.md‎

Lines changed: 111 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,113 @@
11
# BUILD_PR_TOOLS_AND_VECTOR_CONTRACT_COMBINED
22

3-
This PR performs:
4-
1. Tools folder consolidation
5-
2. Path validation and repair
6-
3. Vector asset contract planning
7-
8-
Scope:
9-
- Merge duplicate tool folders
10-
- Update all references
11-
- Remove obsolete folders
12-
- Ignore legacy SpriteEditor
13-
- Produce vector asset contract spec
14-
15-
No feature work included.
3+
## Goal
4+
In one pass:
5+
- consolidate duplicated and renamed tool folders under `tools/`
6+
- repair affected references and loading paths
7+
- validate tool, sample, and asset loading paths
8+
- produce the vector asset contract planning/spec outputs
9+
10+
## Canonical Tool Folders Selected
11+
- `tools/Sprite Editor V3/`
12+
- `tools/Tilemap Studio/`
13+
- `tools/Parallax Scene Studio/`
14+
- `tools/Vector Asset Studio/`
15+
- `tools/Vector Map Editor/`
16+
- `tools/shared/`
17+
18+
## Duplicate Folders Discovered
19+
- `tools/Sprite Editor/`
20+
- `tools/Tile Map Editor/`
21+
- `tools/Parallax Editor/`
22+
- `tools/SVG Background Editor/`
23+
- `tools/Pixel Asset Studio/`
24+
- `tools/SpriteEditorV3/`
25+
- `tools/VectorMapEditor/`
26+
27+
## Files And Folders Moved Or Merged
28+
### Sprite Tool
29+
- active isolated sprite editor finalized at `tools/Sprite Editor V3/`
30+
- retained `index.html`, `main.js`, `spriteEditor.css`, `README.md`, and `modules/`
31+
- removed duplicate `tools/Pixel Asset Studio/`
32+
- renamed compact `tools/SpriteEditorV3/` path to `tools/Sprite Editor V3/`
33+
34+
### Tilemap Tool
35+
- retained the canonical implementation in `tools/Tilemap Studio/`
36+
- kept `index.html`, `main.js`, `tileMapEditor.css`, `README.md`, and `samples/`
37+
38+
### Parallax Tool
39+
- retained the canonical implementation in `tools/Parallax Scene Studio/`
40+
- kept `index.html`, `main.js`, `parallaxEditor.css`, `README.md`, and `samples/`
41+
42+
### SVG And Vector Tooling
43+
- retained the canonical implementation in `tools/Vector Asset Studio/`
44+
- kept `index.html`, `main.js`, `svgBackgroundEditor.css`, `README.md`, and `samples/`
45+
- renamed `tools/VectorMapEditor/` to `tools/Vector Map Editor/`
46+
- kept `index.html`, `main.js`, `vectorMapEditor.css`, `README.md`, `how_to_use.html`, `assets/`, and `editor/`
47+
48+
## References Updated
49+
- `tools/index.html` now points to:
50+
- `tools/Sprite Editor V3/`
51+
- `tools/Tilemap Studio/`
52+
- `tools/Parallax Scene Studio/`
53+
- `tools/Vector Asset Studio/`
54+
- `tools/Vector Map Editor/`
55+
- active docs and report paths now use:
56+
- `tools/Sprite Editor V3/`
57+
- `tools/Vector Map Editor/`
58+
- vector-map help/example references were updated to the spaced canonical folder name
59+
- active loading-surface scans show no required refs to deprecated duplicate folders
60+
61+
## Obsolete Folders Removed
62+
- `tools/Sprite Editor/`
63+
- `tools/Tile Map Editor/`
64+
- `tools/Parallax Editor/`
65+
- `tools/SVG Background Editor/`
66+
- `tools/Pixel Asset Studio/`
67+
- `tools/SpriteEditorV3/`
68+
- `tools/VectorMapEditor/`
69+
70+
## Explicit Legacy Exclusion
71+
Old `tools/SpriteEditor_old_keep/` was intentionally excluded except for active reference cleanup.
72+
- no merge work was performed from the legacy folder
73+
- no compatibility work was added for the legacy folder
74+
- active platform paths were redirected to `tools/Sprite Editor V3/`
75+
76+
## Validation Summary
77+
- verified launcher/index links resolve through canonical tool folders
78+
- verified sprite, tilemap, parallax, vector asset studio, and vector map editor entry files exist
79+
- verified sample-manifest paths for:
80+
- `tools/Tilemap Studio/samples/sample-manifest.json`
81+
- `tools/Parallax Scene Studio/samples/sample-manifest.json`
82+
- `tools/Vector Asset Studio/samples/sample-manifest.json`
83+
- ran `node --check` on:
84+
- `tools/Sprite Editor V3/main.js`
85+
- `tools/Sprite Editor V3/modules/spriteEditorApp.js`
86+
- `tools/Sprite Editor V3/modules/projectModel.js`
87+
- `tools/Sprite Editor V3/modules/constants.js`
88+
- `tools/Tilemap Studio/main.js`
89+
- `tools/Parallax Scene Studio/main.js`
90+
- `tools/Vector Asset Studio/main.js`
91+
- `tools/Vector Map Editor/main.js`
92+
- `tools/Vector Map Editor/editor/VectorMapEditorApp.js`
93+
- confirmed no required refs remain to deprecated duplicate folders in `tools/`, `games/`, `tests/`, or `scripts/`
94+
- confirmed no required runtime refs remain to old `SpriteEditor` in `tools/`, `games/`, `tests/`, or `scripts/`
95+
96+
## Vector Asset Contract Outputs
97+
- planning/build workflow documented through the combined repo docs bundle
98+
- canonical spec produced at `docs/specs/vector_asset_contract.md`
99+
- contract output covers:
100+
- purpose and scope
101+
- canonical vector asset file role
102+
- coordinate system
103+
- origin conventions
104+
- transform expectations
105+
- stroke behavior
106+
- fill and color rules
107+
- palette strategy
108+
- supported shape primitives
109+
- layering expectations
110+
- naming conventions
111+
- runtime expectations
112+
- future geometry runtime support expectations
113+
- explicit non-goals

0 commit comments

Comments
 (0)