create-threenative 0.2.2 → 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
|
@@ -13,6 +13,89 @@ React.
|
|
|
13
13
|
`src/ui/` are ordinary code in this repository. Nothing in `@threenative/*` reads them.
|
|
14
14
|
Rewrite or delete any of it.
|
|
15
15
|
|
|
16
|
+
<!-- shared: framework-blocks-you -->
|
|
17
|
+
### Before you write a system, ask what already exists
|
|
18
|
+
|
|
19
|
+
You have `engine_search_capabilities`. Discovery is required before planning:
|
|
20
|
+
|
|
21
|
+
1. Infer concrete mechanics from the request: world, traversal, interaction, simulation, combat,
|
|
22
|
+
camera, audio, and UI. Preserve its distinctive fantasy with the smallest loop using its
|
|
23
|
+
characteristic setting or traversal—not a generic game with themed props. Search implied
|
|
24
|
+
mechanics even when the user omits engine terms. Ask one short question only when two core loops
|
|
25
|
+
remain equally plausible.
|
|
26
|
+
2. Search the full mechanical request with `scope: "request"`, then every mechanic with
|
|
27
|
+
`scope: "mechanic"`. Check each returned `matchedSituation`.
|
|
28
|
+
3. Before writing replacements, record a capability or no-match for every mechanic.
|
|
29
|
+
|
|
30
|
+
Repeat before writing entity, movement, navigation, attachment, audio, particle, simulation,
|
|
31
|
+
terrain, or measurement systems. Describe situations plainly: *"enemy walks around a wall"*.
|
|
32
|
+
|
|
33
|
+
The manifest is the complete public surface; grep misses unused subpath exports such as
|
|
34
|
+
`@threenative/physics/navigation`. If MCP is unavailable, run doctor and search
|
|
35
|
+
`agent-docs/capability-reference.md` per mechanic.
|
|
36
|
+
|
|
37
|
+
Constraints are binding. Import navigation symbols from the returned subpath. Use `attachToBone`
|
|
38
|
+
for held weapons; if needed, add a portable Three.js `Bone` named `RightHand` first. Capability
|
|
39
|
+
detail governs platform support: never invent limits it does not report. Reject only for a reported
|
|
40
|
+
constraint or a contract that does not fit.
|
|
41
|
+
|
|
42
|
+
This prevents reimplementing installed systems; one game did so in 446 lines and ran at 9 FPS.
|
|
43
|
+
|
|
44
|
+
## When the framework blocks you, write plain Three.js
|
|
45
|
+
|
|
46
|
+
For browser, blank-frame, device, or import failures, first run `npx threenative doctor` and
|
|
47
|
+
`npx @threenative/playtest doctor`. They separate project/machine failures from engine bugs. For a
|
|
48
|
+
running game that looks wrong, inspect it:
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
npx @threenative/playtest doctor --url http://127.0.0.1:5173 --text
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
This reports visibility, scale, draw cost, frame rate, advancing state, and errors. Missing output
|
|
55
|
+
means unobserved, never zero.
|
|
56
|
+
|
|
57
|
+
When an `@threenative/*` API is broken, missing, or does not do what you need, implement only that
|
|
58
|
+
piece with portable Three.js/plain code and continue:
|
|
59
|
+
|
|
60
|
+
1. Keep the existing loop, scenes, input, registry, and playtest bridge.
|
|
61
|
+
2. Avoid `document`, `window`, `localStorage`, dynamic `import()`, and raw physics handles.
|
|
62
|
+
3. **Report what blocked you**: API, expectation, result, and replacement.
|
|
63
|
+
|
|
64
|
+
Never stall on a framework bug.
|
|
65
|
+
|
|
66
|
+
### Where the long recipes live
|
|
67
|
+
|
|
68
|
+
Open the relevant shipped recipe when needed:
|
|
69
|
+
|
|
70
|
+
- `agent-docs/finding-assets.md` — asset search, licenses, downloads, and archives.
|
|
71
|
+
- `agent-docs/sculpt-from-a-reference.md` — sculpt gates and branches.
|
|
72
|
+
- `agent-docs/webview-ui.md` — UI state, intents, and hit regions.
|
|
73
|
+
- `agent-docs/capture-the-frame.md` — WebGPU screenshots.
|
|
74
|
+
- `agent-docs/ctx-cookbook.md` — raycasts, rebuilds, and seeded randomness.
|
|
75
|
+
- `agent-docs/gameplay-recipes.md` — movement, gamepads, and physics timing.
|
|
76
|
+
- `agent-docs/visual-baseline.md` — generated render-source conventions.
|
|
77
|
+
<!-- /shared -->
|
|
78
|
+
|
|
79
|
+
## Engine capabilities — look it up before writing a replacement
|
|
80
|
+
|
|
81
|
+
<!-- shared: engine-capabilities -->
|
|
82
|
+
Use `engine_search_capabilities("pool decals on surfaces")`; plain situations and complete game
|
|
83
|
+
requests both work. If the MCP server is unavailable after `npx threenative doctor`, use the
|
|
84
|
+
generated `agent-docs/capability-reference.md` and repeat the same full-request plus per-mechanic
|
|
85
|
+
search pass manually. Grepping existing imports is never capability discovery.
|
|
86
|
+
<!-- /shared -->
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
`@threenative/physics/navigation` carries WASM and is browser-only under the current native
|
|
90
|
+
portability rule; do not import it in a portable game. For browser-only games, navigation agents
|
|
91
|
+
calculate a path but never move your object: write the steering velocity and call
|
|
92
|
+
`CharacterBody3D.moveAndSlide()`. A `NavigationRegion3D` is static and must be baked from the
|
|
93
|
+
world geometry; changing geometry needs an explicit re-bake. `GroundSnap` keeps `clearance`
|
|
94
|
+
truthful when `enabled = false`, `normaliseToMetres` measures a skinned crown for height, and
|
|
95
|
+
`prewarm` keeps transient meshes renderable with zero opacity so the first-use frame is not a stall.
|
|
96
|
+
`AnimationPlayer` matches a travelling clip's rate to the ground covered, so feet never skate;
|
|
97
|
+
`strideRoot` names the moved body and `strideSync: false` overrides while `stride` still reports.
|
|
98
|
+
|
|
16
99
|
## Commands
|
|
17
100
|
|
|
18
101
|
```sh
|
|
@@ -21,6 +104,7 @@ pnpm studio # chat, preview and proof in one page; needs clau
|
|
|
21
104
|
pnpm build # web build; identical to vite build
|
|
22
105
|
pnpm build --target desktop # native executable; Linux is the only verified host
|
|
23
106
|
pnpm test # build, start the dev server, and run the committed playtest
|
|
107
|
+
node tools/look.mjs # build, serve dist/, screenshot each vantage to artifacts/look/
|
|
24
108
|
```
|
|
25
109
|
|
|
26
110
|
The normal `@threenative/physics` API selects native Rapier on Android; its source-workspace
|
|
@@ -29,336 +113,326 @@ ship Android or iOS until signed prebuilt runtime assets and their checksum mani
|
|
|
29
113
|
so those targets fail closed for consumers. Linux desktop is source-machine evidence, not a
|
|
30
114
|
clean-machine distribution proof; macOS, Windows, iOS, and physical hardware remain OPEN.
|
|
31
115
|
|
|
116
|
+
## Playtest assertions
|
|
117
|
+
|
|
118
|
+
<!-- shared: playtest-fail-closed -->
|
|
119
|
+
## Playtests fail closed
|
|
120
|
+
|
|
121
|
+
A scenario fails closed: a missing entity, an absent observation, or a scenario with no
|
|
122
|
+
assertions is a failure, never a quiet pass. When you add a feature, add the assertion that
|
|
123
|
+
would catch its absence, and run the scenario before reporting the feature works.
|
|
124
|
+
|
|
125
|
+
Every `allowTrivial` waiver must be a reason string with at least 20 non-whitespace characters
|
|
126
|
+
explaining why the initial value is intentionally held; `allowTrivial: true` is invalid. A
|
|
127
|
+
scenario whose every triviality-eligible assertion is waived fails with
|
|
128
|
+
`TN_PLAYTEST_SCENARIO_ASSERTS_NOTHING`, so keep an independent assertion in the scenario.
|
|
129
|
+
|
|
130
|
+
Steps count fixed-step ticks, not milliseconds — use `holdTicks` and `waitTicks`. The deprecated
|
|
131
|
+
`holdFrames` and `waitFrames` aliases remain accepted for compatibility and are treated as ticks
|
|
132
|
+
on a fixed-step bridge; `warmupFrames` remains a genuine requestAnimationFrame warmup.
|
|
133
|
+
|
|
134
|
+
The assertion vocabulary — every kind the validator accepts, its fields, and when to reach for
|
|
135
|
+
it — is generated into `agent-docs/assertion-reference.md`; open it before inventing a new
|
|
136
|
+
assertion shape. To probe a running game by hand, every bridge global and its shape is
|
|
137
|
+
documented in `agent-docs/debug-surface.md`.
|
|
138
|
+
|
|
139
|
+
The bridge registers exactly one resource id for the JSON-safe game state: `state`; resource
|
|
140
|
+
paths address fields from `ctx.state`. (`GameState` is a deprecated compatibility alias kept
|
|
141
|
+
until published scenarios migrate.)
|
|
142
|
+
<!-- /shared -->
|
|
143
|
+
|
|
32
144
|
## Keep the game portable to native
|
|
33
145
|
|
|
34
146
|
`pnpm build --target desktop` runs this same source on a native host with **no browser**.
|
|
35
|
-
Four
|
|
147
|
+
Four host differences break there, and `@threenative/physics/navigation` is a separate
|
|
148
|
+
browser-only boundary under the current native portability rule:
|
|
36
149
|
|
|
37
|
-
1. **The native host has no DOM
|
|
38
|
-
|
|
39
|
-
`src/ui
|
|
40
|
-
your game-owned render code only if your game needs one.
|
|
150
|
+
1. **The native host has no DOM in the game.** `src/game.ts` and everything it imports must stay
|
|
151
|
+
free of `react-dom` and of `document`; `TN_NATIVE_WEB_ONLY_UI` refuses a build that breaks it.
|
|
152
|
+
`src/ui/` is a separate bundle and has no such rule — see "One UI, on every target".
|
|
41
153
|
2. **No `document`, `window`, or `localStorage` reach outside the canvas.** Use `ctx` and
|
|
42
154
|
Three.js. Save games go through your own JSON, not `window.localStorage` directly.
|
|
43
155
|
3. **No dynamic `import()`.** The native build is one bundled file.
|
|
44
156
|
4. **`.raw` is web-only.** `ctx.physics.world.raw` is a Rapier object in the browser and
|
|
45
157
|
opaque on native. Anything reading it is a web-only code path by contract.
|
|
46
158
|
|
|
47
|
-
Writing against `ctx`, `three`, and the Godot-named physics nodes keeps all four
|
|
48
|
-
without thinking about it. If you only ever ship to the web, ignore this section.
|
|
159
|
+
Writing against `ctx`, `three`, and the Godot-named physics nodes keeps all four host differences
|
|
160
|
+
correct without thinking about it. If you only ever ship to the web, ignore this section.
|
|
49
161
|
|
|
50
|
-
##
|
|
162
|
+
## One UI, on every target
|
|
163
|
+
|
|
164
|
+
`src/ui/` is the whole UI and the same source everywhere — ordinary React DOM, Tailwind and SVG,
|
|
165
|
+
beside the canvas on web and in the platform's own browser-class renderer over the game surface on
|
|
166
|
+
native. `GameUi.tsx` holds it; `App.tsx` and `main.tsx` mount it.
|
|
51
167
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
ui["ui/<br/>App.tsx, Hud.tsx, Menu.tsx — React 19 + Tailwind 4"]
|
|
61
|
-
state["state.ts<br/>state shape the HUD subscribes to"]
|
|
62
|
-
scenarios["playtests/*.playtest.json<br/>committed browser scenarios, run by pnpm test"]
|
|
63
|
-
config["threenative.config.ts<br/>app identity, icon, display, desktop window, renderer"]
|
|
64
|
-
|
|
65
|
-
project --> src
|
|
66
|
-
src --> main
|
|
67
|
-
src --> play
|
|
68
|
-
src --> entities
|
|
69
|
-
src --> render
|
|
70
|
-
src --> ui
|
|
71
|
-
src --> state
|
|
72
|
-
project --> scenarios
|
|
73
|
-
project --> config
|
|
168
|
+
**The game and the UI are separate processes on native**, so the UI cannot hold the game object: it
|
|
169
|
+
reads *published* state and sends *intents*, and `src/game.ts` decides what each means.
|
|
170
|
+
|
|
171
|
+
```tsx
|
|
172
|
+
const state = useUiState<GameState>(); // ~10 Hz; undefined until the first snapshot
|
|
173
|
+
if (state === undefined) return null;
|
|
174
|
+
const send = useUiIntent();
|
|
175
|
+
<button data-tn-interactive onClick={() => send("restart")}>restart</button>
|
|
74
176
|
```
|
|
75
177
|
|
|
76
|
-
`
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
178
|
+
**`data-tn-interactive` marks every element the player touches** — the one thing a UI must do
|
|
179
|
+
differently from a web page. The host decides on pointer-down whether a touch is
|
|
180
|
+
the UI's or the game's; unmarked elements are scenery a touch passes through.
|
|
181
|
+
`pointer-events: none` is not that mechanism, and `agent-docs/webview-ui.md` says why.
|
|
182
|
+
`ui: { renderer: "native" }` draws `View`/`Text` quads in the frame instead.
|
|
183
|
+
|
|
184
|
+
## The game this ships with
|
|
185
|
+
|
|
186
|
+
One ledge over a chasm, a pickup on it, a crate that drops onto it, and a gap with a flag:
|
|
187
|
+
reaching the flag sets `state.status` to `"won"`; falling past the kill plane costs one of
|
|
188
|
+
three `state.lives`, and the third fall sets `"lost"`. Either ending stops the scene from
|
|
189
|
+
simulating the character and paints a React banner; `R` and the restart button rebuild the
|
|
190
|
+
scene from `initialState`.
|
|
191
|
+
|
|
192
|
+
That is a whole game loop in about forty lines of `src/scenes/Play.ts`, there to be replaced.
|
|
193
|
+
Keep the shape — an outcome in `ctx.state`, the scene stopping itself, a React component
|
|
194
|
+
reading the outcome — and change everything else. The flag's pennant is the packaged
|
|
195
|
+
`assets/native-proof.glb`: it is loaded in `Play.load()` and the console marker that follows
|
|
196
|
+
is what the desktop asset gate greps for, so if you delete the flag, keep the load.
|
|
197
|
+
|
|
198
|
+
## The layout
|
|
80
199
|
|
|
81
|
-
`src/
|
|
82
|
-
|
|
200
|
+
`src/main.ts` mounts React and calls `defineGame`; `src/scenes/Play.ts` is the gameplay
|
|
201
|
+
(load, enter, update, exit); `src/entities/` are plain classes, not an ECS; `src/render/` is
|
|
202
|
+
your look; `src/ui/` is React 19 + Tailwind 4; `state.ts` holds the shape the HUD subscribes
|
|
203
|
+
to; `playtests/*.playtest.json` run under `pnpm test`. There is no ECS to join and no
|
|
204
|
+
registration file — the tree is small enough to read.
|
|
205
|
+
|
|
206
|
+
`threenative.config.ts` is the one game-owned app-shape file: launcher identity and icon,
|
|
207
|
+
mobile orientation and display flags, desktop window, renderer preference, native entry.
|
|
208
|
+
`package.json` may retain only `threenative.nativeEntry` as a compatibility fallback.
|
|
209
|
+
|
|
210
|
+
`src/ui/Hud.tsx` is the gameplay HUD and `src/ui/Menu.tsx` the in-game pause bar. The game boots
|
|
211
|
+
straight into `Play`; there is no start screen and no `screen` field, because a game that ships
|
|
212
|
+
one scene should not make the player dismiss a menu to reach it. If this game needs screens, the
|
|
213
|
+
complete menu-to-settings-to-play recipe is `agent-docs/menu-screens.md` — add the scene, the
|
|
214
|
+
state field the UI switches on, and the scenario that drives it in the same change.
|
|
83
215
|
Touch controls are not generated yet: add the small pointer-action mapping after the core
|
|
84
216
|
multitouch surface from PRD-053 lands.
|
|
85
217
|
|
|
86
218
|
## How to write gameplay here
|
|
87
219
|
|
|
88
220
|
A scene is a class with optional `load`, `enter`, `update`, `exit`, and `render`. That is
|
|
89
|
-
the whole lifecycle — there is nothing else to register.
|
|
90
|
-
|
|
91
|
-
`ctx`
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
ctx.scene // THREE.Scene
|
|
95
|
-
ctx.camera // THREE.PerspectiveCamera
|
|
96
|
-
ctx.renderer // the renderer
|
|
97
|
-
ctx.physics.world // PhysicsWorldHandle
|
|
98
|
-
player.body // PhysicsBodyHandle (via CharacterBody3D)
|
|
99
|
-
player.mesh // THREE.Mesh
|
|
100
|
-
```
|
|
221
|
+
the whole lifecycle — there is nothing else to register. `ctx` hands you real Three.js objects
|
|
222
|
+
(`ctx.scene`, `ctx.camera`, `ctx.renderer`) and backend-neutral physics handles
|
|
223
|
+
(`ctx.physics.world`, `player.body`, `player.mesh`). The handles expose `.raw` as an explicitly
|
|
224
|
+
backend-specific escape hatch: Rapier on web, opaque on native. Code that reads `.raw` is not
|
|
225
|
+
portable between those targets.
|
|
101
226
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
inside a scene. Prefer that over hunting for a framework wrapper — **for anything Three.js
|
|
107
|
-
itself does (geometry, materials, lights, math), there is no wrapper and you should write
|
|
108
|
-
the Three.js.** The exception is the loop: scene changes, timers and tweens are on `ctx`,
|
|
109
|
-
not in an import, so grepping the imports of an existing file will not find them. The
|
|
110
|
-
table below is the complete list.
|
|
227
|
+
Any Three.js tutorial or snippet you already know works unchanged inside a scene. Prefer that
|
|
228
|
+
over hunting for a framework wrapper — **for anything Three.js itself does (geometry,
|
|
229
|
+
materials, lights, math), there is no wrapper and you should write the Three.js.** The
|
|
230
|
+
exception is the loop: scene changes, timers and tweens are on `ctx`, never imports.
|
|
111
231
|
|
|
112
232
|
Physics uses Godot's names: `RigidBody3D`, `Area3D`, `CharacterBody3D`, `CollisionShape3D`.
|
|
113
233
|
Every node has `dispose()`. Register disposable entities with `ctx.entities`; the framework
|
|
114
|
-
clears
|
|
115
|
-
|
|
116
|
-
`visibility` assertion, looks the entity up by that string — an unregistered player fails
|
|
117
|
-
`TN_PLAYTEST_VISIBILITY_FAILED` however visible it is on screen.
|
|
234
|
+
clears them when a scene exits. **The id is the name a scenario resolves** — an unregistered
|
|
235
|
+
player fails `TN_PLAYTEST_VISIBILITY_FAILED` however visible it is on screen.
|
|
118
236
|
|
|
119
237
|
`input.vector("move").y` is +up; map it to world-space -z for forward with one explicit
|
|
120
238
|
`-move.y` conversion in the player movement code.
|
|
121
239
|
|
|
122
|
-
`
|
|
123
|
-
|
|
240
|
+
Gamepad bindings and their deadzone trap, the deferred `moveAndSlide(dt)` step-timing rule,
|
|
241
|
+
and save/load snippets live in `agent-docs/gameplay-recipes.md`.
|
|
124
242
|
|
|
243
|
+
<!-- shared: ctx-surface -->
|
|
125
244
|
## The `ctx` surface — you already have these, do not rebuild them
|
|
126
245
|
|
|
127
|
-
`ctx` carries
|
|
246
|
+
`ctx` carries seven things that get reimplemented by hand in almost every project, because
|
|
128
247
|
they are **properties on `ctx`, never imports** — grepping an existing file's imports will
|
|
129
|
-
never surface them. This table
|
|
248
|
+
never surface them. This table covers only the `ctx` properties; call
|
|
249
|
+
`engine_search_capabilities` for imports. The recipes behind this table live in
|
|
250
|
+
`agent-docs/ctx-cookbook.md`.
|
|
130
251
|
|
|
131
252
|
| You already have | Rather than | Signature |
|
|
132
253
|
|---|---|---|
|
|
133
|
-
| `ctx.goto("
|
|
134
|
-
| `ctx.tween(obj, { y: 2 }, 0.4)` | a `Math.sin` / `lerp` accumulator | `(target, props, seconds) => Promise<void
|
|
254
|
+
| `ctx.goto("<scene-name>")` | a hand-written `#reset()` | `(name: string) => Promise<void>` |
|
|
255
|
+
| `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 |
|
|
135
256
|
| `ctx.after(0.8, fn)` | `elapsed += dt; if (elapsed > 0.8)` | `(seconds, cb) => ScheduleHandle` |
|
|
136
257
|
| `ctx.every(fn)` | a per-frame branch in `update` | `(cb: (dt: number) => void) => ScheduleHandle` |
|
|
137
|
-
| `ctx.random.range(-1, 1)` | `Math.random()` |
|
|
138
|
-
| `ctx.
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
pointer
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
registered entities are cleared, the Three scene is emptied, then a fresh instance runs
|
|
152
|
-
`load()` and `enter()`. That is your entire restart button, and your entire death-and-retry.
|
|
153
|
-
|
|
154
|
-
Do **not** write a `#reset()` that walks your entities putting them back. It is ~15 lines
|
|
155
|
-
that look right and quietly miss the scheduler and anything you spawned after `enter()`, so
|
|
156
|
-
the second playthrough behaves differently from the first — and no gate in this project will
|
|
157
|
-
catch that.
|
|
158
|
-
|
|
159
|
-
**One rule when calling it from a frame function: `goto` and then `return`, immediately.**
|
|
258
|
+
| `ctx.random.range(-1, 1)` | `Math.random()` | deterministic when `seed` is configured; otherwise `Math.random()` |
|
|
259
|
+
| `ctx.pointer.on(...)` / `ctx.pointer.drag(...)` | hand-written hover, press, tap, and drag state | `(object, type, listener) => disposer` / `(object) => IPointerDragHandle` |
|
|
260
|
+
| `ctx.raycast()` / `ctx.raycastAll()` | `new Raycaster()` + `intersectObject(s)` | `(options?: { screen?, origin?, direction?, far?, targets?, exclude? }) => Intersection \| undefined` / `readonly Intersection[]` |
|
|
261
|
+
|
|
262
|
+
`ctx.pointer` dispatches `pointerEntered`, `pointerExited`, `pointerPressed`, `pointerReleased`,
|
|
263
|
+
`tapped`, `dragStarted`, `dragged`, and `dragEnded` from the same pointer-id stream on web and
|
|
264
|
+
native. Register a mesh or model root; only registered objects are raycast, and events bubble
|
|
265
|
+
through the parent chain.
|
|
266
|
+
|
|
267
|
+
Three rules are load-bearing enough to stay here:
|
|
268
|
+
|
|
269
|
+
- **`ctx.goto(name)` rebuilds the scene without resetting game state.** Values in `ctx.state`
|
|
270
|
+
survive the rebuild; reset your own state explicitly when death-and-retry should start
|
|
271
|
+
fresh:
|
|
160
272
|
|
|
161
273
|
```ts
|
|
162
274
|
if (player.dead) {
|
|
163
|
-
|
|
164
|
-
|
|
275
|
+
ctx.state.set({ /* copy this game's initial-state shape */ });
|
|
276
|
+
ctx.state.flush();
|
|
277
|
+
void ctx.goto("<scene-name>");
|
|
278
|
+
return;
|
|
165
279
|
}
|
|
166
280
|
```
|
|
167
281
|
|
|
168
|
-
|
|
169
|
-
|
|
282
|
+
- **One rule when calling it from a frame function: `goto` and then `return`, immediately.**
|
|
283
|
+
Everything after the call runs against a torn-down scene.
|
|
284
|
+
- From React, `game.goto("<scene-name>")` also rebuilds the scene, but it resets the game's state
|
|
285
|
+
to its declared initial state first — that is the full restart button; `ctx.goto()` is for
|
|
286
|
+
preserving game state across the rebuild.
|
|
287
|
+
|
|
288
|
+
**`ctx.random` is deterministic only when `defineGame({ seed })` is configured.** Never use
|
|
289
|
+
`Math.random()` for a value the scenario must reproduce.
|
|
170
290
|
|
|
171
|
-
|
|
172
|
-
0.4s, a door opening, a hit flash — and keep the *what* (colour, shape, easing feel) in
|
|
173
|
-
`src/render/`. Motion driven by a persistent `Math.sin(elapsed)` in `update()` is still the
|
|
174
|
-
right tool for a continuous idle bob; `tween` is for anything that starts, runs once, and
|
|
175
|
-
finishes.
|
|
291
|
+
<!-- generated: superseded-constructs -->
|
|
176
292
|
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
293
|
+
**Reinvention fails CI.** `pnpm budgets` scans this project's `src/` for these raw
|
|
294
|
+
constructs and fails, naming the capability instead. The list and the gate are generated
|
|
295
|
+
from the capabilities' own doc tags, so they cannot disagree:
|
|
180
296
|
|
|
181
|
-
|
|
297
|
+
| Rather than write | Use instead | Import from |
|
|
298
|
+
|---|---|---|
|
|
299
|
+
| `new Audio(` | `AudioBus` | `@threenative/core` |
|
|
300
|
+
| `Math.random(` | `createRandom` | `@threenative/core` |
|
|
301
|
+
| `new Box3().setFromObject(` | `normaliseToMetres` | `@threenative/core` |
|
|
302
|
+
| `.visible = false` | `prewarm` | `@threenative/core` |
|
|
303
|
+
| `new Raycaster(` | `ScenePicker` | `@threenative/core` |
|
|
182
304
|
|
|
183
|
-
|
|
184
|
-
|
|
305
|
+
When the raw construct is genuinely right, annotate that exact line with a non-empty
|
|
306
|
+
reason — a bare `// engine-override:` still fails:
|
|
185
307
|
|
|
186
308
|
```ts
|
|
187
|
-
const
|
|
188
|
-
const loaded = JSON.parse(save) as { state: GameState; playerX: number };
|
|
189
|
-
ctx.state.set(loaded.state);
|
|
190
|
-
player.body.teleport({ x: loaded.playerX, y: player.mesh.position.y, z: player.mesh.position.z });
|
|
309
|
+
const bounds = new Box3().setFromObject(viewmodel); // engine-override: measuring, not scaling
|
|
191
310
|
```
|
|
192
311
|
|
|
312
|
+
<!-- /generated -->
|
|
313
|
+
<!-- /shared -->
|
|
314
|
+
|
|
193
315
|
## Assets and animation
|
|
194
316
|
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
317
|
+
Files the game loads live in `assets/`; the dev server and `threenative build` compile them
|
|
318
|
+
into hashed outputs in `public/` plus `public/assets.manifest.json`, and
|
|
319
|
+
`ctx.assets.model("hero.glb")` resolves the logical name through that manifest. Favicon and
|
|
320
|
+
launcher icons stay hand-owned in `public/`. This starter ships
|
|
321
|
+
`assets/native-proof.glb`, `assets/native-proof.png` and `assets/pickup.wav`; compiled
|
|
322
|
+
outputs are gitignored. **Audio is WAV** because Android decodes RIFF/WAVE only;
|
|
323
|
+
`--target android` refuses the rest.
|
|
324
|
+
|
|
325
|
+
For clips from a rigged asset, drop the `.glb` in `assets/`, await
|
|
326
|
+
`ctx.assets.model("hero.glb")` in `Scene.load()`, then drive an `AnimationPlayer` beside the
|
|
327
|
+
owning entity.
|
|
328
|
+
|
|
329
|
+
Before placing an unfamiliar model, inspect it with
|
|
330
|
+
`npx create-threenative inspect assets/hero.glb` (`--json` for machine output): observational
|
|
331
|
+
heuristics — units, forward axis — never a rewrite.
|
|
199
332
|
|
|
200
333
|
Entities are plain classes. There is no ECS, and adding one is a real decision, not a
|
|
201
334
|
default — `pnpm add miniplex` if a game genuinely needs it.
|
|
202
335
|
|
|
203
|
-
##
|
|
336
|
+
## Off-screen diffuse light
|
|
204
337
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
would hand-author.
|
|
210
|
-
- **Models — only when the thing is conventional.** A car, a plane, a crate, a barrel, a
|
|
211
|
-
tree, a chair. If this game's main character is a car, fetching a compatible `.glb` is the
|
|
212
|
-
right call.
|
|
213
|
-
- **Anything specific to this game — write it in `src/render/`.** A downloaded model standing
|
|
214
|
-
in for a bespoke design reads as a weird asset dropped into the scene, and it looks worse
|
|
215
|
-
than a clean composition of primitives. This is the failure the tools make easy.
|
|
216
|
-
|
|
217
|
-
When in doubt, build it programmatically. A fetched asset has to match what the game needs,
|
|
218
|
-
not merely exist.
|
|
219
|
-
|
|
220
|
-
`.mcp.json` in this project launches `threenative-asset-mcp` from `node_modules`, so your host
|
|
221
|
-
lists its tools alongside your own. It advertises 32; these 8 are the loop you will use for
|
|
222
|
-
nearly everything:
|
|
223
|
-
|
|
224
|
-
1. `asset_search_sources` — start here, never at a provider. It returns every catalogued
|
|
225
|
-
source with its license summary, attribution requirement, browse URL, and whether an agent
|
|
226
|
-
can complete a download from it. **That output is the authority on what is reachable** —
|
|
227
|
-
not this file, and not your memory of some other project.
|
|
228
|
-
2. `polyhaven_search_assets` (CC0 models, textures, HDRIs), `ambientcg_search_assets` (CC0
|
|
229
|
-
materials and textures), or `audio_search_assets` (Kenney, Sonniss).
|
|
230
|
-
3. `polyhaven_list_files` / `ambientcg_list_files` — the license, official URL, byte size and
|
|
231
|
-
md5 of every resolution and format. **Read this before downloading, not after**, and pick a
|
|
232
|
-
sane one: Poly Haven lists 16k PNGs over 1 GB beside 8k JPEGs at 28 MB. A game does not
|
|
233
|
-
need the 16k.
|
|
234
|
-
4. `asset_download_file` for textures and models, `audio_download_asset` for audio. Both take
|
|
235
|
-
`acceptLicense: true` — you are asserting you read step 3. **They ignore any path you pass
|
|
236
|
-
and write to the directories `.mcp.json` sets** (`public/assets/<provider>/<sha>/` and
|
|
237
|
-
`public/audio/<source>/<pack>/`); without that config they would write to `~/Downloads` and
|
|
238
|
-
never reach the game.
|
|
239
|
-
5. Append the file, its source, its license and its URL to `CREDITS.md` **before the turn
|
|
240
|
-
ends**. Poly Haven requires a visible Poly Haven credit when its API is used, ambientCG is
|
|
241
|
-
CC0 per asset page, and audio and bundle licenses are per pack.
|
|
242
|
-
|
|
243
|
-
**Never state a license you did not read off a tool result.** If `polyhaven_list_files` or
|
|
244
|
-
`ambientcg_search_assets` did not tell you, you do not know it.
|
|
245
|
-
|
|
246
|
-
**What arrives is usually a ZIP, not a texture.** ambientCG and Kenney ship archives: unpack
|
|
247
|
-
one, keep only the maps you actually use (`_Color`, `_NormalGL`, `_Roughness` — not the
|
|
248
|
-
`.blend`, `.usdc` or displacement), and put those beside your code under `public/`. A 1K JPEG
|
|
249
|
-
set is right for a game; the 8K set of the same material is 200 MB.
|
|
250
|
-
|
|
251
|
-
Two argument shapes that will bite you, both learned the hard way: `ambientcg_search_assets`
|
|
252
|
-
takes lowercase `type` values (`material`, `hdri`, `3d-model`), and the audio catalog is
|
|
253
|
-
**pack-level** — `audio_search_assets` matches pack names, so `query: "pickup coin"` returns
|
|
254
|
-
nothing while `kind: "sfx"` returns the seven packs that exist. Pick a pack, download it,
|
|
255
|
-
unzip it, and choose a file yourself.
|
|
256
|
-
|
|
257
|
-
The other tools are narrower, and the directory spells out the conditions on each. The Fab
|
|
258
|
-
tools talk to a marketplace: the server never purchases anything, and only directly-free files
|
|
259
|
-
download. `smithsonian_search_assets` returns museum scans at scan resolution, which this
|
|
260
|
-
project has no pipeline to decimate — that geometry is the wrong shape for a game. When in
|
|
261
|
-
doubt check `asset_search_sources` first; its `caution` and license fields are the current
|
|
262
|
-
truth for the pinned version, and they change between versions.
|
|
263
|
-
|
|
264
|
-
Load what you downloaded the ordinary way — `ctx.assets.model("crate.glb")`,
|
|
265
|
-
`ctx.assets.texture(...)`, `ctx.assets.audio(...)` — and write your own material and lighting
|
|
266
|
-
around it in `src/render/`. The framework ships no asset and picks none for you.
|
|
338
|
+
For light bouncing from a room I cannot see, construct `ProbeVolume` from `@threenative/core`
|
|
339
|
+
after the static geometry and lights exist. Add it with `ctx.add()`, request its bake on demand,
|
|
340
|
+
and pass `volume.sampleNode(positionWorld, normalWorld)` into a game-owned Three.js material
|
|
341
|
+
before the screen-space GI stage. The volume owns no light, material, colour, or falloff.
|
|
267
342
|
|
|
343
|
+
This is static-lighting-first, not fully dynamic GI: moving lights and relighting require another
|
|
344
|
+
explicit bake. `TN_PROBE_VOLUME` reports the unbaked/stale state, probe count, atlas bytes,
|
|
345
|
+
progress, and last render-phase bake cost; keep those measurements visible while tuning bounds,
|
|
346
|
+
density, and `bakeBudgetMs`.
|
|
347
|
+
|
|
348
|
+
<!-- shared: asset-mcp-loop -->
|
|
349
|
+
## Finding assets — you have an MCP server for this
|
|
350
|
+
|
|
351
|
+
**Reach for it when the asset is conventional; build anything custom yourself.** Textures,
|
|
352
|
+
materials, HDRIs, sound effects, and conventional models (a car, a crate, a tree) come from the
|
|
353
|
+
tools; anything specific to this game is written in `src/render/` — a downloaded model standing
|
|
354
|
+
in for a bespoke design reads as a weird asset dropped into the scene. When in doubt, build it
|
|
355
|
+
programmatically.
|
|
356
|
+
|
|
357
|
+
Installing `@threenative/core` writes the `.mcp.json` that launches `threenative-asset-mcp`, so
|
|
358
|
+
your host lists its tools alongside your own. Your host reads that file from the directory it was
|
|
359
|
+
launched in: start the session in this project, not in a parent of it. The loop:
|
|
360
|
+
|
|
361
|
+
1. `asset_search_sources` first, never a provider — its output is the authority on what is
|
|
362
|
+
reachable.
|
|
363
|
+
2. `polyhaven_search_assets`, `ambientcg_search_assets`, or `audio_search_assets` to find
|
|
364
|
+
candidates.
|
|
365
|
+
3. `polyhaven_list_files` / `ambientcg_list_files` **before downloading** — read licenses and
|
|
366
|
+
pick a sane resolution there (a game does not need the 16k).
|
|
367
|
+
4. `asset_download_file` / `audio_download_asset` with `acceptLicense: true`; they write where
|
|
368
|
+
`.mcp.json` points, never where you pass a path.
|
|
369
|
+
5. Append file, source, license and URL to `CREDITS.md` before the turn ends.
|
|
370
|
+
|
|
371
|
+
**Never state a license you did not read off a tool result.**
|
|
372
|
+
|
|
373
|
+
**Fab is two steps.** `fab_search_assets` finds a free listing, and `fab_list_owned` says what the
|
|
374
|
+
account already paid for — a free search never shows those. Then `fab_import_asset` converts it: it checks the
|
|
375
|
+
entitlement, downloads through the FabCLI session you established yourself, turns every static
|
|
376
|
+
mesh into a textured `.glb` under `assets/`, and returns the paths. It refuses anything but Fab
|
|
377
|
+
Standard or CC-BY, and it never logs in, claims, or buys. Most Fab listings are Unreal-only, so
|
|
378
|
+
without it a listing is a dead end. Full argument shapes: `agent-docs/finding-assets.md`.
|
|
379
|
+
|
|
380
|
+
The full loop — ZIP unpacking rules, the two argument shapes that bite, and the narrower
|
|
381
|
+
marketplace tools — is `agent-docs/finding-assets.md`.
|
|
382
|
+
<!-- /shared -->
|
|
383
|
+
|
|
384
|
+
<!-- shared: sculpt-loop -->
|
|
268
385
|
## Building what you cannot download — sculpt from a reference
|
|
269
386
|
|
|
270
|
-
Choose one branch before writing code:
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
be generic. Do not invent a reference: comparison without evidence is unguided iteration.
|
|
281
|
-
|
|
282
|
-
For a full environment, split the decision: sculpt the signature landmark or bounded scene
|
|
283
|
-
kit that makes the reference recognisable; use the asset tools for interchangeable trees,
|
|
284
|
-
rocks, textures, HDRIs, and sounds around it. Do not sculpt an entire world as one object.
|
|
285
|
-
|
|
286
|
-
`.mcp.json` launches `threenative-sculpt-mcp` beside the asset server. It does not generate
|
|
287
|
-
or ship runtime code; it guides the source you write:
|
|
288
|
-
|
|
289
|
-
1. Call `sculpt_plan` with the image path and a one-line intent, then read the returned
|
|
290
|
-
grimoire resources.
|
|
291
|
-
2. Write the returned object contract and loop on `sculpt_spec_gate` until every named
|
|
292
|
-
region and depth requirement passes. Do not write geometry before this gate is green.
|
|
293
|
-
3. For each ordered pass, write or extend one factory in `src/render/`. Capture the real
|
|
294
|
-
frame with `npx @threenative/playtest`; the sculpt server never launches a browser.
|
|
295
|
-
4. Call `sculpt_compare` with the reference and captured frame, then give that evidence to
|
|
296
|
-
`sculpt_pass_gate`. Advance only when it says advance; ambiguity means retry.
|
|
297
|
-
5. Use `sculpt_grimoire` for a named technique topic. It rejects pages containing concrete
|
|
298
|
-
paste-ready material or shader recipes so the tool never owns this game's look.
|
|
387
|
+
Choose one branch before writing code: conventional and downloadable — use the asset tools;
|
|
388
|
+
trivial (a platform, a wall) — write it, `BoxGeometry` under 20 lines is the answer; bespoke
|
|
389
|
+
with a reference image — the sculpt tools below; bespoke without one — ask for it, never
|
|
390
|
+
invent a reference.
|
|
391
|
+
|
|
392
|
+
`.mcp.json` launches `threenative-sculpt-mcp`; it does not ship runtime code, it guides the
|
|
393
|
+
source you write: plan with `sculpt_plan`, loop on `sculpt_spec_gate` until every named region
|
|
394
|
+
passes **before writing geometry**, write one factory per pass in `src/render/`, prove each
|
|
395
|
+
pass with `sculpt_compare` plus `sculpt_pass_gate` against a real captured frame (the sculpt
|
|
396
|
+
server never launches a browser), and pull technique topics from `sculpt_grimoire`.
|
|
299
397
|
|
|
300
398
|
A missing or blank capture is a failed run, never a finished model. Add the reference image,
|
|
301
|
-
its creator, license, and source URL to `CREDITS.md` before the turn ends.
|
|
399
|
+
its creator, license, and source URL to `CREDITS.md` before the turn ends. The branch
|
|
400
|
+
definitions and environment-splitting guidance are `agent-docs/sculpt-from-a-reference.md`.
|
|
401
|
+
<!-- /shared -->
|
|
302
402
|
|
|
303
403
|
|
|
304
404
|
## Visuals
|
|
305
405
|
|
|
306
|
-
Edit everything in `src/render
|
|
307
|
-
`
|
|
308
|
-
|
|
309
|
-
not a framework look or a config option. Keep the palette to six named colours
|
|
310
|
-
`accent`; import it from materials and sky. Set tonemapping
|
|
311
|
-
rim light
|
|
312
|
-
`
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
- `
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
- `camera.ts` — `createSpringArm`, a frame-rate-independent follow camera.
|
|
324
|
-
- `postprocessing.ts` — ACES tone mapping and the WebGPU render pipeline.
|
|
325
|
-
|
|
326
|
-
Three traps, all of which cost real debugging time before they were written down:
|
|
327
|
-
|
|
328
|
-
1. **`CanvasTexture` samples black under `WebGPURenderer`.** Procedurally painting a canvas
|
|
329
|
-
and using it as a `map` produces a black surface, silently. Get variety from alternating
|
|
330
|
-
material colours across a run of meshes instead — that is what `makeRandom` is for.
|
|
331
|
-
2. **`flatShading` fights `roundedBox`,** which welds its seams precisely so normals
|
|
332
|
-
interpolate across them. Do not set both.
|
|
333
|
-
3. **Import a render module and then call it.** `setupPost` and `setupLighting` are inert
|
|
334
|
-
if `Play.ts` only imports them, and nothing in typecheck, lint, or a playtest will fail.
|
|
335
|
-
|
|
336
|
-
Nothing in the toolchain can see your game. `pnpm test` proves behaviour, never the look —
|
|
337
|
-
so when you change something visual, actually look at it before reporting it done.
|
|
406
|
+
Edit everything in `src/render/`. The baseline files are `palette.ts`, `camera.ts`,
|
|
407
|
+
`sky.ts`, `lighting.ts`, `materials.ts`, `postprocessing.ts`, and `worldEnvironment.ts`;
|
|
408
|
+
`shapes.ts` and `scenery.ts` are additional helpers. These are ordinary Three.js source in
|
|
409
|
+
this project, not a framework look or a config option. Keep the palette to six named colours
|
|
410
|
+
with one `accent`; import it from materials and sky. Set tonemapping/exposure deliberately; use
|
|
411
|
+
a rim light, soft shadows, and `normalBias`; derive fog from the sky; route postprocessing from
|
|
412
|
+
`postprocessing.ts` through `WorldEnvironment` and `renderer.createRenderChain()`. Optional effects:
|
|
413
|
+
`src/render/effects/lensDistortion.ts`, `sparkle.ts`, `gradualBackground.ts`. Build props out of
|
|
414
|
+
`shapes.ts`
|
|
415
|
+
(`roundedBox`, not raw `BoxGeometry`) and keep something in all three scenery bands — a lit
|
|
416
|
+
floor alone in black reads as a test fixture.
|
|
417
|
+
|
|
418
|
+
The per-file baseline and seven traps are in `agent-docs/visual-baseline.md`: `CanvasTexture`
|
|
419
|
+
black, `flatShading` vs `roundedBox`, an uncalled render module, and four TSL post stages that
|
|
420
|
+
silently no-op (`SSRNode.maxDistance`, `reflectNonMetals`, a swizzled normal, a dangling
|
|
421
|
+
branch). Nothing in the toolchain can see your game — when you change something visual,
|
|
422
|
+
actually look at it before reporting it done.
|
|
338
423
|
|
|
339
424
|
## UI
|
|
340
425
|
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
The bridge is a throttled store, not a per-frame render:
|
|
426
|
+
**React never touches the scene graph** — no JSX for meshes, lights or cameras. `ctx.state.set()`
|
|
427
|
+
writes at loop rate and the bridge coalesces into a flush every ~100 ms, so per-frame feedback
|
|
428
|
+
belongs in scene-owned Three.js objects.
|
|
345
429
|
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
The start scene owns the initial state in `static initialState`; omit a duplicate
|
|
354
|
-
`initialState` literal from `defineGame`. Update only the fields that changed:
|
|
355
|
-
`ctx.state.set({ score })`.
|
|
356
|
-
|
|
357
|
-
`main.ts` calls `acceptHotUpdate(game, import.meta.hot)` for development reloads. The
|
|
358
|
-
framework preserves only JSON-shaped store state, so `Play.enter()` must seed entities
|
|
359
|
-
from the carried values such as `playerX`; the scene graph, physics world, audio voices,
|
|
360
|
-
particles, and renderer are rebuilt on every update.
|
|
361
|
-
The keyboard and React restart paths reset `Play.initialState` before rebuilding the scene.
|
|
430
|
+
Each scene owns its initial state in `static initialState`; omit a duplicate `initialState` literal
|
|
431
|
+
from `defineGame`. Update only the fields that changed:
|
|
432
|
+
`ctx.state.set({ score })`. Hot reload carries JSON-shaped store state only — seed entities
|
|
433
|
+
in `Play.enter()` from carried values such as `playerX`, because the scene graph, physics
|
|
434
|
+
world, audio voices, particles, and renderer are rebuilt on every update. The keyboard and
|
|
435
|
+
intent restart paths reset `Play.initialState` before rebuilding the scene.
|
|
362
436
|
|
|
363
437
|
## Register entities you want to inspect or test
|
|
364
438
|
|
|
@@ -372,79 +446,108 @@ guessing from pixels.
|
|
|
372
446
|
|
|
373
447
|
## Playtests
|
|
374
448
|
|
|
375
|
-
`playtests/survives.playtest.json` is the durable smoke proof
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
A scenario fails closed: a missing entity, an absent observation, or a scenario with no
|
|
383
|
-
assertions is a failure, never a quiet pass. When you add a feature, add the assertion that
|
|
384
|
-
would catch its absence, and run the scenario before reporting the feature works.
|
|
449
|
+
`playtests/survives.playtest.json` is the durable smoke proof — boot, diagnostics, a nonblank
|
|
450
|
+
frame, player movement — and stays green however far you replace the starter gameplay.
|
|
451
|
+
`playtests/goal.playtest.json` and `playtests/gameover.playtest.json` prove the win and fail
|
|
452
|
+
outcomes; rewrite that pair when you replace the win and fail conditions, keeping the pairing:
|
|
453
|
+
an outcome nothing asserts is an outcome that quietly stops happening. `odometer.playtest.json`
|
|
454
|
+
shows the deferred-motion pattern, and the remaining scenarios are examples you may delete or
|
|
455
|
+
rewrite.
|
|
385
456
|
|
|
457
|
+
<!-- shared: look-at-it-and-budget-the-look -->
|
|
386
458
|
## Budget real time for the look
|
|
387
459
|
|
|
388
460
|
Read this as an instruction about **where your effort goes**, not as a style tip.
|
|
389
461
|
|
|
390
462
|
Every automated gate in this project — `typecheck`, `lint`, `pnpm test`, every playtest
|
|
391
463
|
scenario — is blind to how the game looks. All of them pass on a game that is grey boxes on
|
|
392
|
-
a black screen.
|
|
393
|
-
screen and the gates will tell you that you succeeded.
|
|
394
|
-
|
|
395
|
-
So the rule here is: **a feature is not done when its assertion passes. It is done when you
|
|
464
|
+
a black screen. So: **a feature is not done when its assertion passes. It is done when you
|
|
396
465
|
have looked at it and it reads well.** Plan for roughly as much work on presentation as on
|
|
397
|
-
mechanics
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
2.
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
`
|
|
434
|
-
|
|
435
|
-
`
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
466
|
+
mechanics; it is the majority of what a player experiences and the part nothing else catches.
|
|
467
|
+
|
|
468
|
+
Before calling anything a player sees done: look at it (a screenshot you actually open, not
|
|
469
|
+
your own diff); break up silhouettes; give it depth with contact shadows and rim; make it move;
|
|
470
|
+
finish the HUD.
|
|
471
|
+
|
|
472
|
+
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
|
|
473
|
+
`npx @threenative/playtest <scenario> --browser-recipe webgpu --headed` (the recipe carries the
|
|
474
|
+
Chromium flags WebGPU needs including `--enable-features=Vulkan`; without it Chromium serves
|
|
475
|
+
SwiftShader and the runner fails the run with `TN_PLAYTEST_SOFTWARE_ADAPTER`); then ask the
|
|
476
|
+
user to look, saying what to check.
|
|
477
|
+
|
|
478
|
+
**Do not use `xvfb-run`:** its failing cleanup kill replaces the real exit status. And
|
|
479
|
+
**headless Chromium usually cannot render WebGPU** — if a screenshot comes back black or empty,
|
|
480
|
+
suspect the capture before you rewrite the scene.
|
|
481
|
+
|
|
482
|
+
The capture recipes, virtual-display setup, and the silhouette checklist are
|
|
483
|
+
`agent-docs/capture-the-frame.md`. When you think you are done: *would a player screenshot
|
|
484
|
+
this?* If no, you are not finished.
|
|
485
|
+
<!-- /shared -->
|
|
486
|
+
|
|
487
|
+
<!-- shared: pixel-budget -->
|
|
488
|
+
## The pixel budget is the engine's
|
|
489
|
+
|
|
490
|
+
`renderer.resolutionScale: "auto"` ships on. The engine scales the **3D drawing buffer only** —
|
|
491
|
+
never CSS, UI, camera or aspect — to hold `display.maxFps`. A Pixel 8 hands three.js 2400×1080 as
|
|
492
|
+
CSS pixels: 2.592 Mpx at a measured 9.94 ms/Mpx. Never hand-author that constant.
|
|
493
|
+
|
|
494
|
+
```ts
|
|
495
|
+
renderer: { resolutionScale: "auto", antialias: true,
|
|
496
|
+
android: { resolutionScale: 0.44, antialias: false } },
|
|
497
|
+
```
|
|
498
|
+
|
|
499
|
+
A number in `(0, 1]` pins it and stops the loop; `0`, negatives, `> 1` and `NaN` are refused by
|
|
500
|
+
name at config load, not at frame time. Pinning never stops the measurement: every
|
|
501
|
+
`TN_FRAME_BUDGET` window carries
|
|
502
|
+
`surface: { resolutionScale, scaleSource, sampleCount, drawingBufferWidth, drawingBufferHeight }`
|
|
503
|
+
in both modes, and `perf --text` prints it beside the fps. `scaleSource` is `pinned`, `auto`, or
|
|
504
|
+
`auto-pinned` (chose, then held rather than pump visibly); at the floor and still over budget it
|
|
505
|
+
reports `atFloor` instead of implying the budget was met. `antialias` overrides per-platform on
|
|
506
|
+
the same seam — a scaled buffer is upscaled, magnifying every aliased edge. Pass
|
|
507
|
+
`display: config.display` into `defineGame`, or the scaler assumes 60.
|
|
508
|
+
<!-- /shared -->
|
|
509
|
+
|
|
510
|
+
<!-- shared: performance-default -->
|
|
511
|
+
# Lightmaps
|
|
512
|
+
|
|
513
|
+
`assets.models.lightmap:{atlasSize,padding}` bakes static GLBs; load via `ctx.assets.model()`.
|
|
514
|
+
Remove it to roll back. Android/iOS reject KTX2; never claim them from web/desktop proof.
|
|
515
|
+
|
|
516
|
+
## Performance targets
|
|
517
|
+
|
|
518
|
+
Refill scratch; pool objects.
|
|
519
|
+
|
|
520
|
+
`TN_FRAME_BUDGET` reports `fps`/`hostGap`/`update`/`render`/`overlay`/`residual`;
|
|
521
|
+
`defineGame({ frameBudget: false })` silences output, never measurement.
|
|
522
|
+
|
|
523
|
+
Unexecuted platforms stay unverified; never-invent-numbers. Withdraw thermally-confounded Tiers 1–3 comparisons; always report Tier 4.
|
|
524
|
+
|
|
525
|
+
|Tier|Measure|Floor|Target|
|
|
526
|
+
|---|---|---:|---:|
|
|
527
|
+
|1|Starter/browser-desktop|60fps|display-refresh|
|
|
528
|
+
|1|Starter/browser-Android|30fps|58fps|
|
|
529
|
+
|1|Starter/native-desktop|60fps|display-refresh|
|
|
530
|
+
|1|Starter/native-Android|55fps|58fps|
|
|
531
|
+
|1|Starter/native-iOS|unverified|no-number|
|
|
532
|
+
|1|All-platform/hostGap-p95|—|≤4ms|
|
|
533
|
+
|1|All-platform/update-p95|—|≤2ms|
|
|
534
|
+
|1|All-platform/residual-p95|—|≤0.5ms|
|
|
535
|
+
|1|All-platform/overlay-p95|—|≤1ms|
|
|
536
|
+
|2|Same-device-fps-parity|.85|.95|
|
|
537
|
+
|2|Inverted-render-p95-parity|.80|.95|
|
|
538
|
+
|3|Light|55fps|58fps|
|
|
539
|
+
|3|Medium|30fps|58fps|
|
|
540
|
+
|3|Heavy|30fps|58fps|
|
|
541
|
+
|4|Sustained-duration|10min|10min|
|
|
542
|
+
|4|Final/opening-fps|.75|.90|
|
|
543
|
+
|4|Last-minute-heavy|25fps|50fps|
|
|
544
|
+
|4|Peak-battery-temperature|≤45C|≤40C|
|
|
545
|
+
|4|Thermal-status|≤2|≤1|
|
|
546
|
+
|4|Whole-device-current|—|report;not-gated|
|
|
547
|
+
|
|
548
|
+
`{"performance":{"maxFrameMsP95":33,"minFps":30,"maxPhaseMsP95":{"render":12}}}`
|
|
549
|
+
`agent-docs/assertion-reference.md#performance`
|
|
550
|
+
|
|
551
|
+
Pixel-8-memory: ~500MiB-driver-floor; dual-use-equirect adds-48MiB. Fix:
|
|
552
|
+
`agent-docs/mobile-memory-budget.md`.
|
|
553
|
+
<!-- /shared -->
|