create-threenative 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 João Paulo Furtado
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -6,11 +6,19 @@ Scaffold a ThreeNative game:
6
6
  pnpm create threenative my-game
7
7
  ```
8
8
 
9
- The default template is `starter`. Choose `minimal` for the smallest project or `platformer`
10
- for a worked platform game:
9
+ The default template is `starter`. Choose `minimal`, `platformer`, `action-rpg`, `defense`,
10
+ `racing`, or `shooter` for a different starting point:
11
11
 
12
12
  ```sh
13
13
  pnpm create threenative my-game --template minimal
14
14
  pnpm create threenative my-game --template starter
15
15
  pnpm create threenative my-game --template platformer
16
+ pnpm create threenative my-game --template action-rpg
17
+ pnpm create threenative my-game --template defense
18
+ pnpm create threenative my-game --template racing
19
+ pnpm create threenative my-game --template shooter
16
20
  ```
21
+
22
+ Inside a generated project, `npx threenative doctor --text` reports what would break a build:
23
+ missing or version-mismatched `@threenative` packages, a portable entry with no default game
24
+ export, no web entry, no scenario, no capability search for your agent.
@@ -0,0 +1,33 @@
1
+ ## Finding assets — you have an MCP server for this
2
+
3
+ **Reach for it when the asset is conventional; build anything custom yourself.** Textures,
4
+ materials, HDRIs, sound effects, and conventional models (a car, a crate, a tree) come from the
5
+ tools; anything specific to this game is written in `src/render/` — a downloaded model standing
6
+ in for a bespoke design reads as a weird asset dropped into the scene. When in doubt, build it
7
+ programmatically.
8
+
9
+ Installing `@threenative/core` writes the `.mcp.json` that launches `threenative-asset-mcp`, so
10
+ your host lists its tools alongside your own. Your host reads that file from the directory it was
11
+ launched in: start the session in this project, not in a parent of it. The loop:
12
+
13
+ 1. `asset_search_sources` first, never a provider — its output is the authority on what is
14
+ reachable.
15
+ 2. `polyhaven_search_assets`, `ambientcg_search_assets`, or `audio_search_assets` to find
16
+ candidates.
17
+ 3. `polyhaven_list_files` / `ambientcg_list_files` **before downloading** — read licenses and
18
+ pick a sane resolution there (a game does not need the 16k).
19
+ 4. `asset_download_file` / `audio_download_asset` with `acceptLicense: true`; they write where
20
+ `.mcp.json` points, never where you pass a path.
21
+ 5. Append file, source, license and URL to `CREDITS.md` before the turn ends.
22
+
23
+ **Never state a license you did not read off a tool result.**
24
+
25
+ **Fab is two steps.** `fab_search_assets` finds a free listing, and `fab_list_owned` says what the
26
+ account already paid for — a free search never shows those. Then `fab_import_asset` converts it: it checks the
27
+ entitlement, downloads through the FabCLI session you established yourself, turns every static
28
+ mesh into a textured `.glb` under `assets/`, and returns the paths. It refuses anything but Fab
29
+ Standard or CC-BY, and it never logs in, claims, or buys. Most Fab listings are Unreal-only, so
30
+ without it a listing is a dead end. Full argument shapes: `agent-docs/finding-assets.md`.
31
+
32
+ The full loop — ZIP unpacking rules, the two argument shapes that bite, and the narrower
33
+ marketplace tools — is `agent-docs/finding-assets.md`.
@@ -0,0 +1,69 @@
1
+ ## The `ctx` surface — you already have these, do not rebuild them
2
+
3
+ `ctx` carries seven things that get reimplemented by hand in almost every project, because
4
+ they are **properties on `ctx`, never imports** — grepping an existing file's imports will
5
+ never surface them. This table covers only the `ctx` properties; call
6
+ `engine_search_capabilities` for imports. The recipes behind this table live in
7
+ `agent-docs/ctx-cookbook.md`.
8
+
9
+ | You already have | Rather than | Signature |
10
+ |---|---|---|
11
+ | `ctx.goto("<scene-name>")` | a hand-written `#reset()` | `(name: string) => Promise<void>` |
12
+ | `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 |
13
+ | `ctx.after(0.8, fn)` | `elapsed += dt; if (elapsed > 0.8)` | `(seconds, cb) => ScheduleHandle` |
14
+ | `ctx.every(fn)` | a per-frame branch in `update` | `(cb: (dt: number) => void) => ScheduleHandle` |
15
+ | `ctx.random.range(-1, 1)` | `Math.random()` | deterministic when `seed` is configured; otherwise `Math.random()` |
16
+ | `ctx.pointer.on(...)` / `ctx.pointer.drag(...)` | hand-written hover, press, tap, and drag state | `(object, type, listener) => disposer` / `(object) => IPointerDragHandle` |
17
+ | `ctx.raycast()` / `ctx.raycastAll()` | `new Raycaster()` + `intersectObject(s)` | `(options?: { screen?, origin?, direction?, far?, targets?, exclude? }) => Intersection \| undefined` / `readonly Intersection[]` |
18
+
19
+ `ctx.pointer` dispatches `pointerEntered`, `pointerExited`, `pointerPressed`, `pointerReleased`,
20
+ `tapped`, `dragStarted`, `dragged`, and `dragEnded` from the same pointer-id stream on web and
21
+ native. Register a mesh or model root; only registered objects are raycast, and events bubble
22
+ through the parent chain.
23
+
24
+ Three rules are load-bearing enough to stay here:
25
+
26
+ - **`ctx.goto(name)` rebuilds the scene without resetting game state.** Values in `ctx.state`
27
+ survive the rebuild; reset your own state explicitly when death-and-retry should start
28
+ fresh:
29
+
30
+ ```ts
31
+ if (player.dead) {
32
+ ctx.state.set({ /* copy this game's initial-state shape */ });
33
+ ctx.state.flush();
34
+ void ctx.goto("<scene-name>");
35
+ return;
36
+ }
37
+ ```
38
+
39
+ - **One rule when calling it from a frame function: `goto` and then `return`, immediately.**
40
+ Everything after the call runs against a torn-down scene.
41
+ - From React, `game.goto("<scene-name>")` also rebuilds the scene, but it resets the game's state
42
+ to its declared initial state first — that is the full restart button; `ctx.goto()` is for
43
+ preserving game state across the rebuild.
44
+
45
+ **`ctx.random` is deterministic only when `defineGame({ seed })` is configured.** Never use
46
+ `Math.random()` for a value the scenario must reproduce.
47
+
48
+ <!-- generated: superseded-constructs -->
49
+
50
+ **Reinvention fails CI.** `pnpm budgets` scans this project's `src/` for these raw
51
+ constructs and fails, naming the capability instead. The list and the gate are generated
52
+ from the capabilities' own doc tags, so they cannot disagree:
53
+
54
+ | Rather than write | Use instead | Import from |
55
+ |---|---|---|
56
+ | `new Audio(` | `AudioBus` | `@threenative/core` |
57
+ | `Math.random(` | `createRandom` | `@threenative/core` |
58
+ | `new Box3().setFromObject(` | `normaliseToMetres` | `@threenative/core` |
59
+ | `.visible = false` | `prewarm` | `@threenative/core` |
60
+ | `new Raycaster(` | `ScenePicker` | `@threenative/core` |
61
+
62
+ When the raw construct is genuinely right, annotate that exact line with a non-empty
63
+ reason — a bare `// engine-override:` still fails:
64
+
65
+ ```ts
66
+ const bounds = new Box3().setFromObject(viewmodel); // engine-override: measuring, not scaling
67
+ ```
68
+
69
+ <!-- /generated -->
@@ -0,0 +1,4 @@
1
+ Use `engine_search_capabilities("pool decals on surfaces")`; plain situations and complete game
2
+ requests both work. If the MCP server is unavailable after `npx threenative doctor`, use the
3
+ generated `agent-docs/capability-reference.md` and repeat the same full-request plus per-mechanic
4
+ search pass manually. Grepping existing imports is never capability discovery.
@@ -0,0 +1,60 @@
1
+ ### Before you write a system, ask what already exists
2
+
3
+ You have `engine_search_capabilities`. Discovery is required before planning:
4
+
5
+ 1. Infer concrete mechanics from the request: world, traversal, interaction, simulation, combat,
6
+ camera, audio, and UI. Preserve its distinctive fantasy with the smallest loop using its
7
+ characteristic setting or traversal—not a generic game with themed props. Search implied
8
+ mechanics even when the user omits engine terms. Ask one short question only when two core loops
9
+ remain equally plausible.
10
+ 2. Search the full mechanical request with `scope: "request"`, then every mechanic with
11
+ `scope: "mechanic"`. Check each returned `matchedSituation`.
12
+ 3. Before writing replacements, record a capability or no-match for every mechanic.
13
+
14
+ Repeat before writing entity, movement, navigation, attachment, audio, particle, simulation,
15
+ terrain, or measurement systems. Describe situations plainly: *"enemy walks around a wall"*.
16
+
17
+ The manifest is the complete public surface; grep misses unused subpath exports such as
18
+ `@threenative/physics/navigation`. If MCP is unavailable, run doctor and search
19
+ `agent-docs/capability-reference.md` per mechanic.
20
+
21
+ Constraints are binding. Import navigation symbols from the returned subpath. Use `attachToBone`
22
+ for held weapons; if needed, add a portable Three.js `Bone` named `RightHand` first. Capability
23
+ detail governs platform support: never invent limits it does not report. Reject only for a reported
24
+ constraint or a contract that does not fit.
25
+
26
+ This prevents reimplementing installed systems; one game did so in 446 lines and ran at 9 FPS.
27
+
28
+ ## When the framework blocks you, write plain Three.js
29
+
30
+ For browser, blank-frame, device, or import failures, first run `npx threenative doctor` and
31
+ `npx @threenative/playtest doctor`. They separate project/machine failures from engine bugs. For a
32
+ running game that looks wrong, inspect it:
33
+
34
+ ```sh
35
+ npx @threenative/playtest doctor --url http://127.0.0.1:5173 --text
36
+ ```
37
+
38
+ This reports visibility, scale, draw cost, frame rate, advancing state, and errors. Missing output
39
+ means unobserved, never zero.
40
+
41
+ When an `@threenative/*` API is broken, missing, or does not do what you need, implement only that
42
+ piece with portable Three.js/plain code and continue:
43
+
44
+ 1. Keep the existing loop, scenes, input, registry, and playtest bridge.
45
+ 2. Avoid `document`, `window`, `localStorage`, dynamic `import()`, and raw physics handles.
46
+ 3. **Report what blocked you**: API, expectation, result, and replacement.
47
+
48
+ Never stall on a framework bug.
49
+
50
+ ### Where the long recipes live
51
+
52
+ Open the relevant shipped recipe when needed:
53
+
54
+ - `agent-docs/finding-assets.md` — asset search, licenses, downloads, and archives.
55
+ - `agent-docs/sculpt-from-a-reference.md` — sculpt gates and branches.
56
+ - `agent-docs/webview-ui.md` — UI state, intents, and hit regions.
57
+ - `agent-docs/capture-the-frame.md` — WebGPU screenshots.
58
+ - `agent-docs/ctx-cookbook.md` — raycasts, rebuilds, and seeded randomness.
59
+ - `agent-docs/gameplay-recipes.md` — movement, gamepads, and physics timing.
60
+ - `agent-docs/visual-baseline.md` — generated render-source conventions.
@@ -0,0 +1,27 @@
1
+ ## Budget real time for the look
2
+
3
+ Read this as an instruction about **where your effort goes**, not as a style tip.
4
+
5
+ Every automated gate in this project — `typecheck`, `lint`, `pnpm test`, every playtest
6
+ scenario — is blind to how the game looks. All of them pass on a game that is grey boxes on
7
+ a black screen. So: **a feature is not done when its assertion passes. It is done when you
8
+ have looked at it and it reads well.** Plan for roughly as much work on presentation as on
9
+ mechanics; it is the majority of what a player experiences and the part nothing else catches.
10
+
11
+ Before calling anything a player sees done: look at it (a screenshot you actually open, not
12
+ your own diff); break up silhouettes; give it depth with contact shadows and rim; make it move;
13
+ finish the HUD.
14
+
15
+ 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
16
+ `npx @threenative/playtest <scenario> --browser-recipe webgpu --headed` (the recipe carries the
17
+ Chromium flags WebGPU needs including `--enable-features=Vulkan`; without it Chromium serves
18
+ SwiftShader and the runner fails the run with `TN_PLAYTEST_SOFTWARE_ADAPTER`); then ask the
19
+ user to look, saying what to check.
20
+
21
+ **Do not use `xvfb-run`:** its failing cleanup kill replaces the real exit status. And
22
+ **headless Chromium usually cannot render WebGPU** — if a screenshot comes back black or empty,
23
+ suspect the capture before you rewrite the scene.
24
+
25
+ The capture recipes, virtual-display setup, and the silhouette checklist are
26
+ `agent-docs/capture-the-frame.md`. When you think you are done: *would a player screenshot
27
+ this?* If no, you are not finished.
@@ -0,0 +1,42 @@
1
+ # Lightmaps
2
+
3
+ `assets.models.lightmap:{atlasSize,padding}` bakes static GLBs; load via `ctx.assets.model()`.
4
+ Remove it to roll back. Android/iOS reject KTX2; never claim them from web/desktop proof.
5
+
6
+ ## Performance targets
7
+
8
+ Refill scratch; pool objects.
9
+
10
+ `TN_FRAME_BUDGET` reports `fps`/`hostGap`/`update`/`render`/`overlay`/`residual`;
11
+ `defineGame({ frameBudget: false })` silences output, never measurement.
12
+
13
+ Unexecuted platforms stay unverified; never-invent-numbers. Withdraw thermally-confounded Tiers 1–3 comparisons; always report Tier 4.
14
+
15
+ |Tier|Measure|Floor|Target|
16
+ |---|---|---:|---:|
17
+ |1|Starter/browser-desktop|60fps|display-refresh|
18
+ |1|Starter/browser-Android|30fps|58fps|
19
+ |1|Starter/native-desktop|60fps|display-refresh|
20
+ |1|Starter/native-Android|55fps|58fps|
21
+ |1|Starter/native-iOS|unverified|no-number|
22
+ |1|All-platform/hostGap-p95|—|≤4ms|
23
+ |1|All-platform/update-p95|—|≤2ms|
24
+ |1|All-platform/residual-p95|—|≤0.5ms|
25
+ |1|All-platform/overlay-p95|—|≤1ms|
26
+ |2|Same-device-fps-parity|.85|.95|
27
+ |2|Inverted-render-p95-parity|.80|.95|
28
+ |3|Light|55fps|58fps|
29
+ |3|Medium|30fps|58fps|
30
+ |3|Heavy|30fps|58fps|
31
+ |4|Sustained-duration|10min|10min|
32
+ |4|Final/opening-fps|.75|.90|
33
+ |4|Last-minute-heavy|25fps|50fps|
34
+ |4|Peak-battery-temperature|≤45C|≤40C|
35
+ |4|Thermal-status|≤2|≤1|
36
+ |4|Whole-device-current|—|report;not-gated|
37
+
38
+ `{"performance":{"maxFrameMsP95":33,"minFps":30,"maxPhaseMsP95":{"render":12}}}`
39
+ `agent-docs/assertion-reference.md#performance`
40
+
41
+ Pixel-8-memory: ~500MiB-driver-floor; dual-use-equirect adds-48MiB. Fix:
42
+ `agent-docs/mobile-memory-budget.md`.
@@ -0,0 +1,20 @@
1
+ ## The pixel budget is the engine's
2
+
3
+ `renderer.resolutionScale: "auto"` ships on. The engine scales the **3D drawing buffer only** —
4
+ never CSS, UI, camera or aspect — to hold `display.maxFps`. A Pixel 8 hands three.js 2400×1080 as
5
+ CSS pixels: 2.592 Mpx at a measured 9.94 ms/Mpx. Never hand-author that constant.
6
+
7
+ ```ts
8
+ renderer: { resolutionScale: "auto", antialias: true,
9
+ android: { resolutionScale: 0.44, antialias: false } },
10
+ ```
11
+
12
+ A number in `(0, 1]` pins it and stops the loop; `0`, negatives, `> 1` and `NaN` are refused by
13
+ name at config load, not at frame time. Pinning never stops the measurement: every
14
+ `TN_FRAME_BUDGET` window carries
15
+ `surface: { resolutionScale, scaleSource, sampleCount, drawingBufferWidth, drawingBufferHeight }`
16
+ in both modes, and `perf --text` prints it beside the fps. `scaleSource` is `pinned`, `auto`, or
17
+ `auto-pinned` (chose, then held rather than pump visibly); at the floor and still over budget it
18
+ reports `atFloor` instead of implying the budget was met. `antialias` overrides per-platform on
19
+ the same seam — a scaled buffer is upscaled, magnifying every aliased edge. Pass
20
+ `display: config.display` into `defineGame`, or the scaler assumes 60.
@@ -0,0 +1,23 @@
1
+ ## Playtests fail closed
2
+
3
+ A scenario fails closed: a missing entity, an absent observation, or a scenario with no
4
+ assertions is a failure, never a quiet pass. When you add a feature, add the assertion that
5
+ would catch its absence, and run the scenario before reporting the feature works.
6
+
7
+ Every `allowTrivial` waiver must be a reason string with at least 20 non-whitespace characters
8
+ explaining why the initial value is intentionally held; `allowTrivial: true` is invalid. A
9
+ scenario whose every triviality-eligible assertion is waived fails with
10
+ `TN_PLAYTEST_SCENARIO_ASSERTS_NOTHING`, so keep an independent assertion in the scenario.
11
+
12
+ Steps count fixed-step ticks, not milliseconds — use `holdTicks` and `waitTicks`. The deprecated
13
+ `holdFrames` and `waitFrames` aliases remain accepted for compatibility and are treated as ticks
14
+ on a fixed-step bridge; `warmupFrames` remains a genuine requestAnimationFrame warmup.
15
+
16
+ The assertion vocabulary — every kind the validator accepts, its fields, and when to reach for
17
+ it — is generated into `agent-docs/assertion-reference.md`; open it before inventing a new
18
+ assertion shape. To probe a running game by hand, every bridge global and its shape is
19
+ documented in `agent-docs/debug-surface.md`.
20
+
21
+ The bridge registers exactly one resource id for the JSON-safe game state: `state`; resource
22
+ paths address fields from `ctx.state`. (`GameState` is a deprecated compatibility alias kept
23
+ until published scenarios migrate.)