create-threenative 0.2.1 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +10 -2
- package/agent-docs/asset-mcp-loop.md +33 -0
- package/agent-docs/ctx-surface.md +69 -0
- package/agent-docs/engine-capabilities.md +4 -0
- package/agent-docs/framework-blocks-you.md +60 -0
- package/agent-docs/look-at-it-and-budget-the-look.md +27 -0
- package/agent-docs/performance-default.md +42 -0
- package/agent-docs/pixel-budget.md +20 -0
- package/agent-docs/playtest-fail-closed.md +23 -0
- package/agent-docs/references/assertion-reference.md +652 -0
- package/agent-docs/references/capability-reference.md +3279 -0
- package/agent-docs/references/capture-the-frame.md +53 -0
- package/agent-docs/references/ctx-cookbook.md +51 -0
- package/agent-docs/references/debug-surface.md +63 -0
- package/agent-docs/references/finding-assets.md +147 -0
- package/agent-docs/references/gameplay-recipes.md +54 -0
- package/agent-docs/references/menu-screens.md +69 -0
- package/agent-docs/references/mobile-memory-budget.md +87 -0
- package/agent-docs/references/sculpt-from-a-reference.md +39 -0
- package/agent-docs/references/visual-baseline.md +133 -0
- package/agent-docs/references/webview-ui.md +113 -0
- package/agent-docs/sculpt-loop.md +16 -0
- package/agent-files/.agents/skills/threenative-builder/SKILL.md +7 -0
- package/agent-files/.agents/skills/threenative-verifier/SKILL.md +7 -0
- package/agent-files/.claude/agents/threenative-builder.md +7 -0
- package/agent-files/.claude/agents/threenative-verifier.md +7 -0
- package/agent-files/.threenative/agents/builder.md +32 -0
- package/agent-files/.threenative/agents/verifier.md +31 -0
- package/agent-files/AGENT-ROLES.md +26 -0
- package/capabilities.json +3542 -0
- package/dist/index.d.ts +191 -3
- package/dist/index.js +1707 -73
- package/dist/threenative.d.ts +9 -2
- package/dist/threenative.js +1825 -148
- package/package.json +30 -6
- package/template-assets/loading.ts +315 -0
- package/template-assets/patches/three@0.185.1.patch +287 -0
- package/templates/action-rpg/.codex/config.toml +15 -0
- package/templates/action-rpg/.mcp.json +6 -2
- package/templates/action-rpg/AGENTS.md +370 -6
- package/templates/action-rpg/CLAUDE.md +370 -6
- package/templates/action-rpg/index.html +0 -1
- package/templates/action-rpg/package.json +15 -11
- package/templates/action-rpg/playtests/combat.playtest.json +23 -9
- package/templates/action-rpg/playtests/fail.playtest.json +3 -3
- package/templates/action-rpg/playtests/inventory.playtest.json +16 -10
- package/templates/action-rpg/playtests/performance.playtest.json +22 -0
- package/templates/action-rpg/playtests/progress.playtest.json +18 -13
- package/templates/action-rpg/playtests/win.playtest.json +10 -4
- package/templates/action-rpg/public/icon.png +0 -0
- package/templates/action-rpg/src/entities/Enemy.ts +14 -4
- package/templates/action-rpg/src/game.ts +21 -0
- package/templates/action-rpg/src/render/lighting.ts +6 -1
- package/templates/action-rpg/src/render/loading.ts +267 -42
- package/templates/action-rpg/src/render/postprocessing.ts +68 -15
- package/templates/action-rpg/src/render/worldEnvironment.ts +583 -0
- package/templates/action-rpg/src/scenes/Play.ts +49 -19
- package/templates/action-rpg/src/state.ts +4 -0
- package/templates/action-rpg/src/style.css +45 -1
- package/templates/action-rpg/src/ui/AbilityBar.tsx +9 -7
- package/templates/action-rpg/src/ui/App.tsx +9 -8
- package/templates/action-rpg/src/ui/CharacterPanel.tsx +10 -8
- package/templates/action-rpg/src/ui/GameUi.tsx +24 -0
- package/templates/action-rpg/src/ui/Hud.tsx +10 -8
- package/templates/action-rpg/src/ui/InventoryPanel.tsx +9 -7
- package/templates/action-rpg/src/ui/main.tsx +14 -0
- package/templates/action-rpg/threenative.config.ts +21 -8
- package/templates/action-rpg/vite.config.ts +32 -2
- package/templates/defense/.codex/config.toml +15 -0
- package/templates/defense/.mcp.json +6 -2
- package/templates/defense/AGENTS.md +371 -8
- package/templates/defense/CLAUDE.md +371 -8
- package/templates/defense/README.md +2 -1
- package/templates/defense/index.html +0 -1
- package/templates/defense/package.json +16 -12
- package/templates/defense/playtests/leak.playtest.json +9 -4
- package/templates/defense/playtests/performance.playtest.json +22 -0
- package/templates/defense/playtests/placement.playtest.json +5 -5
- package/templates/defense/playtests/pointer-placement.playtest.json +89 -0
- package/templates/defense/playtests/scan.playtest.json +3 -3
- package/templates/defense/playtests/survive.playtest.json +11 -6
- package/templates/defense/public/icon.png +0 -0
- package/templates/defense/src/attackers/Attacker.ts +28 -12
- package/templates/defense/src/game.ts +24 -2
- package/templates/defense/src/render/lighting.ts +6 -1
- package/templates/defense/src/render/loading.ts +263 -37
- package/templates/defense/src/render/postprocessing.ts +70 -13
- package/templates/defense/src/render/shapes.ts +38 -0
- package/templates/defense/src/render/worldEnvironment.ts +583 -0
- package/templates/defense/src/scenes/Defense.ts +109 -50
- package/templates/defense/src/state.ts +6 -0
- package/templates/defense/src/style.css +45 -1
- package/templates/defense/src/ui/App.tsx +9 -4
- package/templates/defense/src/ui/GameUi.tsx +20 -0
- package/templates/defense/src/ui/Hud.tsx +6 -5
- package/templates/defense/src/ui/main.tsx +14 -0
- package/templates/defense/threenative.config.ts +21 -8
- package/templates/defense/vite.config.ts +34 -1
- package/templates/minimal/.codex/config.toml +15 -0
- package/templates/minimal/.mcp.json +6 -2
- package/templates/minimal/AGENTS.md +360 -255
- package/templates/minimal/CLAUDE.md +360 -255
- package/templates/minimal/index.html +0 -1
- package/templates/minimal/package.json +14 -11
- package/templates/minimal/playtests/atmosphere.playtest.json +32 -0
- package/templates/minimal/playtests/play.playtest.json +17 -5
- package/templates/minimal/public/icon.png +0 -0
- package/templates/minimal/src/game.ts +1 -0
- package/templates/minimal/src/render/camera.ts +1 -1
- package/templates/minimal/src/render/hud.ts +24 -8
- package/templates/minimal/src/render/lighting.ts +23 -2
- package/templates/minimal/src/render/loading.ts +23 -103
- package/templates/minimal/src/render/postprocessing.ts +92 -14
- package/templates/minimal/src/render/sky.ts +37 -32
- package/templates/minimal/src/render/worldEnvironment.ts +583 -0
- package/templates/minimal/src/scenes/Play.ts +91 -13
- package/templates/minimal/src/state.ts +8 -1
- package/templates/minimal/threenative.config.ts +15 -10
- package/templates/minimal/vite.config.ts +28 -1
- package/templates/platformer/.codex/config.toml +15 -0
- package/templates/platformer/.mcp.json +6 -2
- package/templates/platformer/AGENTS.md +385 -130
- package/templates/platformer/CLAUDE.md +385 -130
- package/templates/platformer/index.html +0 -1
- package/templates/platformer/package.json +17 -14
- package/templates/platformer/playtests/avoidance.playtest.json +6 -1
- package/templates/platformer/playtests/branding.playtest.json +29 -0
- package/templates/platformer/playtests/buffer.playtest.json +1 -1
- package/templates/platformer/playtests/collect.playtest.json +1 -1
- package/templates/platformer/playtests/collision-layers.playtest.json +2 -2
- package/templates/platformer/playtests/coyote.playtest.json +42 -8
- package/templates/platformer/playtests/damage.playtest.json +4 -1
- package/templates/platformer/playtests/dash.playtest.json +2 -2
- package/templates/platformer/playtests/jump.playtest.json +2 -3
- package/templates/platformer/playtests/native/touch-controls.playtest.json +33 -0
- package/templates/platformer/playtests/oneway.playtest.json +1 -1
- package/templates/platformer/playtests/performance.playtest.json +6 -5
- package/templates/platformer/playtests/respawn.playtest.json +2 -2
- package/templates/platformer/playtests/stomp-rise.playtest.json +17 -3
- package/templates/platformer/playtests/stomp.playtest.json +11 -3
- package/templates/platformer/playtests/terminal-loop-fail.playtest.json +13 -4
- package/templates/platformer/playtests/terminal-loop-win.playtest.json +3 -3
- package/templates/platformer/playtests/touch-controls-web.playtest.json +46 -0
- package/templates/platformer/public/icon.png +0 -0
- package/templates/platformer/src/entities/Character.ts +16 -10
- package/templates/platformer/src/entities/Patrol.ts +5 -0
- package/templates/platformer/src/game.ts +24 -1
- package/templates/platformer/src/render/lighting.ts +6 -1
- package/templates/platformer/src/render/loading.ts +270 -61
- package/templates/platformer/src/render/postprocessing.ts +68 -15
- package/templates/platformer/src/render/touch-controls.ts +54 -36
- package/templates/platformer/src/render/worldEnvironment.ts +583 -0
- package/templates/platformer/src/scenes/Level.ts +47 -22
- package/templates/platformer/src/state.ts +4 -0
- package/templates/platformer/src/style.css +45 -1
- package/templates/platformer/src/ui/App.tsx +9 -4
- package/templates/platformer/src/ui/GameUi.tsx +20 -0
- package/templates/platformer/src/ui/Hud.tsx +6 -5
- package/templates/platformer/src/ui/main.tsx +14 -0
- package/templates/platformer/threenative.config.ts +20 -10
- package/templates/platformer/vite.config.ts +34 -1
- package/templates/racing/.codex/config.toml +15 -0
- package/templates/racing/.mcp.json +6 -2
- package/templates/racing/AGENTS.md +370 -6
- package/templates/racing/CLAUDE.md +370 -6
- package/templates/racing/index.html +0 -1
- package/templates/racing/package.json +16 -12
- package/templates/racing/playtests/boost.playtest.json +5 -5
- package/templates/racing/playtests/outcome.playtest.json +14 -4
- package/templates/racing/playtests/performance.playtest.json +22 -0
- package/templates/racing/playtests/ranking.playtest.json +2 -2
- package/templates/racing/playtests/rescue.playtest.json +12 -6
- package/templates/racing/playtests/reverse.playtest.json +3 -3
- package/templates/racing/playtests/shortcut.playtest.json +3 -3
- package/templates/racing/public/icon.png +0 -0
- package/templates/racing/src/game.ts +24 -1
- package/templates/racing/src/render/camera.ts +10 -6
- package/templates/racing/src/render/lighting.ts +6 -1
- package/templates/racing/src/render/loading.ts +291 -34
- package/templates/racing/src/render/postprocessing.ts +70 -13
- package/templates/racing/src/render/worldEnvironment.ts +583 -0
- package/templates/racing/src/scenes/Race.ts +68 -36
- package/templates/racing/src/state.ts +4 -0
- package/templates/racing/src/style.css +45 -1
- package/templates/racing/src/track/Lap.ts +20 -9
- package/templates/racing/src/track/Ranking.ts +53 -14
- package/templates/racing/src/track/Track.ts +29 -16
- package/templates/racing/src/track/TrackSector.ts +14 -4
- package/templates/racing/src/ui/App.tsx +9 -4
- package/templates/racing/src/ui/GameUi.tsx +20 -0
- package/templates/racing/src/ui/Hud.tsx +6 -5
- package/templates/racing/src/ui/main.tsx +14 -0
- package/templates/racing/threenative.config.ts +21 -8
- package/templates/racing/vite.config.ts +34 -1
- package/templates/sailing/.codex/config.toml +15 -0
- package/templates/sailing/.mcp.json +20 -0
- package/templates/sailing/AGENTS.md +388 -0
- package/templates/sailing/CLAUDE.md +390 -0
- package/templates/sailing/README.md +25 -0
- package/templates/sailing/index.html +12 -0
- package/templates/sailing/kit.json +7 -0
- package/templates/sailing/native-playtests/survives.playtest.json +21 -0
- package/templates/sailing/package.json +52 -0
- package/templates/sailing/playtests/fail.playtest.json +24 -0
- package/templates/sailing/playtests/performance.playtest.json +21 -0
- package/templates/sailing/playtests/survives.playtest.json +38 -0
- package/templates/sailing/playtests/win.playtest.json +31 -0
- package/templates/sailing/public/favicon.svg +5 -0
- package/templates/sailing/public/icon.png +0 -0
- package/templates/sailing/src/entities/Ship.ts +96 -0
- package/templates/sailing/src/game.ts +40 -0
- package/templates/sailing/src/main.ts +15 -0
- package/templates/sailing/src/render/camera.ts +21 -0
- package/templates/sailing/src/render/lighting.ts +36 -0
- package/templates/sailing/src/render/loading.ts +315 -0
- package/templates/sailing/src/render/materials.ts +28 -0
- package/templates/sailing/src/render/palette.ts +24 -0
- package/templates/sailing/src/render/postprocessing.ts +33 -0
- package/templates/sailing/src/render/props.ts +52 -0
- package/templates/sailing/src/render/sky.ts +32 -0
- package/templates/sailing/src/render/water-material.ts +14 -0
- package/templates/sailing/src/render/water-shaders.ts +12 -0
- package/templates/sailing/src/render/wave-nodes.ts +10 -0
- package/templates/sailing/src/render/worldEnvironment.ts +590 -0
- package/templates/sailing/src/scenes/Boot.ts +12 -0
- package/templates/sailing/src/scenes/Sailing.ts +106 -0
- package/templates/sailing/src/state.ts +10 -0
- package/templates/sailing/src/style.css +61 -0
- package/templates/sailing/src/ui/App.tsx +15 -0
- package/templates/sailing/src/ui/GameUi.tsx +12 -0
- package/templates/sailing/src/ui/Hud.tsx +55 -0
- package/templates/sailing/src/ui/Menu.tsx +30 -0
- package/templates/sailing/src/ui/main.tsx +7 -0
- package/templates/sailing/tailwind.config.ts +2 -0
- package/templates/sailing/threenative.config.ts +34 -0
- package/templates/sailing/tsconfig.json +17 -0
- package/templates/sailing/vite.config.ts +34 -0
- package/templates/shooter/.codex/config.toml +15 -0
- package/templates/shooter/.mcp.json +6 -2
- package/templates/shooter/AGENTS.md +373 -7
- package/templates/shooter/CLAUDE.md +373 -7
- package/templates/shooter/index.html +0 -1
- package/templates/shooter/package.json +16 -11
- package/templates/shooter/playtests/fail.playtest.json +5 -4
- package/templates/shooter/playtests/input-control.playtest.json +131 -0
- package/templates/shooter/playtests/per-item.playtest.json +59 -0
- package/templates/shooter/playtests/performance.playtest.json +22 -0
- package/templates/shooter/playtests/shooter.playtest.json +22 -18
- package/templates/shooter/playtests/survives.playtest.json +1 -1
- package/templates/shooter/public/favicon.svg +1 -1
- package/templates/shooter/public/icon.png +0 -0
- package/templates/shooter/src/game.ts +24 -1
- package/templates/shooter/src/main.ts +3 -13
- package/templates/shooter/src/render/camera.ts +62 -12
- package/templates/shooter/src/render/lighting.ts +6 -1
- package/templates/shooter/src/render/loading.ts +262 -33
- package/templates/shooter/src/render/palette.ts +1 -1
- package/templates/shooter/src/render/postprocessing.ts +68 -16
- package/templates/shooter/src/render/shapes.ts +178 -0
- package/templates/shooter/src/render/ui.css +34 -1
- package/templates/shooter/src/render/worldEnvironment.ts +583 -0
- package/templates/shooter/src/scenes/Play.ts +246 -73
- package/templates/shooter/src/state.ts +13 -0
- package/templates/shooter/src/style.css +26 -0
- package/templates/shooter/src/ui/App.tsx +10 -12
- package/templates/shooter/src/ui/GameUi.tsx +20 -0
- package/templates/shooter/src/ui/Hud.tsx +8 -10
- package/templates/shooter/src/ui/Menu.tsx +24 -9
- package/templates/shooter/src/ui/main.tsx +15 -0
- package/templates/shooter/src/weapons/Projectile.ts +21 -10
- package/templates/shooter/threenative.config.ts +21 -8
- package/templates/shooter/vite.config.ts +32 -2
- package/templates/starter/.codex/config.toml +15 -0
- package/templates/starter/.mcp.json +6 -2
- package/templates/starter/AGENTS.md +429 -326
- package/templates/starter/CLAUDE.md +429 -326
- package/templates/starter/assets/pickup.wav +0 -0
- package/templates/starter/gitignore +4 -0
- package/templates/starter/index.html +0 -1
- package/templates/starter/native-playtests/react-hud.playtest.json +20 -0
- package/templates/starter/native-playtests/render-chain.playtest.json +12 -0
- package/templates/starter/package.json +16 -12
- package/templates/starter/playtests/assets.playtest.json +65 -0
- package/templates/starter/playtests/buffer.playtest.json +59 -9
- package/templates/starter/playtests/cloth.playtest.json +113 -0
- package/templates/starter/playtests/coyote.playtest.json +60 -8
- package/templates/starter/playtests/forward.playtest.json +29 -4
- package/templates/starter/playtests/gameover.playtest.json +66 -0
- package/templates/starter/playtests/goal.playtest.json +67 -0
- package/templates/starter/playtests/hot-reload.playtest.json +48 -8
- package/templates/starter/playtests/look.playtest.json +34 -6
- package/templates/starter/playtests/models-baseline.png +0 -0
- package/templates/starter/playtests/models.playtest.json +74 -0
- package/templates/starter/playtests/monitoring.playtest.json +38 -7
- package/templates/starter/playtests/odometer.playtest.json +54 -0
- package/templates/starter/playtests/pause.playtest.json +27 -4
- package/templates/starter/playtests/play.playtest.json +43 -7
- package/templates/starter/playtests/respawn.playtest.json +46 -6
- package/templates/starter/playtests/restart.playtest.json +65 -10
- package/templates/starter/playtests/seed.playtest.json +44 -8
- package/templates/starter/playtests/survives.playtest.json +27 -4
- package/templates/starter/playtests/textures-baseline.png +0 -0
- package/templates/starter/playtests/textures.playtest.json +74 -0
- package/templates/starter/playtests/zoom-pinch.playtest.json +86 -0
- package/templates/starter/playtests/zoom-wheel.playtest.json +59 -0
- package/templates/starter/public/icon.png +0 -0
- package/templates/starter/src/entities/Goal.ts +122 -0
- package/templates/starter/src/entities/Player.ts +40 -2
- package/templates/starter/src/game.ts +25 -0
- package/templates/starter/src/render/camera.ts +31 -5
- package/templates/starter/src/render/easing.ts +5 -0
- package/templates/starter/src/render/effects/gradualBackground.ts +48 -0
- package/templates/starter/src/render/effects/lensDistortion.ts +43 -0
- package/templates/starter/src/render/effects/sparkle.ts +49 -0
- package/templates/starter/src/render/lighting.ts +6 -1
- package/templates/starter/src/render/loading.ts +315 -0
- package/templates/starter/src/render/materials.ts +17 -1
- package/templates/starter/src/render/pennant.ts +54 -0
- package/templates/starter/src/render/postprocessing.ts +46 -15
- package/templates/starter/src/render/scenery.ts +83 -0
- package/templates/starter/src/render/shapes.ts +9 -21
- package/templates/starter/src/render/worldEnvironment.ts +583 -0
- package/templates/starter/src/scenes/Play.ts +146 -36
- package/templates/starter/src/state.ts +12 -0
- package/templates/starter/src/style.css +45 -1
- package/templates/starter/src/ui/App.tsx +9 -6
- package/templates/starter/src/ui/GameUi.tsx +20 -0
- package/templates/starter/src/ui/Hud.tsx +52 -29
- package/templates/starter/src/ui/Menu.tsx +25 -23
- package/templates/starter/src/ui/main.tsx +14 -0
- package/templates/starter/threenative.config.ts +27 -9
- package/templates/starter/tools/look.mjs +109 -0
- package/templates/starter/vite.config.ts +32 -2
- package/templates/minimal/assets/.gitkeep +0 -0
- package/templates/minimal/public/.gitkeep +0 -0
- package/templates/platformer/assets/.gitkeep +0 -0
- package/templates/platformer/public/.gitkeep +0 -0
- package/templates/starter/assets/.gitkeep +0 -0
- package/templates/starter/public/.gitkeep +0 -0
- package/templates/starter/public/pickup.ogg +0 -0
- /package/templates/starter/{public → assets}/native-proof.glb +0 -0
- /package/templates/starter/{public → assets}/native-proof.png +0 -0
|
@@ -2,10 +2,82 @@
|
|
|
2
2
|
|
|
3
3
|
# AGENTS.md — __PROJECT_NAME__ platformer
|
|
4
4
|
|
|
5
|
+
## Native React layout — complete subset
|
|
6
|
+
|
|
7
|
+
Use `View` and `Text` from `@threenative/core/react`; `react-dom` stays web-only. Units are pixels;
|
|
8
|
+
children are absolute unless `direction` is `row` or `column`. The complete keys are `left`,
|
|
9
|
+
`right`, `top`, `bottom`, `centerX`, `centerY`, `width`, `height`, `padding`, `direction`, `gap`,
|
|
10
|
+
`align`, `background`, `color`, `opacity`, `fontSize`, `letterSpacing`, `textAlign`, and `zIndex`.
|
|
11
|
+
Unknown keys/glyphs throw. CSS, Tailwind, flex grow/wrap, borders, radius, transforms, images, SVG,
|
|
12
|
+
and events do not exist natively. Share components/state; keep appearance in `src/ui/` adapters.
|
|
13
|
+
|
|
5
14
|
This project is an editable Three.js platformer starter. The framework owns the loop,
|
|
6
15
|
input, renderer, physics bindings, and playtest bridge; this repository owns the feel,
|
|
7
16
|
level, entities, and look.
|
|
8
17
|
|
|
18
|
+
<!-- shared: framework-blocks-you -->
|
|
19
|
+
### Before you write a system, ask what already exists
|
|
20
|
+
|
|
21
|
+
You have `engine_search_capabilities`. Discovery is required before planning:
|
|
22
|
+
|
|
23
|
+
1. Infer concrete mechanics from the request: world, traversal, interaction, simulation, combat,
|
|
24
|
+
camera, audio, and UI. Preserve its distinctive fantasy with the smallest loop using its
|
|
25
|
+
characteristic setting or traversal—not a generic game with themed props. Search implied
|
|
26
|
+
mechanics even when the user omits engine terms. Ask one short question only when two core loops
|
|
27
|
+
remain equally plausible.
|
|
28
|
+
2. Search the full mechanical request with `scope: "request"`, then every mechanic with
|
|
29
|
+
`scope: "mechanic"`. Check each returned `matchedSituation`.
|
|
30
|
+
3. Before writing replacements, record a capability or no-match for every mechanic.
|
|
31
|
+
|
|
32
|
+
Repeat before writing entity, movement, navigation, attachment, audio, particle, simulation,
|
|
33
|
+
terrain, or measurement systems. Describe situations plainly: *"enemy walks around a wall"*.
|
|
34
|
+
|
|
35
|
+
The manifest is the complete public surface; grep misses unused subpath exports such as
|
|
36
|
+
`@threenative/physics/navigation`. If MCP is unavailable, run doctor and search
|
|
37
|
+
`agent-docs/capability-reference.md` per mechanic.
|
|
38
|
+
|
|
39
|
+
Constraints are binding. Import navigation symbols from the returned subpath. Use `attachToBone`
|
|
40
|
+
for held weapons; if needed, add a portable Three.js `Bone` named `RightHand` first. Capability
|
|
41
|
+
detail governs platform support: never invent limits it does not report. Reject only for a reported
|
|
42
|
+
constraint or a contract that does not fit.
|
|
43
|
+
|
|
44
|
+
This prevents reimplementing installed systems; one game did so in 446 lines and ran at 9 FPS.
|
|
45
|
+
|
|
46
|
+
## When the framework blocks you, write plain Three.js
|
|
47
|
+
|
|
48
|
+
For browser, blank-frame, device, or import failures, first run `npx threenative doctor` and
|
|
49
|
+
`npx @threenative/playtest doctor`. They separate project/machine failures from engine bugs. For a
|
|
50
|
+
running game that looks wrong, inspect it:
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
npx @threenative/playtest doctor --url http://127.0.0.1:5173 --text
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
This reports visibility, scale, draw cost, frame rate, advancing state, and errors. Missing output
|
|
57
|
+
means unobserved, never zero.
|
|
58
|
+
|
|
59
|
+
When an `@threenative/*` API is broken, missing, or does not do what you need, implement only that
|
|
60
|
+
piece with portable Three.js/plain code and continue:
|
|
61
|
+
|
|
62
|
+
1. Keep the existing loop, scenes, input, registry, and playtest bridge.
|
|
63
|
+
2. Avoid `document`, `window`, `localStorage`, dynamic `import()`, and raw physics handles.
|
|
64
|
+
3. **Report what blocked you**: API, expectation, result, and replacement.
|
|
65
|
+
|
|
66
|
+
Never stall on a framework bug.
|
|
67
|
+
|
|
68
|
+
### Where the long recipes live
|
|
69
|
+
|
|
70
|
+
Open the relevant shipped recipe when needed:
|
|
71
|
+
|
|
72
|
+
- `agent-docs/finding-assets.md` — asset search, licenses, downloads, and archives.
|
|
73
|
+
- `agent-docs/sculpt-from-a-reference.md` — sculpt gates and branches.
|
|
74
|
+
- `agent-docs/webview-ui.md` — UI state, intents, and hit regions.
|
|
75
|
+
- `agent-docs/capture-the-frame.md` — WebGPU screenshots.
|
|
76
|
+
- `agent-docs/ctx-cookbook.md` — raycasts, rebuilds, and seeded randomness.
|
|
77
|
+
- `agent-docs/gameplay-recipes.md` — movement, gamepads, and physics timing.
|
|
78
|
+
- `agent-docs/visual-baseline.md` — generated render-source conventions.
|
|
79
|
+
<!-- /shared -->
|
|
80
|
+
|
|
9
81
|
## Commands
|
|
10
82
|
|
|
11
83
|
```sh
|
|
@@ -40,162 +112,345 @@ Godot-named nodes keeps that correct without thinking about it.
|
|
|
40
112
|
- `src/render/` is ordinary Three.js source. It has no framework imports. Its baseline
|
|
41
113
|
concerns include palette, camera, sky, lighting, materials, postprocessing, and the
|
|
42
114
|
camera-parented geometry HUD in `hud.ts`.
|
|
115
|
+
|
|
116
|
+
`postprocessing.ts` builds a `WorldEnvironment`: which stages run, in what order, and an honest
|
|
117
|
+
report of what ran. It decides no colour and no strength — those are arguments in that file,
|
|
118
|
+
yours. `TN_WORLD_ENVIRONMENT` names every stage applied or refused **with a reason**, and an
|
|
119
|
+
unknown quality tier throws rather than becoming the default. SSGI and SSR ship desktop-on,
|
|
120
|
+
mobile-off; their cost and the one-line enable for godrays, contact AO and vignette are in
|
|
121
|
+
`agent-docs/visual-baseline.md`.
|
|
43
122
|
- `src/scenes/Level.ts` is the live caller that wires the pieces together.
|
|
44
123
|
- `playtests/survives.playtest.json` is the durable smoke proof: keep it when replacing the
|
|
45
|
-
platformer gameplay. The other `playtests/` scenarios prove movement, collection,
|
|
46
|
-
respawn, and one-way platforms in this example game.
|
|
124
|
+
platformer gameplay. The other root `playtests/` scenarios prove movement, collection,
|
|
125
|
+
stomping, respawn, and one-way platforms in this example game. The native-only
|
|
126
|
+
`playtests/native/touch-controls.playtest.json` is run explicitly with `--target android` or
|
|
127
|
+
`--target ios`; it is intentionally outside the browser test glob.
|
|
128
|
+
|
|
129
|
+
<!-- shared: playtest-fail-closed -->
|
|
130
|
+
## Playtests fail closed
|
|
131
|
+
|
|
132
|
+
A scenario fails closed: a missing entity, an absent observation, or a scenario with no
|
|
133
|
+
assertions is a failure, never a quiet pass. When you add a feature, add the assertion that
|
|
134
|
+
would catch its absence, and run the scenario before reporting the feature works.
|
|
135
|
+
|
|
136
|
+
Every `allowTrivial` waiver must be a reason string with at least 20 non-whitespace characters
|
|
137
|
+
explaining why the initial value is intentionally held; `allowTrivial: true` is invalid. A
|
|
138
|
+
scenario whose every triviality-eligible assertion is waived fails with
|
|
139
|
+
`TN_PLAYTEST_SCENARIO_ASSERTS_NOTHING`, so keep an independent assertion in the scenario.
|
|
140
|
+
|
|
141
|
+
Steps count fixed-step ticks, not milliseconds — use `holdTicks` and `waitTicks`. The deprecated
|
|
142
|
+
`holdFrames` and `waitFrames` aliases remain accepted for compatibility and are treated as ticks
|
|
143
|
+
on a fixed-step bridge; `warmupFrames` remains a genuine requestAnimationFrame warmup.
|
|
144
|
+
|
|
145
|
+
The assertion vocabulary — every kind the validator accepts, its fields, and when to reach for
|
|
146
|
+
it — is generated into `agent-docs/assertion-reference.md`; open it before inventing a new
|
|
147
|
+
assertion shape. To probe a running game by hand, every bridge global and its shape is
|
|
148
|
+
documented in `agent-docs/debug-surface.md`.
|
|
149
|
+
|
|
150
|
+
The bridge registers exactly one resource id for the JSON-safe game state: `state`; resource
|
|
151
|
+
paths address fields from `ctx.state`. (`GameState` is a deprecated compatibility alias kept
|
|
152
|
+
until published scenarios migrate.)
|
|
153
|
+
<!-- /shared -->
|
|
47
154
|
|
|
48
155
|
**This template has one HUD, and it is `src/ui/Hud.tsx`.** It previously shipped a
|
|
49
156
|
camera-attached geometry HUD as well, and both drew hearts, coins and the clock on top of each
|
|
50
157
|
other. Gameplay and state transitions live in the portable scene and reach the HUD through
|
|
51
|
-
`ctx.state.set
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
`.glb` in `public/`, await `ctx.assets.model("hero.glb")` in `Scene.load()`, then construct
|
|
158
|
+
`ctx.state.set`. **This template claims desktop, and a desktop build has no HUD until you add
|
|
159
|
+
one** — write it in your own `src/render/` code, as instanced Three.js geometry rather than
|
|
160
|
+
DOM, if your game needs one there; that gap is stated rather than hidden.
|
|
161
|
+
`src/render/touch-controls.ts` draws the thumbstick, jump and dash surfaces, keeping the
|
|
162
|
+
platformer playable without a keyboard on a touch target.
|
|
163
|
+
|
|
164
|
+
`threenative.config.ts` is the one game-owned app-shape file: launcher identity and icon,
|
|
165
|
+
mobile orientation and display flags, desktop window, renderer preference, native entry.
|
|
166
|
+
`package.json` may retain only `threenative.nativeEntry` as a compatibility fallback.
|
|
167
|
+
|
|
168
|
+
`AnimationPlayer` is exported by `@threenative/core` for clips from a rigged asset. Drop a
|
|
169
|
+
rigged `.glb` in `assets/` — sources there are compiled into `public/` and resolved through
|
|
170
|
+
the asset manifest — await `ctx.assets.model("hero.glb")` in `Scene.load()`, then construct
|
|
65
171
|
and update the player beside the entity that owns the loaded model.
|
|
66
172
|
|
|
67
173
|
Use Godot names for physics nodes: `CharacterBody3D`, `Area3D`, `RigidBody3D`, and
|
|
68
174
|
`CollisionShape3D`. Register persistent entities with `ctx.entities`; the framework clears
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
string — an unregistered player fails `TN_PLAYTEST_VISIBILITY_FAILED` however visible it is on
|
|
73
|
-
screen. Feel belongs in the character, not in `defineGame` options.
|
|
175
|
+
them when a scene exits. **The id is the name a scenario resolves** — an unregistered player
|
|
176
|
+
fails `TN_PLAYTEST_VISIBILITY_FAILED` however visible it is on screen. Feel belongs in the
|
|
177
|
+
character, not in `defineGame` options.
|
|
74
178
|
|
|
75
179
|
`input.vector("move").y` is +up; map it to world-space -z for forward with one explicit
|
|
76
180
|
`-move.y` conversion in the character movement code.
|
|
77
181
|
|
|
78
|
-
`Level.static initialState` is the single initial-state value
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
182
|
+
`Level.static initialState` is the single initial-state value; gameplay updates use partial
|
|
183
|
+
patches such as `ctx.state.set({ coins })`. `acceptHotUpdate` carries JSON-shaped store state
|
|
184
|
+
only — seed the player in `Level.enter()` from fields you want to preserve.
|
|
185
|
+
|
|
186
|
+
The state bridge flushes every 100 ms by default: keep values a human reads — coins, hearts,
|
|
187
|
+
terminal state — in `ctx.state`, and per-frame feedback in scene-owned Three.js objects. The
|
|
188
|
+
deferred `moveAndSlide(dt)` step-timing rule and save/load snippets are in
|
|
189
|
+
`agent-docs/gameplay-recipes.md`.
|
|
83
190
|
|
|
84
191
|
Keep the palette to six named colours with exactly one `accent`, and import it from materials
|
|
85
192
|
and sky. Set camera framing, tonemapping and exposure deliberately; keep the rim light,
|
|
86
193
|
soft shadows with `normalBias`, sky-derived fog, and bloom through
|
|
87
|
-
`renderer.
|
|
88
|
-
the framework packages
|
|
194
|
+
`renderer.createRenderChain()`. These visual decisions belong in this generated project, not in
|
|
195
|
+
the framework packages; the per-file baseline is `agent-docs/visual-baseline.md`. Run
|
|
196
|
+
`pnpm visuals` when changing the render layer.
|
|
89
197
|
|
|
90
|
-
##
|
|
198
|
+
## Off-screen diffuse light
|
|
91
199
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
would hand-author.
|
|
97
|
-
- **Models — only when the thing is conventional.** A car, a plane, a crate, a barrel, a
|
|
98
|
-
tree, a chair. If this game's main character is a car, fetching a compatible `.glb` is the
|
|
99
|
-
right call.
|
|
100
|
-
- **Anything specific to this game — write it in `src/render/`.** A downloaded model standing
|
|
101
|
-
in for a bespoke design reads as a weird asset dropped into the scene, and it looks worse
|
|
102
|
-
than a clean composition of primitives. This is the failure the tools make easy.
|
|
103
|
-
|
|
104
|
-
When in doubt, build it programmatically. A fetched asset has to match what the game needs,
|
|
105
|
-
not merely exist.
|
|
106
|
-
|
|
107
|
-
`.mcp.json` in this project launches `threenative-asset-mcp` from `node_modules`, so your host
|
|
108
|
-
lists its tools alongside your own. It advertises 32; these 8 are the loop you will use for
|
|
109
|
-
nearly everything:
|
|
110
|
-
|
|
111
|
-
1. `asset_search_sources` — start here, never at a provider. It returns every catalogued
|
|
112
|
-
source with its license summary, attribution requirement, browse URL, and whether an agent
|
|
113
|
-
can complete a download from it. **That output is the authority on what is reachable** —
|
|
114
|
-
not this file, and not your memory of some other project.
|
|
115
|
-
2. `polyhaven_search_assets` (CC0 models, textures, HDRIs), `ambientcg_search_assets` (CC0
|
|
116
|
-
materials and textures), or `audio_search_assets` (Kenney, Sonniss).
|
|
117
|
-
3. `polyhaven_list_files` / `ambientcg_list_files` — the license, official URL, byte size and
|
|
118
|
-
md5 of every resolution and format. **Read this before downloading, not after**, and pick a
|
|
119
|
-
sane one: Poly Haven lists 16k PNGs over 1 GB beside 8k JPEGs at 28 MB. A game does not
|
|
120
|
-
need the 16k.
|
|
121
|
-
4. `asset_download_file` for textures and models, `audio_download_asset` for audio. Both take
|
|
122
|
-
`acceptLicense: true` — you are asserting you read step 3. **They ignore any path you pass
|
|
123
|
-
and write to the directories `.mcp.json` sets** (`public/assets/<provider>/<sha>/` and
|
|
124
|
-
`public/audio/<source>/<pack>/`); without that config they would write to `~/Downloads` and
|
|
125
|
-
never reach the game.
|
|
126
|
-
5. Append the file, its source, its license and its URL to `CREDITS.md` **before the turn
|
|
127
|
-
ends**. Poly Haven requires a visible Poly Haven credit when its API is used, ambientCG is
|
|
128
|
-
CC0 per asset page, and audio and bundle licenses are per pack.
|
|
129
|
-
|
|
130
|
-
**Never state a license you did not read off a tool result.** If `polyhaven_list_files` or
|
|
131
|
-
`ambientcg_search_assets` did not tell you, you do not know it.
|
|
132
|
-
|
|
133
|
-
**What arrives is usually a ZIP, not a texture.** ambientCG and Kenney ship archives: unpack
|
|
134
|
-
one, keep only the maps you actually use (`_Color`, `_NormalGL`, `_Roughness` — not the
|
|
135
|
-
`.blend`, `.usdc` or displacement), and put those beside your code under `public/`. A 1K JPEG
|
|
136
|
-
set is right for a game; the 8K set of the same material is 200 MB.
|
|
137
|
-
|
|
138
|
-
Two argument shapes that will bite you, both learned the hard way: `ambientcg_search_assets`
|
|
139
|
-
takes lowercase `type` values (`material`, `hdri`, `3d-model`), and the audio catalog is
|
|
140
|
-
**pack-level** — `audio_search_assets` matches pack names, so `query: "pickup coin"` returns
|
|
141
|
-
nothing while `kind: "sfx"` returns the seven packs that exist. Pick a pack, download it,
|
|
142
|
-
unzip it, and choose a file yourself.
|
|
143
|
-
|
|
144
|
-
The other tools are narrower, and the directory spells out the conditions on each. The Fab
|
|
145
|
-
tools talk to a marketplace: the server never purchases anything, and only directly-free files
|
|
146
|
-
download. `smithsonian_search_assets` returns museum scans at scan resolution, which this
|
|
147
|
-
project has no pipeline to decimate — that geometry is the wrong shape for a game. When in
|
|
148
|
-
doubt check `asset_search_sources` first; its `caution` and license fields are the current
|
|
149
|
-
truth for the pinned version, and they change between versions.
|
|
150
|
-
|
|
151
|
-
Load what you downloaded the ordinary way — `ctx.assets.model("crate.glb")`,
|
|
152
|
-
`ctx.assets.texture(...)`, `ctx.assets.audio(...)` — and write your own material and lighting
|
|
153
|
-
around it in `src/render/`. The framework ships no asset and picks none for you.
|
|
200
|
+
For light bouncing from a room I cannot see, construct `ProbeVolume` from `@threenative/core`
|
|
201
|
+
after the static geometry and lights exist. Add it with `ctx.add()`, request its bake on demand,
|
|
202
|
+
and pass `volume.sampleNode(positionWorld, normalWorld)` into a game-owned Three.js material
|
|
203
|
+
before the screen-space GI stage. The volume owns no light, material, colour, or falloff.
|
|
154
204
|
|
|
205
|
+
This is static-lighting-first, not fully dynamic GI: moving lights and relighting require another
|
|
206
|
+
explicit bake. `TN_PROBE_VOLUME` reports the unbaked/stale state, probe count, atlas bytes,
|
|
207
|
+
progress, and last render-phase bake cost; keep those measurements visible while tuning bounds,
|
|
208
|
+
density, and `bakeBudgetMs`.
|
|
209
|
+
|
|
210
|
+
<!-- shared: asset-mcp-loop -->
|
|
211
|
+
## Finding assets — you have an MCP server for this
|
|
212
|
+
|
|
213
|
+
**Reach for it when the asset is conventional; build anything custom yourself.** Textures,
|
|
214
|
+
materials, HDRIs, sound effects, and conventional models (a car, a crate, a tree) come from the
|
|
215
|
+
tools; anything specific to this game is written in `src/render/` — a downloaded model standing
|
|
216
|
+
in for a bespoke design reads as a weird asset dropped into the scene. When in doubt, build it
|
|
217
|
+
programmatically.
|
|
218
|
+
|
|
219
|
+
Installing `@threenative/core` writes the `.mcp.json` that launches `threenative-asset-mcp`, so
|
|
220
|
+
your host lists its tools alongside your own. Your host reads that file from the directory it was
|
|
221
|
+
launched in: start the session in this project, not in a parent of it. The loop:
|
|
222
|
+
|
|
223
|
+
1. `asset_search_sources` first, never a provider — its output is the authority on what is
|
|
224
|
+
reachable.
|
|
225
|
+
2. `polyhaven_search_assets`, `ambientcg_search_assets`, or `audio_search_assets` to find
|
|
226
|
+
candidates.
|
|
227
|
+
3. `polyhaven_list_files` / `ambientcg_list_files` **before downloading** — read licenses and
|
|
228
|
+
pick a sane resolution there (a game does not need the 16k).
|
|
229
|
+
4. `asset_download_file` / `audio_download_asset` with `acceptLicense: true`; they write where
|
|
230
|
+
`.mcp.json` points, never where you pass a path.
|
|
231
|
+
5. Append file, source, license and URL to `CREDITS.md` before the turn ends.
|
|
232
|
+
|
|
233
|
+
**Never state a license you did not read off a tool result.**
|
|
234
|
+
|
|
235
|
+
**Fab is two steps.** `fab_search_assets` finds a free listing, and `fab_list_owned` says what the
|
|
236
|
+
account already paid for — a free search never shows those. Then `fab_import_asset` converts it: it checks the
|
|
237
|
+
entitlement, downloads through the FabCLI session you established yourself, turns every static
|
|
238
|
+
mesh into a textured `.glb` under `assets/`, and returns the paths. It refuses anything but Fab
|
|
239
|
+
Standard or CC-BY, and it never logs in, claims, or buys. Most Fab listings are Unreal-only, so
|
|
240
|
+
without it a listing is a dead end. Full argument shapes: `agent-docs/finding-assets.md`.
|
|
241
|
+
|
|
242
|
+
The full loop — ZIP unpacking rules, the two argument shapes that bite, and the narrower
|
|
243
|
+
marketplace tools — is `agent-docs/finding-assets.md`.
|
|
244
|
+
<!-- /shared -->
|
|
245
|
+
|
|
246
|
+
<!-- shared: sculpt-loop -->
|
|
155
247
|
## Building what you cannot download — sculpt from a reference
|
|
156
248
|
|
|
157
|
-
Choose one branch before writing code:
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
be generic. Do not invent a reference: comparison without evidence is unguided iteration.
|
|
168
|
-
|
|
169
|
-
For a full environment, split the decision: sculpt the signature landmark or bounded scene
|
|
170
|
-
kit that makes the reference recognisable; use the asset tools for interchangeable trees,
|
|
171
|
-
rocks, textures, HDRIs, and sounds around it. Do not sculpt an entire world as one object.
|
|
172
|
-
|
|
173
|
-
`.mcp.json` launches `threenative-sculpt-mcp` beside the asset server. It does not generate
|
|
174
|
-
or ship runtime code; it guides the source you write:
|
|
175
|
-
|
|
176
|
-
1. Call `sculpt_plan` with the image path and a one-line intent, then read the returned
|
|
177
|
-
grimoire resources.
|
|
178
|
-
2. Write the returned object contract and loop on `sculpt_spec_gate` until every named
|
|
179
|
-
region and depth requirement passes. Do not write geometry before this gate is green.
|
|
180
|
-
3. For each ordered pass, write or extend one factory in `src/render/`. Capture the real
|
|
181
|
-
frame with `npx @threenative/playtest`; the sculpt server never launches a browser.
|
|
182
|
-
4. Call `sculpt_compare` with the reference and captured frame, then give that evidence to
|
|
183
|
-
`sculpt_pass_gate`. Advance only when it says advance; ambiguity means retry.
|
|
184
|
-
5. Use `sculpt_grimoire` for a named technique topic. It rejects pages containing concrete
|
|
185
|
-
paste-ready material or shader recipes so the tool never owns this game's look.
|
|
249
|
+
Choose one branch before writing code: conventional and downloadable — use the asset tools;
|
|
250
|
+
trivial (a platform, a wall) — write it, `BoxGeometry` under 20 lines is the answer; bespoke
|
|
251
|
+
with a reference image — the sculpt tools below; bespoke without one — ask for it, never
|
|
252
|
+
invent a reference.
|
|
253
|
+
|
|
254
|
+
`.mcp.json` launches `threenative-sculpt-mcp`; it does not ship runtime code, it guides the
|
|
255
|
+
source you write: plan with `sculpt_plan`, loop on `sculpt_spec_gate` until every named region
|
|
256
|
+
passes **before writing geometry**, write one factory per pass in `src/render/`, prove each
|
|
257
|
+
pass with `sculpt_compare` plus `sculpt_pass_gate` against a real captured frame (the sculpt
|
|
258
|
+
server never launches a browser), and pull technique topics from `sculpt_grimoire`.
|
|
186
259
|
|
|
187
260
|
A missing or blank capture is a failed run, never a finished model. Add the reference image,
|
|
188
|
-
its creator, license, and source URL to `CREDITS.md` before the turn ends.
|
|
261
|
+
its creator, license, and source URL to `CREDITS.md` before the turn ends. The branch
|
|
262
|
+
definitions and environment-splitting guidance are `agent-docs/sculpt-from-a-reference.md`.
|
|
263
|
+
<!-- /shared -->
|
|
264
|
+
|
|
189
265
|
|
|
266
|
+
## Engine capabilities — look it up before writing a replacement
|
|
190
267
|
|
|
268
|
+
<!-- shared: engine-capabilities -->
|
|
269
|
+
Use `engine_search_capabilities("pool decals on surfaces")`; plain situations and complete game
|
|
270
|
+
requests both work. If the MCP server is unavailable after `npx threenative doctor`, use the
|
|
271
|
+
generated `agent-docs/capability-reference.md` and repeat the same full-request plus per-mechanic
|
|
272
|
+
search pass manually. Grepping existing imports is never capability discovery.
|
|
273
|
+
<!-- /shared -->
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
`@threenative/physics/navigation` carries WASM and is browser-only under the current native
|
|
277
|
+
portability rule; do not import it in a portable game. For browser-only games, navigation agents
|
|
278
|
+
calculate a path but never move your object: write the steering velocity and call
|
|
279
|
+
`CharacterBody3D.moveAndSlide()`. A `NavigationRegion3D` is static and must be baked from the
|
|
280
|
+
world geometry; changing geometry needs an explicit re-bake. `GroundSnap` keeps `clearance`
|
|
281
|
+
truthful when `enabled = false`, `normaliseToMetres` measures a skinned crown for height, and
|
|
282
|
+
`prewarm` keeps transient meshes renderable with zero opacity so the first-use frame is not a stall.
|
|
283
|
+
`AnimationPlayer` matches a travelling clip's rate to the ground covered, so feet never skate;
|
|
284
|
+
`strideRoot` names the moved body and `strideSync: false` overrides while `stride` still reports.
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<!-- shared: look-at-it-and-budget-the-look -->
|
|
191
289
|
## Budget real time for the look
|
|
192
290
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
a
|
|
291
|
+
Read this as an instruction about **where your effort goes**, not as a style tip.
|
|
292
|
+
|
|
293
|
+
Every automated gate in this project — `typecheck`, `lint`, `pnpm test`, every playtest
|
|
294
|
+
scenario — is blind to how the game looks. All of them pass on a game that is grey boxes on
|
|
295
|
+
a black screen. So: **a feature is not done when its assertion passes. It is done when you
|
|
296
|
+
have looked at it and it reads well.** Plan for roughly as much work on presentation as on
|
|
297
|
+
mechanics; it is the majority of what a player experiences and the part nothing else catches.
|
|
298
|
+
|
|
299
|
+
Before calling anything a player sees done: look at it (a screenshot you actually open, not
|
|
300
|
+
your own diff); break up silhouettes; give it depth with contact shadows and rim; make it move;
|
|
301
|
+
finish the HUD.
|
|
302
|
+
|
|
303
|
+
Get eyes on it in rough order of preference: browser automation against the user's real Chrome — Claude in Chrome or an equivalent MCP browser tool, which runs on a real GPU; then
|
|
304
|
+
`npx @threenative/playtest <scenario> --browser-recipe webgpu --headed` (the recipe carries the
|
|
305
|
+
Chromium flags WebGPU needs including `--enable-features=Vulkan`; without it Chromium serves
|
|
306
|
+
SwiftShader and the runner fails the run with `TN_PLAYTEST_SOFTWARE_ADAPTER`); then ask the
|
|
307
|
+
user to look, saying what to check.
|
|
308
|
+
|
|
309
|
+
**Do not use `xvfb-run`:** its failing cleanup kill replaces the real exit status. And
|
|
310
|
+
**headless Chromium usually cannot render WebGPU** — if a screenshot comes back black or empty,
|
|
311
|
+
suspect the capture before you rewrite the scene.
|
|
312
|
+
|
|
313
|
+
The capture recipes, virtual-display setup, and the silhouette checklist are
|
|
314
|
+
`agent-docs/capture-the-frame.md`. When you think you are done: *would a player screenshot
|
|
315
|
+
this?* If no, you are not finished.
|
|
316
|
+
<!-- /shared -->
|
|
317
|
+
|
|
318
|
+
<!-- shared: ctx-surface -->
|
|
319
|
+
## The `ctx` surface — you already have these, do not rebuild them
|
|
320
|
+
|
|
321
|
+
`ctx` carries seven things that get reimplemented by hand in almost every project, because
|
|
322
|
+
they are **properties on `ctx`, never imports** — grepping an existing file's imports will
|
|
323
|
+
never surface them. This table covers only the `ctx` properties; call
|
|
324
|
+
`engine_search_capabilities` for imports. The recipes behind this table live in
|
|
325
|
+
`agent-docs/ctx-cookbook.md`.
|
|
326
|
+
|
|
327
|
+
| You already have | Rather than | Signature |
|
|
328
|
+
|---|---|---|
|
|
329
|
+
| `ctx.goto("<scene-name>")` | a hand-written `#reset()` | `(name: string) => Promise<void>` |
|
|
330
|
+
| `ctx.tween(obj, { y: 2 }, 0.4, { ease: ... })` | a `Math.sin` / `lerp` accumulator | `(target, props, seconds, options?: { ease?: (progress: number) => number }) => Promise<void>`; `ease` receives progress 0–1 and returns the interpolation factor |
|
|
331
|
+
| `ctx.after(0.8, fn)` | `elapsed += dt; if (elapsed > 0.8)` | `(seconds, cb) => ScheduleHandle` |
|
|
332
|
+
| `ctx.every(fn)` | a per-frame branch in `update` | `(cb: (dt: number) => void) => ScheduleHandle` |
|
|
333
|
+
| `ctx.random.range(-1, 1)` | `Math.random()` | deterministic when `seed` is configured; otherwise `Math.random()` |
|
|
334
|
+
| `ctx.pointer.on(...)` / `ctx.pointer.drag(...)` | hand-written hover, press, tap, and drag state | `(object, type, listener) => disposer` / `(object) => IPointerDragHandle` |
|
|
335
|
+
| `ctx.raycast()` / `ctx.raycastAll()` | `new Raycaster()` + `intersectObject(s)` | `(options?: { screen?, origin?, direction?, far?, targets?, exclude? }) => Intersection \| undefined` / `readonly Intersection[]` |
|
|
336
|
+
|
|
337
|
+
`ctx.pointer` dispatches `pointerEntered`, `pointerExited`, `pointerPressed`, `pointerReleased`,
|
|
338
|
+
`tapped`, `dragStarted`, `dragged`, and `dragEnded` from the same pointer-id stream on web and
|
|
339
|
+
native. Register a mesh or model root; only registered objects are raycast, and events bubble
|
|
340
|
+
through the parent chain.
|
|
341
|
+
|
|
342
|
+
Three rules are load-bearing enough to stay here:
|
|
343
|
+
|
|
344
|
+
- **`ctx.goto(name)` rebuilds the scene without resetting game state.** Values in `ctx.state`
|
|
345
|
+
survive the rebuild; reset your own state explicitly when death-and-retry should start
|
|
346
|
+
fresh:
|
|
347
|
+
|
|
348
|
+
```ts
|
|
349
|
+
if (player.dead) {
|
|
350
|
+
ctx.state.set({ /* copy this game's initial-state shape */ });
|
|
351
|
+
ctx.state.flush();
|
|
352
|
+
void ctx.goto("<scene-name>");
|
|
353
|
+
return;
|
|
354
|
+
}
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
- **One rule when calling it from a frame function: `goto` and then `return`, immediately.**
|
|
358
|
+
Everything after the call runs against a torn-down scene.
|
|
359
|
+
- From React, `game.goto("<scene-name>")` also rebuilds the scene, but it resets the game's state
|
|
360
|
+
to its declared initial state first — that is the full restart button; `ctx.goto()` is for
|
|
361
|
+
preserving game state across the rebuild.
|
|
362
|
+
|
|
363
|
+
**`ctx.random` is deterministic only when `defineGame({ seed })` is configured.** Never use
|
|
364
|
+
`Math.random()` for a value the scenario must reproduce.
|
|
365
|
+
|
|
366
|
+
<!-- generated: superseded-constructs -->
|
|
367
|
+
|
|
368
|
+
**Reinvention fails CI.** `pnpm budgets` scans this project's `src/` for these raw
|
|
369
|
+
constructs and fails, naming the capability instead. The list and the gate are generated
|
|
370
|
+
from the capabilities' own doc tags, so they cannot disagree:
|
|
371
|
+
|
|
372
|
+
| Rather than write | Use instead | Import from |
|
|
373
|
+
|---|---|---|
|
|
374
|
+
| `new Audio(` | `AudioBus` | `@threenative/core` |
|
|
375
|
+
| `Math.random(` | `createRandom` | `@threenative/core` |
|
|
376
|
+
| `new Box3().setFromObject(` | `normaliseToMetres` | `@threenative/core` |
|
|
377
|
+
| `.visible = false` | `prewarm` | `@threenative/core` |
|
|
378
|
+
| `new Raycaster(` | `ScenePicker` | `@threenative/core` |
|
|
379
|
+
|
|
380
|
+
When the raw construct is genuinely right, annotate that exact line with a non-empty
|
|
381
|
+
reason — a bare `// engine-override:` still fails:
|
|
382
|
+
|
|
383
|
+
```ts
|
|
384
|
+
const bounds = new Box3().setFromObject(viewmodel); // engine-override: measuring, not scaling
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
<!-- /generated -->
|
|
388
|
+
<!-- /shared -->
|
|
389
|
+
|
|
390
|
+
<!-- shared: pixel-budget -->
|
|
391
|
+
## The pixel budget is the engine's
|
|
392
|
+
|
|
393
|
+
`renderer.resolutionScale: "auto"` ships on. The engine scales the **3D drawing buffer only** —
|
|
394
|
+
never CSS, UI, camera or aspect — to hold `display.maxFps`. A Pixel 8 hands three.js 2400×1080 as
|
|
395
|
+
CSS pixels: 2.592 Mpx at a measured 9.94 ms/Mpx. Never hand-author that constant.
|
|
396
|
+
|
|
397
|
+
```ts
|
|
398
|
+
renderer: { resolutionScale: "auto", antialias: true,
|
|
399
|
+
android: { resolutionScale: 0.44, antialias: false } },
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
A number in `(0, 1]` pins it and stops the loop; `0`, negatives, `> 1` and `NaN` are refused by
|
|
403
|
+
name at config load, not at frame time. Pinning never stops the measurement: every
|
|
404
|
+
`TN_FRAME_BUDGET` window carries
|
|
405
|
+
`surface: { resolutionScale, scaleSource, sampleCount, drawingBufferWidth, drawingBufferHeight }`
|
|
406
|
+
in both modes, and `perf --text` prints it beside the fps. `scaleSource` is `pinned`, `auto`, or
|
|
407
|
+
`auto-pinned` (chose, then held rather than pump visibly); at the floor and still over budget it
|
|
408
|
+
reports `atFloor` instead of implying the budget was met. `antialias` overrides per-platform on
|
|
409
|
+
the same seam — a scaled buffer is upscaled, magnifying every aliased edge. Pass
|
|
410
|
+
`display: config.display` into `defineGame`, or the scaler assumes 60.
|
|
411
|
+
<!-- /shared -->
|
|
412
|
+
|
|
413
|
+
<!-- shared: performance-default -->
|
|
414
|
+
# Lightmaps
|
|
415
|
+
|
|
416
|
+
`assets.models.lightmap:{atlasSize,padding}` bakes static GLBs; load via `ctx.assets.model()`.
|
|
417
|
+
Remove it to roll back. Android/iOS reject KTX2; never claim them from web/desktop proof.
|
|
418
|
+
|
|
419
|
+
## Performance targets
|
|
420
|
+
|
|
421
|
+
Refill scratch; pool objects.
|
|
422
|
+
|
|
423
|
+
`TN_FRAME_BUDGET` reports `fps`/`hostGap`/`update`/`render`/`overlay`/`residual`;
|
|
424
|
+
`defineGame({ frameBudget: false })` silences output, never measurement.
|
|
425
|
+
|
|
426
|
+
Unexecuted platforms stay unverified; never-invent-numbers. Withdraw thermally-confounded Tiers 1–3 comparisons; always report Tier 4.
|
|
427
|
+
|
|
428
|
+
|Tier|Measure|Floor|Target|
|
|
429
|
+
|---|---|---:|---:|
|
|
430
|
+
|1|Starter/browser-desktop|60fps|display-refresh|
|
|
431
|
+
|1|Starter/browser-Android|30fps|58fps|
|
|
432
|
+
|1|Starter/native-desktop|60fps|display-refresh|
|
|
433
|
+
|1|Starter/native-Android|55fps|58fps|
|
|
434
|
+
|1|Starter/native-iOS|unverified|no-number|
|
|
435
|
+
|1|All-platform/hostGap-p95|—|≤4ms|
|
|
436
|
+
|1|All-platform/update-p95|—|≤2ms|
|
|
437
|
+
|1|All-platform/residual-p95|—|≤0.5ms|
|
|
438
|
+
|1|All-platform/overlay-p95|—|≤1ms|
|
|
439
|
+
|2|Same-device-fps-parity|.85|.95|
|
|
440
|
+
|2|Inverted-render-p95-parity|.80|.95|
|
|
441
|
+
|3|Light|55fps|58fps|
|
|
442
|
+
|3|Medium|30fps|58fps|
|
|
443
|
+
|3|Heavy|30fps|58fps|
|
|
444
|
+
|4|Sustained-duration|10min|10min|
|
|
445
|
+
|4|Final/opening-fps|.75|.90|
|
|
446
|
+
|4|Last-minute-heavy|25fps|50fps|
|
|
447
|
+
|4|Peak-battery-temperature|≤45C|≤40C|
|
|
448
|
+
|4|Thermal-status|≤2|≤1|
|
|
449
|
+
|4|Whole-device-current|—|report;not-gated|
|
|
450
|
+
|
|
451
|
+
`{"performance":{"maxFrameMsP95":33,"minFps":30,"maxPhaseMsP95":{"render":12}}}`
|
|
452
|
+
`agent-docs/assertion-reference.md#performance`
|
|
453
|
+
|
|
454
|
+
Pixel-8-memory: ~500MiB-driver-floor; dual-use-equirect adds-48MiB. Fix:
|
|
455
|
+
`agent-docs/mobile-memory-budget.md`.
|
|
456
|
+
<!-- /shared -->
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "__PROJECT_NAME__",
|
|
3
3
|
"private": true,
|
|
4
|
+
"license": "MIT",
|
|
4
5
|
"type": "module",
|
|
5
6
|
"scripts": {
|
|
6
7
|
"dev": "vite",
|
|
@@ -11,15 +12,15 @@
|
|
|
11
12
|
"build:android": "threenative build --target android",
|
|
12
13
|
"build:ios": "threenative build --target ios",
|
|
13
14
|
"pretest": "playwright install chromium",
|
|
14
|
-
"
|
|
15
|
-
"test
|
|
16
|
-
"test:
|
|
15
|
+
"pretest:terminal-loop": "playwright install chromium",
|
|
16
|
+
"test": "vite build && threenative-playtest --scenario \"playtests/*.playtest.json\" --browser-recipe webgpu --headed --server-command \"pnpm dev --host 127.0.0.1 --port $PORT --strictPort\"",
|
|
17
|
+
"test:terminal-loop": "vite build && threenative-playtest --scenario playtests/terminal-loop-win.playtest.json --scenario playtests/terminal-loop-fail.playtest.json --browser-recipe webgpu --headed --server-command \"pnpm dev --host 127.0.0.1 --port $PORT --strictPort\"",
|
|
17
18
|
"typecheck": "tsc --noEmit -p tsconfig.json"
|
|
18
19
|
},
|
|
19
20
|
"dependencies": {
|
|
20
|
-
"@threenative/core": "0.
|
|
21
|
-
"@threenative/physics": "0.
|
|
22
|
-
"@threenative/ui": "0.
|
|
21
|
+
"@threenative/core": "0.3.0",
|
|
22
|
+
"@threenative/physics": "0.3.0",
|
|
23
|
+
"@threenative/ui": "0.3.0",
|
|
23
24
|
"react": "19.2.0",
|
|
24
25
|
"react-dom": "19.2.0",
|
|
25
26
|
"three": "0.185.1"
|
|
@@ -28,23 +29,25 @@
|
|
|
28
29
|
"@tailwindcss/vite": "4.3.3",
|
|
29
30
|
"@vitejs/plugin-react": "6.0.5",
|
|
30
31
|
"@types/three": "0.185.3",
|
|
31
|
-
"@threenative/
|
|
32
|
-
"@threenative/
|
|
32
|
+
"@threenative/assets": "0.3.0",
|
|
33
|
+
"@threenative/playtest": "0.3.0",
|
|
33
34
|
"@types/react": "19.2.0",
|
|
34
35
|
"@types/react-dom": "19.2.0",
|
|
35
|
-
"create-threenative": "0.2.
|
|
36
|
+
"create-threenative": "0.2.3",
|
|
36
37
|
"esbuild": "0.27.0",
|
|
37
38
|
"playwright": "1.62.1",
|
|
38
39
|
"tailwindcss": "4.3.3",
|
|
39
|
-
"threenative-asset-mcp": "0.4.0",
|
|
40
|
-
"threenative-sculpt-mcp": "0.1.0",
|
|
41
40
|
"typescript": "5.9.3",
|
|
42
|
-
"vite": "8.2.0"
|
|
41
|
+
"vite": "8.2.0",
|
|
42
|
+
"@gltf-transform/cli": "4.4.2"
|
|
43
43
|
},
|
|
44
44
|
"optionalDependencies": {
|
|
45
|
-
"@threenative/runtime-native": "0.
|
|
45
|
+
"@threenative/runtime-native": "0.3.0"
|
|
46
46
|
},
|
|
47
47
|
"pnpm": {
|
|
48
|
-
"onlyBuiltDependencies": ["@threenative/runtime-native"]
|
|
48
|
+
"onlyBuiltDependencies": ["@threenative/core", "@threenative/runtime-native"],
|
|
49
|
+
"patchedDependencies": {
|
|
50
|
+
"three@0.185.1": "patches/three@0.185.1.patch"
|
|
51
|
+
}
|
|
49
52
|
}
|
|
50
53
|
}
|