Skip to content

Commit a653453

Browse files
author
DavidQ
committed
PLAN_PR_INTERACTIVE_DEV_CONSOLE_UI
- Planned interactive on-canvas dev console UI - Reused existing runtime and combo-key architecture - Scoped implementation to tools/dev plus one sample
1 parent 8e49224 commit a653453

7 files changed

Lines changed: 140 additions & 46 deletions

docs/dev/CODEX_COMMANDS.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,16 @@ MODEL: GPT-5.4-codex
77
REASONING: high
88

99
COMMAND:
10-
Apply the canvas debug HUD renderer implementation.
10+
Create BUILD_PR_INTERACTIVE_DEV_CONSOLE_UI as a docs-only, repo-structured delta.
1111

1212
Requirements:
13-
- Keep changes isolated to:
14-
- tools/dev/canvasDebugHudRenderer.js
15-
- tools/dev/devConsoleIntegration.js
16-
- one sample entry file only
17-
- Do not modify engine core
18-
- Draw HUD last on canvas
19-
- Preserve combo-key bindings exactly
20-
- Use canvas save()/restore()
21-
- Run node --check on touched JS files
22-
- Package result to:
23-
<project folder>/tmp/APPLY_PR_CANVAS_DEBUG_OVERLAY_RENDERER_delta.zip
24-
25-
Report back:
26-
- exact files changed
27-
- selected sample file
28-
- how HUD draw is invoked
29-
- validation results
13+
- Follow PLAN_PR -> BUILD_PR -> APPLY_PR
14+
- Docs-first only
15+
- No implementation code in this bundle
16+
- Plan a canvas-rendered interactive console UI
17+
- Reuse existing runtime and combo-key controls
18+
- Scope implementation to tools/dev and one sample entry only
19+
- Define input behavior, output history, validation steps, and rollback notes
20+
- Keep commit_comment.txt header-free
21+
- Package output to:
22+
<project folder>/tmp/BUILD_PR_INTERACTIVE_DEV_CONSOLE_UI_delta.zip

docs/dev/COMMIT_COMMENT.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
APPLY_PR_CANVAS_DEBUG_OVERLAY_RENDERER
1+
PLAN_PR_INTERACTIVE_DEV_CONSOLE_UI
22

3-
- Added on-canvas debug HUD renderer
4-
- Wired HUD draw into sample-level debug integration
5-
- Preserved combo-key controls and HUD-last draw order
3+
- Planned interactive on-canvas dev console UI
4+
- Reused existing runtime and combo-key architecture
5+
- Scoped implementation to tools/dev plus one sample

docs/dev/NEXT_COMMAND.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
PLAN_PR_SAMPLE_GAME_USING_FULL_PIPELINE
1+
BUILD_PR_INTERACTIVE_DEV_CONSOLE_UI

docs/dev/change_summary.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ David Quesenberry
44
change_summary.txt
55

66
Summary
7-
- Applied canvas HUD implementation path
8-
- Locked draw-order, combo keys, and sample-only integration
9-
- Preserved no-header rule for docs/dev/commit_comment.txt
7+
- Added PLAN PR for interactive dev console UI
8+
- Preserved sample-safe integration boundaries
9+
- Preserved docs-first workflow and commit_comment no-header exception

docs/dev/file_tree.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ David Quesenberry
33
04/05/2026
44
file_tree.txt
55

6-
docs/pr/APPLY_PR_CANVAS_DEBUG_OVERLAY_RENDERER.md
6+
docs/pr/PLAN_PR_INTERACTIVE_DEV_CONSOLE_UI.md
77
docs/dev/codex_commands.md
88
docs/dev/commit_comment.txt
99
docs/dev/change_summary.txt

docs/dev/validation_checklist.txt

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,18 @@ validation_checklist.txt
66
VALIDATION CHECKLIST
77

88
Workflow
9-
- APPLY_PR created
9+
- PLAN_PR created
1010
- One PR per purpose
11-
- commit_comment.txt has no header
11+
- No implementation code in bundle
1212

13-
Files
14-
- tools/dev/canvasDebugHudRenderer.js present
15-
- tools/dev/devConsoleIntegration.js updated
16-
- one sample entry updated
13+
Header Rules
14+
- Header present in all new files except docs/dev/commit_comment.txt
15+
- commit_comment.txt contains no Toolbox Aid header
1716

18-
Functional
19-
- Ctrl + Shift + ` toggles HUD visibility
20-
- HUD draws on canvas
21-
- HUD draws after gameplay content
22-
- Panel navigation works
23-
- Missing diagnostics do not crash draw path
24-
- Reload combo remains browser-safe
25-
26-
Safety
27-
- No engine core files modified
28-
- No F-key bindings remain
29-
- Canvas save/restore used
30-
- No duplicate listeners/runtime instances
17+
Plan Quality
18+
- Interactive console UI scope defined
19+
- Input behavior defined
20+
- Output history behavior defined
21+
- Sample-only integration boundary defined
22+
- Acceptance criteria defined
23+
- Validation steps defined
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
Toolbox Aid
2+
David Quesenberry
3+
04/05/2026
4+
PLAN_PR_INTERACTIVE_DEV_CONSOLE_UI.md
5+
6+
# PLAN PR
7+
Interactive Dev Console UI
8+
9+
## Objective
10+
Plan a sample-safe interactive on-screen developer console UI that builds on the existing dev console runtime,
11+
combo-key system, and canvas debug HUD so commands can be typed and executed directly inside the running sample.
12+
13+
## Scope
14+
- Add an interactive console UI layer above the existing runtime
15+
- Support text input, command submission, output history, and simple focus behavior
16+
- Reuse the current command execution pipeline
17+
- Keep implementation isolated to tools/dev and one sample integration target
18+
- Preserve engine core boundaries and current debug controls
19+
20+
## Non-Goals
21+
- No engine core rewrite
22+
- No DOM-only console dependency
23+
- No full editor framework
24+
- No autocomplete requirement in this PR
25+
- No multi-sample rollout
26+
27+
## Existing Foundation
28+
Already in place:
29+
- dev console runtime
30+
- combo-key debug controls
31+
- canvas HUD renderer
32+
- sample-level integration path
33+
34+
## Planned Behavior
35+
- Shift + ` toggles console UI visibility
36+
- Ctrl + Shift + ` toggles HUD visibility
37+
- Console accepts typed input while open
38+
- Enter submits a command
39+
- Escape closes the console UI
40+
- Up/Down browse recent command history
41+
- Output is rendered in a visible console region on-canvas
42+
- Existing runtime commands are reused, not reimplemented
43+
44+
## Candidate Files
45+
Expected future implementation focus:
46+
- tools/dev/interactiveDevConsoleRenderer.js
47+
- tools/dev/devConsoleIntegration.js
48+
- one sample entry file only
49+
- optional test file for input/history behavior
50+
51+
## UI Requirements
52+
- On-canvas console surface
53+
- Fixed anchor, default bottom-left or top-left
54+
- Separate input line from output history
55+
- Readable font and padding
56+
- Transparent/dim background
57+
- Safe clipping for long output
58+
- Max visible history window
59+
- Distinct prompt marker
60+
- Non-destructive when closed
61+
62+
## Input Requirements
63+
- Capture character input only while console is open
64+
- Do not interfere with sample controls while closed
65+
- Backspace edits current line
66+
- Enter executes command
67+
- Escape closes console
68+
- Up/Down cycle command history
69+
- Tab reserved for future autocomplete; no required behavior now
70+
71+
## Integration Rules
72+
- Reuse existing runtime executeConsoleInput()
73+
- Reuse current combo-key bindings already implemented
74+
- Do not spread input handling into engine core
75+
- Do not duplicate command registry
76+
- Keep console rendering after world render
77+
- Keep HUD and console rendering coordinated but separate
78+
79+
## Acceptance Criteria
80+
- Console opens and closes reliably
81+
- Typed characters appear on screen
82+
- Enter executes commands
83+
- Output history is visible
84+
- Up/Down history navigation works
85+
- Escape closes without crashing
86+
- Sample still runs normally
87+
- No F-key bindings reintroduced
88+
- No engine core file changes
89+
90+
## Validation
91+
- node --check on touched JS files
92+
- manual browser run
93+
- verify console typing
94+
- verify command execution for:
95+
- help
96+
- status
97+
- scene.info
98+
- verify invalid command output is shown safely
99+
- verify console input does not remain captured after close
100+
101+
## Risks
102+
- key handling collisions with gameplay input
103+
- text rendering overflow
104+
- duplicate listener setup
105+
- runtime/UI state drift
106+
107+
## Deliverable
108+
Create BUILD_PR_INTERACTIVE_DEV_CONSOLE_UI as a docs-only, repo-structured delta.

0 commit comments

Comments
 (0)