|
| 1 | +# BUILD_PR_CODEX_AUTORUN_TOOLS_AND_VECTOR_CONTRACT |
| 2 | + |
| 3 | +## Purpose |
| 4 | +Execute the full sequence with **no manual intervention**: |
| 5 | + |
| 6 | +1. Consolidate renamed/duplicate tool folders under `tools/` |
| 7 | +2. Validate the repo after consolidation and repair any broken paths/imports/references caused by that consolidation |
| 8 | +3. Produce the docs-first planning bundle for `PLAN_PR_VECTOR_ASSET_CONTRACT` |
| 9 | + |
| 10 | +This PR bundle is intended for Codex execution only. The goal is to let Codex perform the implementation, validation, repair, and follow-on planning in one continuous pass. |
| 11 | + |
| 12 | +## Scope |
| 13 | +### In scope |
| 14 | +- Tool-folder consolidation under `tools/` |
| 15 | +- Canonical path selection for current tool folders |
| 16 | +- File movement/merging into canonical tool folders |
| 17 | +- Reference/path/import updates caused by consolidation |
| 18 | +- Validation of launcher/index/tool/sample/asset/vector paths |
| 19 | +- Repair of any broken paths caused by consolidation |
| 20 | +- Creation of a docs-only `PLAN_PR_VECTOR_ASSET_CONTRACT` bundle |
| 21 | +- Repo-structured ZIP outputs |
| 22 | + |
| 23 | +### Explicit exclusions |
| 24 | +- Legacy `old SpriteEditor` consolidation work |
| 25 | +- Unrelated engine refactors |
| 26 | +- Unrelated gameplay work |
| 27 | +- New feature work outside path repair required by consolidation |
| 28 | + |
| 29 | +## Required execution order |
| 30 | +### Phase 1 — Consolidate tools folders |
| 31 | +Codex must: |
| 32 | +- inventory folders directly under `tools/` |
| 33 | +- identify duplicate/renamed folders created by rename drift |
| 34 | +- choose the canonical current folder for each tool based on newer approved naming |
| 35 | +- merge/move files into canonical folders |
| 36 | +- update repo references to canonical locations |
| 37 | +- remove obsolete duplicate folders after validation |
| 38 | +- ignore old SpriteEditor except for active path cleanup if absolutely necessary to keep the repo working |
| 39 | + |
| 40 | +### Phase 2 — Validate and repair |
| 41 | +Codex must perform validation and fix issues without requiring manual follow-up. |
| 42 | + |
| 43 | +Validation must cover: |
| 44 | +- launcher/index links |
| 45 | +- Tile Map Editor |
| 46 | +- Parallax Editor |
| 47 | +- SVG Editor |
| 48 | +- sample loading |
| 49 | +- asset loading |
| 50 | +- vector/SVG loading if referenced |
| 51 | +- tile-map and parallax config/json path resolution |
| 52 | +- no remaining required references to deprecated duplicate folders |
| 53 | +- no remaining required references to old SpriteEditor |
| 54 | + |
| 55 | +If broken references are found, Codex must fix them in the same pass. |
| 56 | + |
| 57 | +### Phase 3 — Create docs-only vector asset contract plan |
| 58 | +After Phase 1 and Phase 2 are complete, Codex must create: |
| 59 | + |
| 60 | +- `docs/pr/PLAN_PR_VECTOR_ASSET_CONTRACT.md` |
| 61 | +- `docs/dev/codex_commands.md` (updated for the vector asset contract plan output) |
| 62 | +- `docs/dev/commit_comment.txt` |
| 63 | +- `docs/dev/reports/file_tree.txt` |
| 64 | +- `docs/dev/reports/change_summary.txt` |
| 65 | +- `docs/dev/reports/validation_checklist.txt` |
| 66 | + |
| 67 | +The vector asset contract plan must define the future planning/documentation needed to lock: |
| 68 | +- vector asset file contract |
| 69 | +- coordinate system |
| 70 | +- origin rules |
| 71 | +- scaling rules |
| 72 | +- stroke/fill rules |
| 73 | +- palette/color binding rules |
| 74 | +- layering/z-order rules |
| 75 | +- metadata/extensibility rules |
| 76 | +- tool/runtime ownership boundaries |
| 77 | +- validation examples |
| 78 | + |
| 79 | +## Deliverables for this combined Codex run |
| 80 | +### Build/consolidation docs |
| 81 | +- `docs/pr/BUILD_PR_TOOLS_FOLDER_CONSOLIDATION.md` |
| 82 | +- `docs/dev/reports/file_tree.txt` |
| 83 | +- `docs/dev/reports/change_summary.txt` |
| 84 | +- `docs/dev/reports/validation_checklist.txt` |
| 85 | + |
| 86 | +### Follow-on plan docs |
| 87 | +- `docs/pr/PLAN_PR_VECTOR_ASSET_CONTRACT.md` |
| 88 | +- refreshed `docs/dev/codex_commands.md` |
| 89 | +- refreshed `docs/dev/commit_comment.txt` |
| 90 | + |
| 91 | +## Success criteria |
| 92 | +- One canonical folder per active tool under `tools/` |
| 93 | +- Duplicate rename-created folders removed after consolidation |
| 94 | +- Old SpriteEditor ignored as legacy/out-of-scope except required path cleanup |
| 95 | +- Active tool paths work from canonical names |
| 96 | +- Samples/assets/configs load from canonical paths |
| 97 | +- No manual cleanup step remains |
| 98 | +- Vector asset contract planning bundle exists and is ready for the next Codex pass |
| 99 | + |
| 100 | +## Output ZIP requirement |
| 101 | +Codex should package outputs as repo-structured ZIPs at: |
| 102 | + |
| 103 | +- `<project folder>/tmp/BUILD_PR_TOOLS_FOLDER_CONSOLIDATION.zip` |
| 104 | +- `<project folder>/tmp/PLAN_PR_VECTOR_ASSET_CONTRACT.zip` |
| 105 | + |
| 106 | +## Notes |
| 107 | +This is a **no-manual** execution request. |
| 108 | +Codex should complete all three parts in sequence: |
| 109 | +1. build/consolidate |
| 110 | +2. validate/repair |
| 111 | +3. generate vector asset contract plan |
0 commit comments