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.
Files changed (343) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +10 -2
  3. package/agent-docs/asset-mcp-loop.md +33 -0
  4. package/agent-docs/ctx-surface.md +69 -0
  5. package/agent-docs/engine-capabilities.md +4 -0
  6. package/agent-docs/framework-blocks-you.md +60 -0
  7. package/agent-docs/look-at-it-and-budget-the-look.md +27 -0
  8. package/agent-docs/performance-default.md +42 -0
  9. package/agent-docs/pixel-budget.md +20 -0
  10. package/agent-docs/playtest-fail-closed.md +23 -0
  11. package/agent-docs/references/assertion-reference.md +652 -0
  12. package/agent-docs/references/capability-reference.md +3279 -0
  13. package/agent-docs/references/capture-the-frame.md +53 -0
  14. package/agent-docs/references/ctx-cookbook.md +51 -0
  15. package/agent-docs/references/debug-surface.md +63 -0
  16. package/agent-docs/references/finding-assets.md +147 -0
  17. package/agent-docs/references/gameplay-recipes.md +54 -0
  18. package/agent-docs/references/menu-screens.md +69 -0
  19. package/agent-docs/references/mobile-memory-budget.md +87 -0
  20. package/agent-docs/references/sculpt-from-a-reference.md +39 -0
  21. package/agent-docs/references/visual-baseline.md +133 -0
  22. package/agent-docs/references/webview-ui.md +113 -0
  23. package/agent-docs/sculpt-loop.md +16 -0
  24. package/agent-files/.agents/skills/threenative-builder/SKILL.md +7 -0
  25. package/agent-files/.agents/skills/threenative-verifier/SKILL.md +7 -0
  26. package/agent-files/.claude/agents/threenative-builder.md +7 -0
  27. package/agent-files/.claude/agents/threenative-verifier.md +7 -0
  28. package/agent-files/.threenative/agents/builder.md +32 -0
  29. package/agent-files/.threenative/agents/verifier.md +31 -0
  30. package/agent-files/AGENT-ROLES.md +26 -0
  31. package/capabilities.json +3542 -0
  32. package/dist/index.d.ts +191 -3
  33. package/dist/index.js +1707 -73
  34. package/dist/threenative.d.ts +9 -2
  35. package/dist/threenative.js +1825 -148
  36. package/package.json +30 -6
  37. package/template-assets/loading.ts +315 -0
  38. package/template-assets/patches/three@0.185.1.patch +287 -0
  39. package/templates/action-rpg/.codex/config.toml +15 -0
  40. package/templates/action-rpg/.mcp.json +6 -2
  41. package/templates/action-rpg/AGENTS.md +370 -6
  42. package/templates/action-rpg/CLAUDE.md +370 -6
  43. package/templates/action-rpg/index.html +0 -1
  44. package/templates/action-rpg/package.json +15 -11
  45. package/templates/action-rpg/playtests/combat.playtest.json +23 -9
  46. package/templates/action-rpg/playtests/fail.playtest.json +3 -3
  47. package/templates/action-rpg/playtests/inventory.playtest.json +16 -10
  48. package/templates/action-rpg/playtests/performance.playtest.json +22 -0
  49. package/templates/action-rpg/playtests/progress.playtest.json +18 -13
  50. package/templates/action-rpg/playtests/win.playtest.json +10 -4
  51. package/templates/action-rpg/public/icon.png +0 -0
  52. package/templates/action-rpg/src/entities/Enemy.ts +14 -4
  53. package/templates/action-rpg/src/game.ts +21 -0
  54. package/templates/action-rpg/src/render/lighting.ts +6 -1
  55. package/templates/action-rpg/src/render/loading.ts +267 -42
  56. package/templates/action-rpg/src/render/postprocessing.ts +68 -15
  57. package/templates/action-rpg/src/render/worldEnvironment.ts +583 -0
  58. package/templates/action-rpg/src/scenes/Play.ts +49 -19
  59. package/templates/action-rpg/src/state.ts +4 -0
  60. package/templates/action-rpg/src/style.css +45 -1
  61. package/templates/action-rpg/src/ui/AbilityBar.tsx +9 -7
  62. package/templates/action-rpg/src/ui/App.tsx +9 -8
  63. package/templates/action-rpg/src/ui/CharacterPanel.tsx +10 -8
  64. package/templates/action-rpg/src/ui/GameUi.tsx +24 -0
  65. package/templates/action-rpg/src/ui/Hud.tsx +10 -8
  66. package/templates/action-rpg/src/ui/InventoryPanel.tsx +9 -7
  67. package/templates/action-rpg/src/ui/main.tsx +14 -0
  68. package/templates/action-rpg/threenative.config.ts +21 -8
  69. package/templates/action-rpg/vite.config.ts +32 -2
  70. package/templates/defense/.codex/config.toml +15 -0
  71. package/templates/defense/.mcp.json +6 -2
  72. package/templates/defense/AGENTS.md +371 -8
  73. package/templates/defense/CLAUDE.md +371 -8
  74. package/templates/defense/README.md +2 -1
  75. package/templates/defense/index.html +0 -1
  76. package/templates/defense/package.json +16 -12
  77. package/templates/defense/playtests/leak.playtest.json +9 -4
  78. package/templates/defense/playtests/performance.playtest.json +22 -0
  79. package/templates/defense/playtests/placement.playtest.json +5 -5
  80. package/templates/defense/playtests/pointer-placement.playtest.json +89 -0
  81. package/templates/defense/playtests/scan.playtest.json +3 -3
  82. package/templates/defense/playtests/survive.playtest.json +11 -6
  83. package/templates/defense/public/icon.png +0 -0
  84. package/templates/defense/src/attackers/Attacker.ts +28 -12
  85. package/templates/defense/src/game.ts +24 -2
  86. package/templates/defense/src/render/lighting.ts +6 -1
  87. package/templates/defense/src/render/loading.ts +263 -37
  88. package/templates/defense/src/render/postprocessing.ts +70 -13
  89. package/templates/defense/src/render/shapes.ts +38 -0
  90. package/templates/defense/src/render/worldEnvironment.ts +583 -0
  91. package/templates/defense/src/scenes/Defense.ts +109 -50
  92. package/templates/defense/src/state.ts +6 -0
  93. package/templates/defense/src/style.css +45 -1
  94. package/templates/defense/src/ui/App.tsx +9 -4
  95. package/templates/defense/src/ui/GameUi.tsx +20 -0
  96. package/templates/defense/src/ui/Hud.tsx +6 -5
  97. package/templates/defense/src/ui/main.tsx +14 -0
  98. package/templates/defense/threenative.config.ts +21 -8
  99. package/templates/defense/vite.config.ts +34 -1
  100. package/templates/minimal/.codex/config.toml +15 -0
  101. package/templates/minimal/.mcp.json +6 -2
  102. package/templates/minimal/AGENTS.md +360 -255
  103. package/templates/minimal/CLAUDE.md +360 -255
  104. package/templates/minimal/index.html +0 -1
  105. package/templates/minimal/package.json +14 -11
  106. package/templates/minimal/playtests/atmosphere.playtest.json +32 -0
  107. package/templates/minimal/playtests/play.playtest.json +17 -5
  108. package/templates/minimal/public/icon.png +0 -0
  109. package/templates/minimal/src/game.ts +1 -0
  110. package/templates/minimal/src/render/camera.ts +1 -1
  111. package/templates/minimal/src/render/hud.ts +24 -8
  112. package/templates/minimal/src/render/lighting.ts +23 -2
  113. package/templates/minimal/src/render/loading.ts +23 -103
  114. package/templates/minimal/src/render/postprocessing.ts +92 -14
  115. package/templates/minimal/src/render/sky.ts +37 -32
  116. package/templates/minimal/src/render/worldEnvironment.ts +583 -0
  117. package/templates/minimal/src/scenes/Play.ts +91 -13
  118. package/templates/minimal/src/state.ts +8 -1
  119. package/templates/minimal/threenative.config.ts +15 -10
  120. package/templates/minimal/vite.config.ts +28 -1
  121. package/templates/platformer/.codex/config.toml +15 -0
  122. package/templates/platformer/.mcp.json +6 -2
  123. package/templates/platformer/AGENTS.md +385 -130
  124. package/templates/platformer/CLAUDE.md +385 -130
  125. package/templates/platformer/index.html +0 -1
  126. package/templates/platformer/package.json +17 -14
  127. package/templates/platformer/playtests/avoidance.playtest.json +6 -1
  128. package/templates/platformer/playtests/branding.playtest.json +29 -0
  129. package/templates/platformer/playtests/buffer.playtest.json +1 -1
  130. package/templates/platformer/playtests/collect.playtest.json +1 -1
  131. package/templates/platformer/playtests/collision-layers.playtest.json +2 -2
  132. package/templates/platformer/playtests/coyote.playtest.json +42 -8
  133. package/templates/platformer/playtests/damage.playtest.json +4 -1
  134. package/templates/platformer/playtests/dash.playtest.json +2 -2
  135. package/templates/platformer/playtests/jump.playtest.json +2 -3
  136. package/templates/platformer/playtests/native/touch-controls.playtest.json +33 -0
  137. package/templates/platformer/playtests/oneway.playtest.json +1 -1
  138. package/templates/platformer/playtests/performance.playtest.json +6 -5
  139. package/templates/platformer/playtests/respawn.playtest.json +2 -2
  140. package/templates/platformer/playtests/stomp-rise.playtest.json +17 -3
  141. package/templates/platformer/playtests/stomp.playtest.json +11 -3
  142. package/templates/platformer/playtests/terminal-loop-fail.playtest.json +13 -4
  143. package/templates/platformer/playtests/terminal-loop-win.playtest.json +3 -3
  144. package/templates/platformer/playtests/touch-controls-web.playtest.json +46 -0
  145. package/templates/platformer/public/icon.png +0 -0
  146. package/templates/platformer/src/entities/Character.ts +16 -10
  147. package/templates/platformer/src/entities/Patrol.ts +5 -0
  148. package/templates/platformer/src/game.ts +24 -1
  149. package/templates/platformer/src/render/lighting.ts +6 -1
  150. package/templates/platformer/src/render/loading.ts +270 -61
  151. package/templates/platformer/src/render/postprocessing.ts +68 -15
  152. package/templates/platformer/src/render/touch-controls.ts +54 -36
  153. package/templates/platformer/src/render/worldEnvironment.ts +583 -0
  154. package/templates/platformer/src/scenes/Level.ts +47 -22
  155. package/templates/platformer/src/state.ts +4 -0
  156. package/templates/platformer/src/style.css +45 -1
  157. package/templates/platformer/src/ui/App.tsx +9 -4
  158. package/templates/platformer/src/ui/GameUi.tsx +20 -0
  159. package/templates/platformer/src/ui/Hud.tsx +6 -5
  160. package/templates/platformer/src/ui/main.tsx +14 -0
  161. package/templates/platformer/threenative.config.ts +20 -10
  162. package/templates/platformer/vite.config.ts +34 -1
  163. package/templates/racing/.codex/config.toml +15 -0
  164. package/templates/racing/.mcp.json +6 -2
  165. package/templates/racing/AGENTS.md +370 -6
  166. package/templates/racing/CLAUDE.md +370 -6
  167. package/templates/racing/index.html +0 -1
  168. package/templates/racing/package.json +16 -12
  169. package/templates/racing/playtests/boost.playtest.json +5 -5
  170. package/templates/racing/playtests/outcome.playtest.json +14 -4
  171. package/templates/racing/playtests/performance.playtest.json +22 -0
  172. package/templates/racing/playtests/ranking.playtest.json +2 -2
  173. package/templates/racing/playtests/rescue.playtest.json +12 -6
  174. package/templates/racing/playtests/reverse.playtest.json +3 -3
  175. package/templates/racing/playtests/shortcut.playtest.json +3 -3
  176. package/templates/racing/public/icon.png +0 -0
  177. package/templates/racing/src/game.ts +24 -1
  178. package/templates/racing/src/render/camera.ts +10 -6
  179. package/templates/racing/src/render/lighting.ts +6 -1
  180. package/templates/racing/src/render/loading.ts +291 -34
  181. package/templates/racing/src/render/postprocessing.ts +70 -13
  182. package/templates/racing/src/render/worldEnvironment.ts +583 -0
  183. package/templates/racing/src/scenes/Race.ts +68 -36
  184. package/templates/racing/src/state.ts +4 -0
  185. package/templates/racing/src/style.css +45 -1
  186. package/templates/racing/src/track/Lap.ts +20 -9
  187. package/templates/racing/src/track/Ranking.ts +53 -14
  188. package/templates/racing/src/track/Track.ts +29 -16
  189. package/templates/racing/src/track/TrackSector.ts +14 -4
  190. package/templates/racing/src/ui/App.tsx +9 -4
  191. package/templates/racing/src/ui/GameUi.tsx +20 -0
  192. package/templates/racing/src/ui/Hud.tsx +6 -5
  193. package/templates/racing/src/ui/main.tsx +14 -0
  194. package/templates/racing/threenative.config.ts +21 -8
  195. package/templates/racing/vite.config.ts +34 -1
  196. package/templates/sailing/.codex/config.toml +15 -0
  197. package/templates/sailing/.mcp.json +20 -0
  198. package/templates/sailing/AGENTS.md +388 -0
  199. package/templates/sailing/CLAUDE.md +390 -0
  200. package/templates/sailing/README.md +25 -0
  201. package/templates/sailing/index.html +12 -0
  202. package/templates/sailing/kit.json +7 -0
  203. package/templates/sailing/native-playtests/survives.playtest.json +21 -0
  204. package/templates/sailing/package.json +52 -0
  205. package/templates/sailing/playtests/fail.playtest.json +24 -0
  206. package/templates/sailing/playtests/performance.playtest.json +21 -0
  207. package/templates/sailing/playtests/survives.playtest.json +38 -0
  208. package/templates/sailing/playtests/win.playtest.json +31 -0
  209. package/templates/sailing/public/favicon.svg +5 -0
  210. package/templates/sailing/public/icon.png +0 -0
  211. package/templates/sailing/src/entities/Ship.ts +96 -0
  212. package/templates/sailing/src/game.ts +40 -0
  213. package/templates/sailing/src/main.ts +15 -0
  214. package/templates/sailing/src/render/camera.ts +21 -0
  215. package/templates/sailing/src/render/lighting.ts +36 -0
  216. package/templates/sailing/src/render/loading.ts +315 -0
  217. package/templates/sailing/src/render/materials.ts +28 -0
  218. package/templates/sailing/src/render/palette.ts +24 -0
  219. package/templates/sailing/src/render/postprocessing.ts +33 -0
  220. package/templates/sailing/src/render/props.ts +52 -0
  221. package/templates/sailing/src/render/sky.ts +32 -0
  222. package/templates/sailing/src/render/water-material.ts +14 -0
  223. package/templates/sailing/src/render/water-shaders.ts +12 -0
  224. package/templates/sailing/src/render/wave-nodes.ts +10 -0
  225. package/templates/sailing/src/render/worldEnvironment.ts +590 -0
  226. package/templates/sailing/src/scenes/Boot.ts +12 -0
  227. package/templates/sailing/src/scenes/Sailing.ts +106 -0
  228. package/templates/sailing/src/state.ts +10 -0
  229. package/templates/sailing/src/style.css +61 -0
  230. package/templates/sailing/src/ui/App.tsx +15 -0
  231. package/templates/sailing/src/ui/GameUi.tsx +12 -0
  232. package/templates/sailing/src/ui/Hud.tsx +55 -0
  233. package/templates/sailing/src/ui/Menu.tsx +30 -0
  234. package/templates/sailing/src/ui/main.tsx +7 -0
  235. package/templates/sailing/tailwind.config.ts +2 -0
  236. package/templates/sailing/threenative.config.ts +34 -0
  237. package/templates/sailing/tsconfig.json +17 -0
  238. package/templates/sailing/vite.config.ts +34 -0
  239. package/templates/shooter/.codex/config.toml +15 -0
  240. package/templates/shooter/.mcp.json +6 -2
  241. package/templates/shooter/AGENTS.md +373 -7
  242. package/templates/shooter/CLAUDE.md +373 -7
  243. package/templates/shooter/index.html +0 -1
  244. package/templates/shooter/package.json +16 -11
  245. package/templates/shooter/playtests/fail.playtest.json +5 -4
  246. package/templates/shooter/playtests/input-control.playtest.json +131 -0
  247. package/templates/shooter/playtests/per-item.playtest.json +59 -0
  248. package/templates/shooter/playtests/performance.playtest.json +22 -0
  249. package/templates/shooter/playtests/shooter.playtest.json +22 -18
  250. package/templates/shooter/playtests/survives.playtest.json +1 -1
  251. package/templates/shooter/public/favicon.svg +1 -1
  252. package/templates/shooter/public/icon.png +0 -0
  253. package/templates/shooter/src/game.ts +24 -1
  254. package/templates/shooter/src/main.ts +3 -13
  255. package/templates/shooter/src/render/camera.ts +62 -12
  256. package/templates/shooter/src/render/lighting.ts +6 -1
  257. package/templates/shooter/src/render/loading.ts +262 -33
  258. package/templates/shooter/src/render/palette.ts +1 -1
  259. package/templates/shooter/src/render/postprocessing.ts +68 -16
  260. package/templates/shooter/src/render/shapes.ts +178 -0
  261. package/templates/shooter/src/render/ui.css +34 -1
  262. package/templates/shooter/src/render/worldEnvironment.ts +583 -0
  263. package/templates/shooter/src/scenes/Play.ts +246 -73
  264. package/templates/shooter/src/state.ts +13 -0
  265. package/templates/shooter/src/style.css +26 -0
  266. package/templates/shooter/src/ui/App.tsx +10 -12
  267. package/templates/shooter/src/ui/GameUi.tsx +20 -0
  268. package/templates/shooter/src/ui/Hud.tsx +8 -10
  269. package/templates/shooter/src/ui/Menu.tsx +24 -9
  270. package/templates/shooter/src/ui/main.tsx +15 -0
  271. package/templates/shooter/src/weapons/Projectile.ts +21 -10
  272. package/templates/shooter/threenative.config.ts +21 -8
  273. package/templates/shooter/vite.config.ts +32 -2
  274. package/templates/starter/.codex/config.toml +15 -0
  275. package/templates/starter/.mcp.json +6 -2
  276. package/templates/starter/AGENTS.md +429 -326
  277. package/templates/starter/CLAUDE.md +429 -326
  278. package/templates/starter/assets/pickup.wav +0 -0
  279. package/templates/starter/gitignore +4 -0
  280. package/templates/starter/index.html +0 -1
  281. package/templates/starter/native-playtests/react-hud.playtest.json +20 -0
  282. package/templates/starter/native-playtests/render-chain.playtest.json +12 -0
  283. package/templates/starter/package.json +16 -12
  284. package/templates/starter/playtests/assets.playtest.json +65 -0
  285. package/templates/starter/playtests/buffer.playtest.json +59 -9
  286. package/templates/starter/playtests/cloth.playtest.json +113 -0
  287. package/templates/starter/playtests/coyote.playtest.json +60 -8
  288. package/templates/starter/playtests/forward.playtest.json +29 -4
  289. package/templates/starter/playtests/gameover.playtest.json +66 -0
  290. package/templates/starter/playtests/goal.playtest.json +67 -0
  291. package/templates/starter/playtests/hot-reload.playtest.json +48 -8
  292. package/templates/starter/playtests/look.playtest.json +34 -6
  293. package/templates/starter/playtests/models-baseline.png +0 -0
  294. package/templates/starter/playtests/models.playtest.json +74 -0
  295. package/templates/starter/playtests/monitoring.playtest.json +38 -7
  296. package/templates/starter/playtests/odometer.playtest.json +54 -0
  297. package/templates/starter/playtests/pause.playtest.json +27 -4
  298. package/templates/starter/playtests/play.playtest.json +43 -7
  299. package/templates/starter/playtests/respawn.playtest.json +46 -6
  300. package/templates/starter/playtests/restart.playtest.json +65 -10
  301. package/templates/starter/playtests/seed.playtest.json +44 -8
  302. package/templates/starter/playtests/survives.playtest.json +27 -4
  303. package/templates/starter/playtests/textures-baseline.png +0 -0
  304. package/templates/starter/playtests/textures.playtest.json +74 -0
  305. package/templates/starter/playtests/zoom-pinch.playtest.json +86 -0
  306. package/templates/starter/playtests/zoom-wheel.playtest.json +59 -0
  307. package/templates/starter/public/icon.png +0 -0
  308. package/templates/starter/src/entities/Goal.ts +122 -0
  309. package/templates/starter/src/entities/Player.ts +40 -2
  310. package/templates/starter/src/game.ts +25 -0
  311. package/templates/starter/src/render/camera.ts +31 -5
  312. package/templates/starter/src/render/easing.ts +5 -0
  313. package/templates/starter/src/render/effects/gradualBackground.ts +48 -0
  314. package/templates/starter/src/render/effects/lensDistortion.ts +43 -0
  315. package/templates/starter/src/render/effects/sparkle.ts +49 -0
  316. package/templates/starter/src/render/lighting.ts +6 -1
  317. package/templates/starter/src/render/loading.ts +315 -0
  318. package/templates/starter/src/render/materials.ts +17 -1
  319. package/templates/starter/src/render/pennant.ts +54 -0
  320. package/templates/starter/src/render/postprocessing.ts +46 -15
  321. package/templates/starter/src/render/scenery.ts +83 -0
  322. package/templates/starter/src/render/shapes.ts +9 -21
  323. package/templates/starter/src/render/worldEnvironment.ts +583 -0
  324. package/templates/starter/src/scenes/Play.ts +146 -36
  325. package/templates/starter/src/state.ts +12 -0
  326. package/templates/starter/src/style.css +45 -1
  327. package/templates/starter/src/ui/App.tsx +9 -6
  328. package/templates/starter/src/ui/GameUi.tsx +20 -0
  329. package/templates/starter/src/ui/Hud.tsx +52 -29
  330. package/templates/starter/src/ui/Menu.tsx +25 -23
  331. package/templates/starter/src/ui/main.tsx +14 -0
  332. package/templates/starter/threenative.config.ts +27 -9
  333. package/templates/starter/tools/look.mjs +109 -0
  334. package/templates/starter/vite.config.ts +32 -2
  335. package/templates/minimal/assets/.gitkeep +0 -0
  336. package/templates/minimal/public/.gitkeep +0 -0
  337. package/templates/platformer/assets/.gitkeep +0 -0
  338. package/templates/platformer/public/.gitkeep +0 -0
  339. package/templates/starter/assets/.gitkeep +0 -0
  340. package/templates/starter/public/.gitkeep +0 -0
  341. package/templates/starter/public/pickup.ogg +0 -0
  342. /package/templates/starter/{public → assets}/native-proof.glb +0 -0
  343. /package/templates/starter/{public → assets}/native-proof.png +0 -0
@@ -14,6 +14,69 @@ scene lifecycle, input mapping, asset loading, the physics binding, and the stat
14
14
  ordinary code in this repository. Nothing in `@threenative/*` reads them. Rewrite or delete
15
15
  any of it.
16
16
 
17
+ <!-- shared: framework-blocks-you -->
18
+ ### Before you write a system, ask what already exists
19
+
20
+ You have `engine_search_capabilities`. Discovery is required before planning:
21
+
22
+ 1. Infer concrete mechanics from the request: world, traversal, interaction, simulation, combat,
23
+ camera, audio, and UI. Preserve its distinctive fantasy with the smallest loop using its
24
+ characteristic setting or traversal—not a generic game with themed props. Search implied
25
+ mechanics even when the user omits engine terms. Ask one short question only when two core loops
26
+ remain equally plausible.
27
+ 2. Search the full mechanical request with `scope: "request"`, then every mechanic with
28
+ `scope: "mechanic"`. Check each returned `matchedSituation`.
29
+ 3. Before writing replacements, record a capability or no-match for every mechanic.
30
+
31
+ Repeat before writing entity, movement, navigation, attachment, audio, particle, simulation,
32
+ terrain, or measurement systems. Describe situations plainly: *"enemy walks around a wall"*.
33
+
34
+ The manifest is the complete public surface; grep misses unused subpath exports such as
35
+ `@threenative/physics/navigation`. If MCP is unavailable, run doctor and search
36
+ `agent-docs/capability-reference.md` per mechanic.
37
+
38
+ Constraints are binding. Import navigation symbols from the returned subpath. Use `attachToBone`
39
+ for held weapons; if needed, add a portable Three.js `Bone` named `RightHand` first. Capability
40
+ detail governs platform support: never invent limits it does not report. Reject only for a reported
41
+ constraint or a contract that does not fit.
42
+
43
+ This prevents reimplementing installed systems; one game did so in 446 lines and ran at 9 FPS.
44
+
45
+ ## When the framework blocks you, write plain Three.js
46
+
47
+ For browser, blank-frame, device, or import failures, first run `npx threenative doctor` and
48
+ `npx @threenative/playtest doctor`. They separate project/machine failures from engine bugs. For a
49
+ running game that looks wrong, inspect it:
50
+
51
+ ```sh
52
+ npx @threenative/playtest doctor --url http://127.0.0.1:5173 --text
53
+ ```
54
+
55
+ This reports visibility, scale, draw cost, frame rate, advancing state, and errors. Missing output
56
+ means unobserved, never zero.
57
+
58
+ When an `@threenative/*` API is broken, missing, or does not do what you need, implement only that
59
+ piece with portable Three.js/plain code and continue:
60
+
61
+ 1. Keep the existing loop, scenes, input, registry, and playtest bridge.
62
+ 2. Avoid `document`, `window`, `localStorage`, dynamic `import()`, and raw physics handles.
63
+ 3. **Report what blocked you**: API, expectation, result, and replacement.
64
+
65
+ Never stall on a framework bug.
66
+
67
+ ### Where the long recipes live
68
+
69
+ Open the relevant shipped recipe when needed:
70
+
71
+ - `agent-docs/finding-assets.md` — asset search, licenses, downloads, and archives.
72
+ - `agent-docs/sculpt-from-a-reference.md` — sculpt gates and branches.
73
+ - `agent-docs/webview-ui.md` — UI state, intents, and hit regions.
74
+ - `agent-docs/capture-the-frame.md` — WebGPU screenshots.
75
+ - `agent-docs/ctx-cookbook.md` — raycasts, rebuilds, and seeded randomness.
76
+ - `agent-docs/gameplay-recipes.md` — movement, gamepads, and physics timing.
77
+ - `agent-docs/visual-baseline.md` — generated render-source conventions.
78
+ <!-- /shared -->
79
+
17
80
  ## Commands
18
81
 
19
82
  ```sh
@@ -30,14 +93,43 @@ ship Android or iOS until signed prebuilt runtime assets and their checksum mani
30
93
  so those targets fail closed for consumers. Linux desktop is source-machine evidence, not a
31
94
  clean-machine distribution proof; macOS, Windows, iOS, and physical hardware remain OPEN.
32
95
 
96
+ ## Playtest assertions
97
+
98
+ <!-- shared: playtest-fail-closed -->
99
+ ## Playtests fail closed
100
+
101
+ A scenario fails closed: a missing entity, an absent observation, or a scenario with no
102
+ assertions is a failure, never a quiet pass. When you add a feature, add the assertion that
103
+ would catch its absence, and run the scenario before reporting the feature works.
104
+
105
+ Every `allowTrivial` waiver must be a reason string with at least 20 non-whitespace characters
106
+ explaining why the initial value is intentionally held; `allowTrivial: true` is invalid. A
107
+ scenario whose every triviality-eligible assertion is waived fails with
108
+ `TN_PLAYTEST_SCENARIO_ASSERTS_NOTHING`, so keep an independent assertion in the scenario.
109
+
110
+ Steps count fixed-step ticks, not milliseconds — use `holdTicks` and `waitTicks`. The deprecated
111
+ `holdFrames` and `waitFrames` aliases remain accepted for compatibility and are treated as ticks
112
+ on a fixed-step bridge; `warmupFrames` remains a genuine requestAnimationFrame warmup.
113
+
114
+ The assertion vocabulary — every kind the validator accepts, its fields, and when to reach for
115
+ it — is generated into `agent-docs/assertion-reference.md`; open it before inventing a new
116
+ assertion shape. To probe a running game by hand, every bridge global and its shape is
117
+ documented in `agent-docs/debug-surface.md`.
118
+
119
+ The bridge registers exactly one resource id for the JSON-safe game state: `state`; resource
120
+ paths address fields from `ctx.state`. (`GameState` is a deprecated compatibility alias kept
121
+ until published scenarios migrate.)
122
+ <!-- /shared -->
123
+
33
124
  ## Keep the game portable to native
34
125
 
35
126
  `pnpm build --target desktop` runs this same source on a native host with **no browser**.
36
127
  Three things break there, and none of them fail on the web build:
37
128
 
38
- 1. **No real DOM.** `document` exists only as a Three.js compatibility stub. The accessible
39
- DOM score in `main.ts` remains a web convenience; the generated `src/render/hud.ts` is
40
- camera-parented Three.js geometry, so its score, counter and clock run with the game.
129
+ 1. **No real DOM.** `document` exists only as a Three.js compatibility stub, so anything drawn
130
+ through it — a DOM chip, a React HUD, a CSS loading screen — is invisible natively. This
131
+ template draws no DOM readout for that reason: `src/render/hud.ts` is camera-parented
132
+ Three.js geometry, so its score, counter and clock run with the game everywhere.
41
133
  2. **No dynamic `import()` and no `window.localStorage` reach.** The native build is one
42
134
  bundled file; save games go through your own JSON via `ctx.state`.
43
135
  3. **`.raw` is web-only.** `ctx.physics.world.raw` is a Rapier object in the browser and
@@ -48,27 +140,12 @@ without thinking about it. If you only ever ship to the web, ignore this section
48
140
 
49
141
  ## The layout
50
142
 
51
- ```mermaid
52
- flowchart TD
53
- project["generated project"]
54
- src["src/"]
55
- main["main.ts<br/>defineGame(...) + accessible web DOM score"]
56
- play["scenes/Play.ts<br/>gameplay: load, enter, update, exit"]
57
- player["entities/Player.ts<br/>plain class, not an ECS"]
58
- render["render/<br/>palette, camera, lighting, HUD geometry,<br/>materials, post — YOURS"]
59
- state["state.ts<br/>state shape gameplay publishes"]
60
- playtest["playtests/survives.playtest.json<br/>durable smoke proof, run by pnpm test"]
61
- config["threenative.config.ts<br/>app identity, icon, display, desktop window, renderer"]
62
-
63
- project --> src
64
- src --> main
65
- src --> play
66
- src --> player
67
- src --> render
68
- src --> state
69
- project --> playtest
70
- project --> config
71
- ```
143
+ `src/main.ts` boots the game and mounts its canvas, deliberately without a DOM score;
144
+ `src/scenes/Play.ts` is the gameplay
145
+ (load, enter, update, exit); `src/entities/Player.ts` is a plain class, not an ECS;
146
+ `src/render/` is your look including the camera-parented HUD geometry; `state.ts` holds the
147
+ shape gameplay publishes; `playtests/survives.playtest.json` is the durable smoke proof run by
148
+ `pnpm test`.
72
149
 
73
150
  `threenative.config.ts` is the one game-owned app-shape file. Set the launcher identity and
74
151
  icon, mobile orientation and display flags, desktop window, renderer preference, and native
@@ -84,204 +161,197 @@ pointer-action mapping when the core multitouch surface from PRD-053 is availabl
84
161
  ## How to write gameplay here
85
162
 
86
163
  A scene is a class with optional `load`, `enter`, `update`, `exit`, and `render`. That is
87
- the whole lifecycle — there is nothing else to register.
88
-
89
- `ctx` hands you real Three.js objects and backend-neutral physics handles:
90
-
91
- ```ts
92
- ctx.scene // THREE.Scene
93
- ctx.camera // THREE.PerspectiveCamera
94
- ctx.renderer // the renderer
95
- ctx.physics.world // PhysicsWorldHandle
96
- player.body // PhysicsBodyHandle (via CharacterBody3D)
97
- player.mesh // THREE.Mesh
98
- ```
99
-
100
- The physics handles expose `.raw` as an explicitly backend-specific escape hatch: Rapier on
101
- web, opaque on native. Code that reads `.raw` is not portable between those targets.
164
+ the whole lifecycle — there is nothing else to register. `ctx` hands you real Three.js objects
165
+ (`ctx.scene`, `ctx.camera`, `ctx.renderer`) and backend-neutral physics handles
166
+ (`ctx.physics.world`, `player.body`, `player.mesh`). The handles expose `.raw` as an explicitly
167
+ backend-specific escape hatch: Rapier on web, opaque on native. Code that reads `.raw` is not
168
+ portable between those targets.
102
169
 
103
170
  Any Three.js tutorial, StackOverflow answer, or snippet you already know works unchanged
104
171
  inside a scene. Prefer that over hunting for a framework wrapper — **for anything Three.js
105
172
  itself does (geometry, materials, lights, math), there is no wrapper and you should write
106
173
  the Three.js.** The exception is the loop: scene changes, timers and tweens are on `ctx`,
107
174
  not in an import, so grepping the imports of an existing file will not find them. The
108
- table below is the complete list.
175
+ ctx-only table is followed by the public core-and-physics capability index; call
176
+ `engine_search_capabilities` for imports.
109
177
 
110
178
  Physics uses Godot's names: `RigidBody3D`, `Area3D`, `CharacterBody3D`, `CollisionShape3D`.
111
179
  Every node has `dispose()`. Register disposable entities with `ctx.entities`; the framework
112
- clears registered entities, scene objects, and physics nodes when a scene exits. Dispose a
113
- node explicitly only when removing it during play. **The id is the name a scenario resolves.** A playtest `subject`, and every `movement` or
114
- `visibility` assertion, looks the entity up by that string — an unregistered player fails
115
- `TN_PLAYTEST_VISIBILITY_FAILED` however visible it is on screen.
180
+ clears them when a scene exits. **The id is the name a scenario resolves** — an unregistered
181
+ player fails `TN_PLAYTEST_VISIBILITY_FAILED` however visible it is on screen.
116
182
 
117
183
  `input.vector("move").y` is +up; map it to world-space -z for forward with one explicit
118
184
  `-move.y` conversion in the player movement code.
119
185
 
120
- `CharacterBody3D.moveAndSlide(dt)` owns gravity through `body.velocity`; keep coyote time
121
- and the jump buffer in `src/entities/Player.ts` so the two templates teach the same motion
122
- API.
186
+ Gamepad bindings and their deadzone trap, the deferred `moveAndSlide(dt)` step-timing rule,
187
+ and save/load snippets live in `agent-docs/gameplay-recipes.md`.
123
188
 
189
+ <!-- shared: ctx-surface -->
124
190
  ## The `ctx` surface — you already have these, do not rebuild them
125
191
 
126
- `ctx` carries six things that get reimplemented by hand in almost every project, because
192
+ `ctx` carries seven things that get reimplemented by hand in almost every project, because
127
193
  they are **properties on `ctx`, never imports** — grepping an existing file's imports will
128
- never surface them. This table is the complete list.
194
+ never surface them. This table covers only the `ctx` properties; call
195
+ `engine_search_capabilities` for imports. The recipes behind this table live in
196
+ `agent-docs/ctx-cookbook.md`.
129
197
 
130
198
  | You already have | Rather than | Signature |
131
199
  |---|---|---|
132
- | `ctx.goto("play")` | a hand-written `#reset()` | `(name: string) => Promise<void>` |
133
- | `ctx.tween(obj, { y: 2 }, 0.4)` | a `Math.sin` / `lerp` accumulator | `(target, props, seconds) => Promise<void>` |
200
+ | `ctx.goto("<scene-name>")` | a hand-written `#reset()` | `(name: string) => Promise<void>` |
201
+ | `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 |
134
202
  | `ctx.after(0.8, fn)` | `elapsed += dt; if (elapsed > 0.8)` | `(seconds, cb) => ScheduleHandle` |
135
203
  | `ctx.every(fn)` | a per-frame branch in `update` | `(cb: (dt: number) => void) => ScheduleHandle` |
136
- | `ctx.random.range(-1, 1)` | `Math.random()` | seeded — a replay produces identical results |
137
- | `ctx.raycast()` | `new Raycaster()` + `intersectObject` | `(options?: { screen?, targets? }) => Intersection \| undefined` |
138
-
139
- **`ctx.raycast()` is how you pick geometry under the pointer.** It defaults to the current
140
- pointer position and the whole scene, returns the nearest `THREE.Intersection`, and stays
141
- under a millisecond on meshes large enough that a plain `Raycaster` visibly stutters — it
142
- keeps an acceleration structure per geometry and rebuilds it when that geometry's positions
143
- change. Pass `{ targets }` to narrow it, `{ screen }` to test a point that is not the
144
- pointer. Skinned, instanced and morphed meshes fall back to the stock Three.js path
145
- automatically, so the result always matches `Raycaster.intersectObject`.
204
+ | `ctx.random.range(-1, 1)` | `Math.random()` | deterministic when `seed` is configured; otherwise `Math.random()` |
205
+ | `ctx.pointer.on(...)` / `ctx.pointer.drag(...)` | hand-written hover, press, tap, and drag state | `(object, type, listener) => disposer` / `(object) => IPointerDragHandle` |
206
+ | `ctx.raycast()` / `ctx.raycastAll()` | `new Raycaster()` + `intersectObject(s)` | `(options?: { screen?, origin?, direction?, far?, targets?, exclude? }) => Intersection \| undefined` / `readonly Intersection[]` |
146
207
 
147
- **`ctx.goto(name)` restarts the current scene.** Calling `ctx.goto("play")` from inside
148
- `Play` tears the scene down and rebuilds it: `exit()` runs, scheduled callbacks are cleared,
149
- registered entities are cleared, the Three scene is emptied, then a fresh instance runs
150
- `load()` and `enter()`. That is your entire restart button, and your entire death-and-retry.
208
+ `ctx.pointer` dispatches `pointerEntered`, `pointerExited`, `pointerPressed`, `pointerReleased`,
209
+ `tapped`, `dragStarted`, `dragged`, and `dragEnded` from the same pointer-id stream on web and
210
+ native. Register a mesh or model root; only registered objects are raycast, and events bubble
211
+ through the parent chain.
151
212
 
152
- Do **not** write a `#reset()` that walks your entities putting them back. It is ~15 lines
153
- that look right and quietly miss the scheduler and anything you spawned after `enter()`, so
154
- the second playthrough behaves differently from the first — and no gate in this project will
155
- catch that.
213
+ Three rules are load-bearing enough to stay here:
156
214
 
157
- **One rule when calling it from a frame function: `goto` and then `return`, immediately.**
215
+ - **`ctx.goto(name)` rebuilds the scene without resetting game state.** Values in `ctx.state`
216
+ survive the rebuild; reset your own state explicitly when death-and-retry should start
217
+ fresh:
158
218
 
159
219
  ```ts
160
220
  if (player.dead) {
161
- void ctx.goto("play");
162
- return; // ← required. Everything below now runs against a torn-down scene.
221
+ ctx.state.set({ /* copy this game's initial-state shape */ });
222
+ ctx.state.flush();
223
+ void ctx.goto("<scene-name>");
224
+ return;
163
225
  }
164
226
  ```
165
227
 
166
- From React, the same call is `game.goto("play")` — use that for a restart button instead of
167
- routing a counter through game state.
228
+ - **One rule when calling it from a frame function: `goto` and then `return`, immediately.**
229
+ Everything after the call runs against a torn-down scene.
230
+ - From React, `game.goto("<scene-name>")` also rebuilds the scene, but it resets the game's state
231
+ to its declared initial state first — that is the full restart button; `ctx.goto()` is for
232
+ preserving game state across the rebuild.
233
+
234
+ **`ctx.random` is deterministic only when `defineGame({ seed })` is configured.** Never use
235
+ `Math.random()` for a value the scenario must reproduce.
236
+
237
+ <!-- generated: superseded-constructs -->
238
+
239
+ **Reinvention fails CI.** `pnpm budgets` scans this project's `src/` for these raw
240
+ constructs and fails, naming the capability instead. The list and the gate are generated
241
+ from the capabilities' own doc tags, so they cannot disagree:
242
+
243
+ | Rather than write | Use instead | Import from |
244
+ |---|---|---|
245
+ | `new Audio(` | `AudioBus` | `@threenative/core` |
246
+ | `Math.random(` | `createRandom` | `@threenative/core` |
247
+ | `new Box3().setFromObject(` | `normaliseToMetres` | `@threenative/core` |
248
+ | `.visible = false` | `prewarm` | `@threenative/core` |
249
+ | `new Raycaster(` | `ScenePicker` | `@threenative/core` |
250
+
251
+ When the raw construct is genuinely right, annotate that exact line with a non-empty
252
+ reason — a bare `// engine-override:` still fails:
253
+
254
+ ```ts
255
+ const bounds = new Box3().setFromObject(viewmodel); // engine-override: measuring, not scaling
256
+ ```
257
+
258
+ <!-- /generated -->
259
+ <!-- /shared -->
168
260
 
169
- **`ctx.tween` is for timing, not for looks.** Use it for the *when* — a pickup rising over
170
- 0.4s, a door opening, a hit flash — and keep the *what* (colour, shape, easing feel) in
171
- `src/render/`. Motion driven by a persistent `Math.sin(elapsed)` in `update()` is still the
172
- right tool for a continuous idle bob; `tween` is for anything that starts, runs once, and
173
- finishes.
261
+ ## Engine capabilities — look it up before writing a replacement
174
262
 
175
- **`ctx.random` is seeded from `defineGame({ seed })`.** Use it for anything a playtest needs
176
- to reproduce — spawn positions, patrol offsets, level variation. `Math.random()` makes a
177
- scenario that passes once and fails on replay for no visible reason.
263
+ <!-- shared: engine-capabilities -->
264
+ Use `engine_search_capabilities("pool decals on surfaces")`; plain situations and complete game
265
+ requests both work. If the MCP server is unavailable after `npx threenative doctor`, use the
266
+ generated `agent-docs/capability-reference.md` and repeat the same full-request plus per-mechanic
267
+ search pass manually. Grepping existing imports is never capability discovery.
268
+ <!-- /shared -->
269
+
270
+
271
+ `@threenative/physics/navigation` carries WASM and is browser-only under the current native
272
+ portability rule; do not import it in a portable game. For browser-only games, navigation agents
273
+ calculate a path but never move your object: write the steering velocity and call
274
+ `CharacterBody3D.moveAndSlide()`. A `NavigationRegion3D` is static and must be baked from the
275
+ world geometry; changing geometry needs an explicit re-bake. `GroundSnap` keeps `clearance`
276
+ truthful when `enabled = false`, `normaliseToMetres` measures a skinned crown for height, and
277
+ `prewarm` keeps transient meshes renderable with zero opacity so the first-use frame is not a stall.
278
+ `AnimationPlayer` matches a travelling clip's rate to the ground covered, so feet never skate;
279
+ `strideRoot` names the moved body and `strideSync: false` overrides while `stride` still reports.
178
280
 
179
281
  ## Assets and animation
180
282
 
181
- `AnimationPlayer` is exported by `@threenative/core` for clips from a rigged asset. Put a
182
- `.glb` in `public/`, await `ctx.assets.model("hero.glb")` in `Scene.load()`, then construct
283
+ `AnimationPlayer` is exported by `@threenative/core` for clips from a rigged asset. Drop a
284
+ rigged `.glb` in `assets/` — sources there are compiled into `public/` and resolved through
285
+ the asset manifest — await `ctx.assets.model("hero.glb")` in `Scene.load()`, then construct
183
286
  and update the `AnimationPlayer` beside the entity that owns the loaded model. This minimal
184
- template does not ship a rigged asset; adding one belongs in `public/`, not in the framework.
287
+ template does not ship a rigged asset.
185
288
 
186
- ## Finding assets — you have an MCP server for this
289
+ ## Off-screen diffuse light
290
+
291
+ For light bouncing from a room I cannot see, construct `ProbeVolume` from `@threenative/core`
292
+ after the static geometry and lights exist. Add it with `ctx.add()`, request its bake on demand,
293
+ and pass `volume.sampleNode(positionWorld, normalWorld)` into a game-owned Three.js material
294
+ before the screen-space GI stage. The volume owns no light, material, colour, or falloff.
187
295
 
188
- **Reach for it when the asset is conventional; build anything custom yourself.**
189
-
190
- - **Textures, materials, HDRIs and sound effects — prefer the tools.** Rusted metal, oak
191
- planks, a studio HDRI, a UI click: these are well-established and a CC0 one beats what you
192
- would hand-author.
193
- - **Models — only when the thing is conventional.** A car, a plane, a crate, a barrel, a
194
- tree, a chair. If this game's main character is a car, fetching a compatible `.glb` is the
195
- right call.
196
- - **Anything specific to this game — write it in `src/render/`.** A downloaded model standing
197
- in for a bespoke design reads as a weird asset dropped into the scene, and it looks worse
198
- than a clean composition of primitives. This is the failure the tools make easy.
199
-
200
- When in doubt, build it programmatically. A fetched asset has to match what the game needs,
201
- not merely exist.
202
-
203
- `.mcp.json` in this project launches `threenative-asset-mcp` from `node_modules`, so your host
204
- lists its tools alongside your own. It advertises 32; these 8 are the loop you will use for
205
- nearly everything:
206
-
207
- 1. `asset_search_sources` — start here, never at a provider. It returns every catalogued
208
- source with its license summary, attribution requirement, browse URL, and whether an agent
209
- can complete a download from it. **That output is the authority on what is reachable** —
210
- not this file, and not your memory of some other project.
211
- 2. `polyhaven_search_assets` (CC0 models, textures, HDRIs), `ambientcg_search_assets` (CC0
212
- materials and textures), or `audio_search_assets` (Kenney, Sonniss).
213
- 3. `polyhaven_list_files` / `ambientcg_list_files` — the license, official URL, byte size and
214
- md5 of every resolution and format. **Read this before downloading, not after**, and pick a
215
- sane one: Poly Haven lists 16k PNGs over 1 GB beside 8k JPEGs at 28 MB. A game does not
216
- need the 16k.
217
- 4. `asset_download_file` for textures and models, `audio_download_asset` for audio. Both take
218
- `acceptLicense: true` — you are asserting you read step 3. **They ignore any path you pass
219
- and write to the directories `.mcp.json` sets** (`public/assets/<provider>/<sha>/` and
220
- `public/audio/<source>/<pack>/`); without that config they would write to `~/Downloads` and
221
- never reach the game.
222
- 5. Append the file, its source, its license and its URL to `CREDITS.md` **before the turn
223
- ends**. Poly Haven requires a visible Poly Haven credit when its API is used, ambientCG is
224
- CC0 per asset page, and audio and bundle licenses are per pack.
225
-
226
- **Never state a license you did not read off a tool result.** If `polyhaven_list_files` or
227
- `ambientcg_search_assets` did not tell you, you do not know it.
228
-
229
- **What arrives is usually a ZIP, not a texture.** ambientCG and Kenney ship archives: unpack
230
- one, keep only the maps you actually use (`_Color`, `_NormalGL`, `_Roughness` — not the
231
- `.blend`, `.usdc` or displacement), and put those beside your code under `public/`. A 1K JPEG
232
- set is right for a game; the 8K set of the same material is 200 MB.
233
-
234
- Two argument shapes that will bite you, both learned the hard way: `ambientcg_search_assets`
235
- takes lowercase `type` values (`material`, `hdri`, `3d-model`), and the audio catalog is
236
- **pack-level** — `audio_search_assets` matches pack names, so `query: "pickup coin"` returns
237
- nothing while `kind: "sfx"` returns the seven packs that exist. Pick a pack, download it,
238
- unzip it, and choose a file yourself.
239
-
240
- The other tools are narrower, and the directory spells out the conditions on each. The Fab
241
- tools talk to a marketplace: the server never purchases anything, and only directly-free files
242
- download. `smithsonian_search_assets` returns museum scans at scan resolution, which this
243
- project has no pipeline to decimate — that geometry is the wrong shape for a game. When in
244
- doubt check `asset_search_sources` first; its `caution` and license fields are the current
245
- truth for the pinned version, and they change between versions.
246
-
247
- Load what you downloaded the ordinary way — `ctx.assets.model("crate.glb")`,
248
- `ctx.assets.texture(...)`, `ctx.assets.audio(...)` — and write your own material and lighting
249
- around it in `src/render/`. The framework ships no asset and picks none for you.
296
+ This is static-lighting-first, not fully dynamic GI: moving lights and relighting require another
297
+ explicit bake. `TN_PROBE_VOLUME` reports the unbaked/stale state, probe count, atlas bytes,
298
+ progress, and last render-phase bake cost; keep those measurements visible while tuning bounds,
299
+ density, and `bakeBudgetMs`.
250
300
 
301
+ <!-- shared: asset-mcp-loop -->
302
+ ## Finding assets — you have an MCP server for this
303
+
304
+ **Reach for it when the asset is conventional; build anything custom yourself.** Textures,
305
+ materials, HDRIs, sound effects, and conventional models (a car, a crate, a tree) come from the
306
+ tools; anything specific to this game is written in `src/render/` — a downloaded model standing
307
+ in for a bespoke design reads as a weird asset dropped into the scene. When in doubt, build it
308
+ programmatically.
309
+
310
+ Installing `@threenative/core` writes the `.mcp.json` that launches `threenative-asset-mcp`, so
311
+ your host lists its tools alongside your own. Your host reads that file from the directory it was
312
+ launched in: start the session in this project, not in a parent of it. The loop:
313
+
314
+ 1. `asset_search_sources` first, never a provider — its output is the authority on what is
315
+ reachable.
316
+ 2. `polyhaven_search_assets`, `ambientcg_search_assets`, or `audio_search_assets` to find
317
+ candidates.
318
+ 3. `polyhaven_list_files` / `ambientcg_list_files` **before downloading** — read licenses and
319
+ pick a sane resolution there (a game does not need the 16k).
320
+ 4. `asset_download_file` / `audio_download_asset` with `acceptLicense: true`; they write where
321
+ `.mcp.json` points, never where you pass a path.
322
+ 5. Append file, source, license and URL to `CREDITS.md` before the turn ends.
323
+
324
+ **Never state a license you did not read off a tool result.**
325
+
326
+ **Fab is two steps.** `fab_search_assets` finds a free listing, and `fab_list_owned` says what the
327
+ account already paid for — a free search never shows those. Then `fab_import_asset` converts it: it checks the
328
+ entitlement, downloads through the FabCLI session you established yourself, turns every static
329
+ mesh into a textured `.glb` under `assets/`, and returns the paths. It refuses anything but Fab
330
+ Standard or CC-BY, and it never logs in, claims, or buys. Most Fab listings are Unreal-only, so
331
+ without it a listing is a dead end. Full argument shapes: `agent-docs/finding-assets.md`.
332
+
333
+ The full loop — ZIP unpacking rules, the two argument shapes that bite, and the narrower
334
+ marketplace tools — is `agent-docs/finding-assets.md`.
335
+ <!-- /shared -->
336
+
337
+ <!-- shared: sculpt-loop -->
251
338
  ## Building what you cannot download — sculpt from a reference
252
339
 
253
- Choose one branch before writing code:
254
-
255
- - **Conventional and downloadable** — a crate, an oak plank texture, a click. Use the asset
256
- tools. Sculpting one of these is slower and worse.
257
- - **Trivial** — a platform, a wall, a pickup ring. Write it. If `BoxGeometry` finishes the
258
- job in under 20 lines, that is the answer.
259
- - **Bespoke, with a reference image** — an identity-bearing creature, vehicle, hero prop,
260
- landmark, scenery composition, or environment set piece whose silhouette must match. Use
261
- the sculpt tools to turn that reference into editable `src/render/` source.
262
- - **Bespoke, without a reference image** — ask for one, or write it and accept that it will
263
- be generic. Do not invent a reference: comparison without evidence is unguided iteration.
264
-
265
- For a full environment, split the decision: sculpt the signature landmark or bounded scene
266
- kit that makes the reference recognisable; use the asset tools for interchangeable trees,
267
- rocks, textures, HDRIs, and sounds around it. Do not sculpt an entire world as one object.
268
-
269
- `.mcp.json` launches `threenative-sculpt-mcp` beside the asset server. It does not generate
270
- or ship runtime code; it guides the source you write:
271
-
272
- 1. Call `sculpt_plan` with the image path and a one-line intent, then read the returned
273
- grimoire resources.
274
- 2. Write the returned object contract and loop on `sculpt_spec_gate` until every named
275
- region and depth requirement passes. Do not write geometry before this gate is green.
276
- 3. For each ordered pass, write or extend one factory in `src/render/`. Capture the real
277
- frame with `npx @threenative/playtest`; the sculpt server never launches a browser.
278
- 4. Call `sculpt_compare` with the reference and captured frame, then give that evidence to
279
- `sculpt_pass_gate`. Advance only when it says advance; ambiguity means retry.
280
- 5. Use `sculpt_grimoire` for a named technique topic. It rejects pages containing concrete
281
- paste-ready material or shader recipes so the tool never owns this game's look.
340
+ Choose one branch before writing code: conventional and downloadable — use the asset tools;
341
+ trivial (a platform, a wall) — write it, `BoxGeometry` under 20 lines is the answer; bespoke
342
+ with a reference image — the sculpt tools below; bespoke without one — ask for it, never
343
+ invent a reference.
344
+
345
+ `.mcp.json` launches `threenative-sculpt-mcp`; it does not ship runtime code, it guides the
346
+ source you write: plan with `sculpt_plan`, loop on `sculpt_spec_gate` until every named region
347
+ passes **before writing geometry**, write one factory per pass in `src/render/`, prove each
348
+ pass with `sculpt_compare` plus `sculpt_pass_gate` against a real captured frame (the sculpt
349
+ server never launches a browser), and pull technique topics from `sculpt_grimoire`.
282
350
 
283
351
  A missing or blank capture is a failed run, never a finished model. Add the reference image,
284
- its creator, license, and source URL to `CREDITS.md` before the turn ends.
352
+ its creator, license, and source URL to `CREDITS.md` before the turn ends. The branch
353
+ definitions and environment-splitting guidance are `agent-docs/sculpt-from-a-reference.md`.
354
+ <!-- /shared -->
285
355
 
286
356
 
287
357
  ## Visuals
@@ -290,40 +360,38 @@ Edit the six files in `src/render/` directly: `palette.ts`, `camera.ts`, `sky.ts
290
360
  `lighting.ts`, `materials.ts`, and `postprocessing.ts`. They are ordinary Three.js source in
291
361
  this project, not a framework look or a config option. Keep the palette to six named colours
292
362
  with one `accent`; import it from materials and sky. Set tonemapping and exposure deliberately,
293
- use a rim light with soft shadows and `normalBias`, derive fog from the sky, and route bloom
294
- through `renderer.setOutputNode()` so midtones remain readable.
295
-
296
- `lighting.ts` ships key, bounce, **rim** and ambient with soft shadows. The rim is what
297
- stops silhouettes reading as flat cut-outs against the background; do not delete it while
298
- "simplifying".
299
-
300
- Two traps worth knowing before you spend an afternoon on either:
301
-
302
- 1. **`CanvasTexture` samples black under `WebGPURenderer`.** Painting a canvas and using it
303
- as a `map` silently produces a black surface. Vary material colours across meshes
304
- instead. (The `starter` template ships a `shapes.ts` with rounded primitives and a
305
- seeded RNG for exactly this; copy it in if you want it.)
306
- 2. **Import a render module and then call it.** `setupPost` is inert if `Play.ts` only
307
- imports it, and no gate here will fail.
363
+ use a rim light with soft shadows and `normalBias`, and route every stage through the
364
+ `WorldEnvironment` in `postprocessing.ts`: it decides the order and reports what ran, never a
365
+ colour or a strength. `TN_WORLD_ENVIRONMENT` names every stage applied or refused **with a
366
+ reason**, and an unknown quality tier throws rather than becoming the default. SSGI and SSR ship
367
+ desktop-on, mobile-off. The baseline in
368
+ `agent-docs/visual-baseline.md` covers `CanvasTexture` black under `WebGPURenderer`, uncalled
369
+ render modules, and four silent TSL no-ops: `SSRNode.maxDistance`, `reflectNonMetals`, a swizzled
370
+ normal, and a dangling branch.
371
+
372
+ The sky dome's colour, the sun light's colour and the depth haze all come from one `Atmosphere`
373
+ node built in `src/scenes/Play.ts`, so `sky.ts` sets no fog. You supply every coefficient — there
374
+ is no Earth default — and you own the dome mesh, its material and its exposure. It is WebGPU-only:
375
+ on WebGL `Play.ts` passes none and `sky.ts` falls back to a flat background. Delete the
376
+ `baseColour` property passed in `postprocessing.ts` to drop the haze and keep the sky.
377
+ `playtests/atmosphere.playtest.json` proves the sun moves and the frame changes with it.
308
378
 
309
379
  Nothing in the toolchain can see your game. `pnpm test` proves behaviour, never the look.
310
380
 
311
381
  ## HUD
312
382
 
313
- This template has no React. `main.ts` subscribes a plugin to the store and writes to a DOM
314
- node. `ctx.state.set()` coalesces, so write it from `update()` freely — but never rebuild
315
- the DOM per frame.
316
-
317
- If the UI grows past a few readouts, scaffold with the `starter` template instead, which
318
- ships React 19 + Tailwind and `@threenative/ui`.
383
+ This template has no React and **no DOM readout**: the HUD is `src/render/hud.ts`, camera-parented
384
+ instanced-quad glyphs drawn in the scene, and `main.ts` deliberately draws no second copy of the
385
+ score. That is the one HUD shape that survives every target — identical text on web, desktop and
386
+ Android, no per-target branch. Rewrite its glyph table, labels, colours and layout freely; keep
387
+ exactly one layer, because a DOM chip over the same score is how a build scored 1 of 5 for an
388
+ unreadable doubled readout. If the UI grows past a few readouts **and the game is web-only**,
389
+ scaffold with `starter`, which ships React 19 + Tailwind and `@threenative/ui`.
319
390
 
320
391
  The start scene owns the initial state in `static initialState`; omit a duplicate
321
392
  `initialState` literal from `defineGame`. `ctx.state.set({ playerX })` is a partial patch.
322
-
323
- For development hot reload, `main.ts` calls `acceptHotUpdate(game, import.meta.hot)`. The
324
- framework carries only JSON-shaped store state; rebuild the scene in `enter()` from the
325
- state values you want to keep. Meshes, physics bodies, audio voices, and renderer objects
326
- are always rebuilt.
393
+ Hot reload carries JSON-shaped store state only: rebuild the scene in `enter()` from the
394
+ values you want to keep.
327
395
 
328
396
  ## Register entities you want to inspect or test
329
397
 
@@ -336,67 +404,104 @@ assertions. That is how a scenario checks game state instead of guessing from pi
336
404
 
337
405
  ## Playtests
338
406
 
339
- `playtests/survives.playtest.json` is the durable smoke proof. Keep it when replacing the
340
- minimal gameplay: it checks boot, diagnostics, a nonblank canvas, and player movement without
341
- depending on the pickup or score. `playtests/play.playtest.json` is the minimal-game example.
342
- Steps count frames, not milliseconds — `holdFrames`, `waitFrames` — because the harness drives
343
- the fixed-step clock instead of racing it.
344
-
345
- A scenario fails closed: a missing entity, an absent observation, or a scenario with no
346
- assertions is a failure, never a quiet pass. Add the assertion that would catch a feature's
347
- absence, and run it before reporting the feature works.
407
+ `playtests/survives.playtest.json` is the durable smoke proof — boot, diagnostics, a nonblank
408
+ canvas, player movement — and stays green however far you replace the minimal gameplay.
409
+ `playtests/play.playtest.json` is the minimal-game example you may delete or rewrite.
348
410
 
411
+ <!-- shared: look-at-it-and-budget-the-look -->
349
412
  ## Budget real time for the look
350
413
 
351
414
  Read this as an instruction about **where your effort goes**, not as a style tip.
352
415
 
353
- Every automated gate here — `typecheck`, `lint`, `pnpm test`, every playtest scenario — is
354
- blind to how the game looks. All of them pass on a game that is grey boxes on a black
355
- screen. If you let the gates define "done", that is what you will ship, and the gates will
356
- tell you that you succeeded.
357
-
358
- **A feature is not done when its assertion passes. It is done when you have looked at it
359
- and it reads well.** Plan for roughly as much work on presentation as on mechanics.
360
-
361
- When you add anything a player sees, do all of these before calling it done:
416
+ Every automated gate in this project — `typecheck`, `lint`, `pnpm test`, every playtest
417
+ scenario — is blind to how the game looks. All of them pass on a game that is grey boxes on
418
+ a black screen. So: **a feature is not done when its assertion passes. It is done when you
419
+ have looked at it and it reads well.** Plan for roughly as much work on presentation as on
420
+ mechanics; it is the majority of what a player experiences and the part nothing else catches.
362
421
 
363
- 1. **Look at it.** Boot the game, get it on screen, screenshot, open the screenshot.
364
- Reading your own diff is not looking at it.
365
- 2. **Silhouette first.** Can you tell what it is from its outline? Break up long straight
366
- edges. A shape that reads at a glance beats a detailed shape that does not.
367
- 3. **Give it depth.** Something bright behind it, something dark under it. Contact shadows
368
- and the rim light make a prop sit in the world instead of floating on it.
369
- 4. **Make it move.** Idle bob, squash on impact, a particle on pickup. A few frames of
370
- motion is the cheapest quality-per-line in the project.
371
- 5. **Finish the HUD.** Spacing, hierarchy, a transition on numbers that change.
422
+ Before calling anything a player sees done: look at it (a screenshot you actually open, not
423
+ your own diff); break up silhouettes; give it depth with contact shadows and rim; make it move;
424
+ finish the HUD.
372
425
 
373
- ### How to actually look at it
426
+ 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
427
+ `npx @threenative/playtest <scenario> --browser-recipe webgpu --headed` (the recipe carries the
428
+ Chromium flags WebGPU needs including `--enable-features=Vulkan`; without it Chromium serves
429
+ SwiftShader and the runner fails the run with `TN_PLAYTEST_SOFTWARE_ADAPTER`); then ask the
430
+ user to look, saying what to check.
374
431
 
375
- Run `pnpm dev`, then get eyes on it. In rough order of preference:
432
+ **Do not use `xvfb-run`:** its failing cleanup kill replaces the real exit status. And
433
+ **headless Chromium usually cannot render WebGPU** — if a screenshot comes back black or empty,
434
+ suspect the capture before you rewrite the scene.
376
435
 
377
- 1. **Browser automation against the user's real Chrome**, if available — Claude in Chrome
378
- or an equivalent MCP browser tool. Best option by far: real GPU, so WebGPU works, and
379
- you can navigate, press keys, screenshot and read the console in one loop. Drive the
380
- game, do not just load the menu.
381
- 2. **`npx @threenative/playtest <scenario> --browser-recipe webgpu --headed`.** The recipe
382
- carries the Chromium flags a WebGPU capture needs, including `--enable-features=Vulkan`.
383
- Without that one flag Chromium serves WebGPU from SwiftShader, its CPU rasteriser, with no
384
- error and healthy-looking limits; the runner fails that run with
385
- `TN_PLAYTEST_SOFTWARE_ADAPTER` rather than reporting a software renderer's picture.
386
- 3. **Ask the user to look**, saying specifically what to check.
436
+ The capture recipes, virtual-display setup, and the silhouette checklist are
437
+ `agent-docs/capture-the-frame.md`. When you think you are done: *would a player screenshot
438
+ this?* If no, you are not finished.
439
+ <!-- /shared -->
387
440
 
388
- On a machine with no screen, run under a virtual display — but **not `xvfb-run`**: its
389
- cleanup `kill` fails after Xvfb exits and replaces the real exit status, so
390
- `xvfb-run -a -s '-screen 0 1600x900x24' true` exits `1` and every gate wrapped in it reports
391
- failure whether it passed or not. Start `Xvfb` yourself and export `DISPLAY`.
441
+ <!-- shared: pixel-budget -->
442
+ ## The pixel budget is the engine's
392
443
 
393
- What does *not* work: **headless Chromium usually cannot render WebGPU.** The page loads,
394
- the DOM HUD paints, and the 3D canvas comes out blank — which looks exactly like a bug in
395
- your scene and is not. Look for `Instance dropped in popErrorScope` in the console.
444
+ `renderer.resolutionScale: "auto"` ships on. The engine scales the **3D drawing buffer only** —
445
+ never CSS, UI, camera or aspect — to hold `display.maxFps`. A Pixel 8 hands three.js 2400×1080 as
446
+ CSS pixels: 2.592 Mpx at a measured 9.94 ms/Mpx. Never hand-author that constant.
396
447
 
397
- If a screenshot comes back black, suspect the capture before you rewrite the scene.
398
-
399
- ### When you think you are done
448
+ ```ts
449
+ renderer: { resolutionScale: "auto", antialias: true,
450
+ android: { resolutionScale: 0.44, antialias: false } },
451
+ ```
400
452
 
401
- Ask honestly: *would a player screenshot this?* If not, you are not finished — and no
402
- command here is going to tell you that.
453
+ A number in `(0, 1]` pins it and stops the loop; `0`, negatives, `> 1` and `NaN` are refused by
454
+ name at config load, not at frame time. Pinning never stops the measurement: every
455
+ `TN_FRAME_BUDGET` window carries
456
+ `surface: { resolutionScale, scaleSource, sampleCount, drawingBufferWidth, drawingBufferHeight }`
457
+ in both modes, and `perf --text` prints it beside the fps. `scaleSource` is `pinned`, `auto`, or
458
+ `auto-pinned` (chose, then held rather than pump visibly); at the floor and still over budget it
459
+ reports `atFloor` instead of implying the budget was met. `antialias` overrides per-platform on
460
+ the same seam — a scaled buffer is upscaled, magnifying every aliased edge. Pass
461
+ `display: config.display` into `defineGame`, or the scaler assumes 60.
462
+ <!-- /shared -->
463
+
464
+ <!-- shared: performance-default -->
465
+ # Lightmaps
466
+
467
+ `assets.models.lightmap:{atlasSize,padding}` bakes static GLBs; load via `ctx.assets.model()`.
468
+ Remove it to roll back. Android/iOS reject KTX2; never claim them from web/desktop proof.
469
+
470
+ ## Performance targets
471
+
472
+ Refill scratch; pool objects.
473
+
474
+ `TN_FRAME_BUDGET` reports `fps`/`hostGap`/`update`/`render`/`overlay`/`residual`;
475
+ `defineGame({ frameBudget: false })` silences output, never measurement.
476
+
477
+ Unexecuted platforms stay unverified; never-invent-numbers. Withdraw thermally-confounded Tiers 1–3 comparisons; always report Tier 4.
478
+
479
+ |Tier|Measure|Floor|Target|
480
+ |---|---|---:|---:|
481
+ |1|Starter/browser-desktop|60fps|display-refresh|
482
+ |1|Starter/browser-Android|30fps|58fps|
483
+ |1|Starter/native-desktop|60fps|display-refresh|
484
+ |1|Starter/native-Android|55fps|58fps|
485
+ |1|Starter/native-iOS|unverified|no-number|
486
+ |1|All-platform/hostGap-p95|—|≤4ms|
487
+ |1|All-platform/update-p95|—|≤2ms|
488
+ |1|All-platform/residual-p95|—|≤0.5ms|
489
+ |1|All-platform/overlay-p95|—|≤1ms|
490
+ |2|Same-device-fps-parity|.85|.95|
491
+ |2|Inverted-render-p95-parity|.80|.95|
492
+ |3|Light|55fps|58fps|
493
+ |3|Medium|30fps|58fps|
494
+ |3|Heavy|30fps|58fps|
495
+ |4|Sustained-duration|10min|10min|
496
+ |4|Final/opening-fps|.75|.90|
497
+ |4|Last-minute-heavy|25fps|50fps|
498
+ |4|Peak-battery-temperature|≤45C|≤40C|
499
+ |4|Thermal-status|≤2|≤1|
500
+ |4|Whole-device-current|—|report;not-gated|
501
+
502
+ `{"performance":{"maxFrameMsP95":33,"minFps":30,"maxPhaseMsP95":{"render":12}}}`
503
+ `agent-docs/assertion-reference.md#performance`
504
+
505
+ Pixel-8-memory: ~500MiB-driver-floor; dual-use-equirect adds-48MiB. Fix:
506
+ `agent-docs/mobile-memory-budget.md`.
507
+ <!-- /shared -->