Skip to content

docs(templates): keep 3D smoke bridge read-only #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wh000wh000 merged 1 commit into from
Aug 4, 2026
Merged

docs(templates): keep 3D smoke bridge read-only #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions agent-test/docs/modules/threed_basic/template_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,19 @@ Required public methods:
| `isPaused()` | smoke/lifecycle observable pause state |
| `resize()` | update camera aspect and renderer size |

## Smoke bridge

`window.__opengame3d` is an exact, read-only probe surface:

```ts
{ isPaused: () => boolean; renderer: 'three.js' }
```

Do not add `teleport`, time setters, collectible setters, mutable `state`, or
other gameplay shortcuts. Build, pause, completion, failure, and restart must
be verified through keyboard/mouse events and the visible DOM. Test time limits
with browser clock control or a pure unit check, not a shipped runtime setter.

## SceneMap

`initSceneMap()` returns `playerSpawn`, `floorPatches`, `collectibles`, and `obstacles`.
Expand Down
6 changes: 5 additions & 1 deletion agent-test/docs/modules/threed_basic/threed_basic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ and the one level rather than replacing the shell.
| 2 | edit `SceneMap.ts` | main route and every pickup are reachable; obstacle collision radii leave a traversable lane |
| 3 | merge tuning into `gameConfig.json` | every leaf has one runtime consumer; superseded aliases are deleted |
| 4 | theme materials and DOM text | canvas remains WebGL-only; HUD remains DOM-only |
| 5 | run build and smoke | zero errors, non-black canvas, WebGL context, ESC resume |
| 5 | run build and smoke | zero errors, non-black canvas, WebGL context, ESC resume; smoke bridge remains read-only |

## Runtime lifecycle

Expand Down Expand Up @@ -49,6 +49,10 @@ playable; it does not authorize skipping the required asset call.

## Manual play check

Keep the scaffolded `window.__opengame3d` surface exact: `isPaused` and
`renderer` only. Never add teleport, time/state setters, or collectible cheats
to make this check pass.

1. Press Enter on the title screen.
2. Move with W/A/S/D or arrow keys; drag the mouse to look.
3. Press ESC, confirm the pause overlay, then ESC again and confirm movement.
Expand Down