create-threenative 0.2.0

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 (320) hide show
  1. package/README.md +16 -0
  2. package/dist/index.d.ts +30 -0
  3. package/dist/index.js +283 -0
  4. package/dist/threenative.d.ts +6 -0
  5. package/dist/threenative.js +757 -0
  6. package/package.json +44 -0
  7. package/templates/action-rpg/.mcp.json +16 -0
  8. package/templates/action-rpg/AGENTS.md +40 -0
  9. package/templates/action-rpg/CLAUDE.md +42 -0
  10. package/templates/action-rpg/index.html +13 -0
  11. package/templates/action-rpg/kit.json +7 -0
  12. package/templates/action-rpg/package.json +47 -0
  13. package/templates/action-rpg/playtests/combat.playtest.json +61 -0
  14. package/templates/action-rpg/playtests/fail.playtest.json +21 -0
  15. package/templates/action-rpg/playtests/inventory.playtest.json +111 -0
  16. package/templates/action-rpg/playtests/progress.playtest.json +99 -0
  17. package/templates/action-rpg/playtests/survives.playtest.json +32 -0
  18. package/templates/action-rpg/playtests/win.playtest.json +30 -0
  19. package/templates/action-rpg/public/favicon.svg +5 -0
  20. package/templates/action-rpg/src/abilities/Ability.ts +45 -0
  21. package/templates/action-rpg/src/entities/Enemy.ts +143 -0
  22. package/templates/action-rpg/src/entities/Player.ts +83 -0
  23. package/templates/action-rpg/src/game.ts +40 -0
  24. package/templates/action-rpg/src/items/Inventory.ts +163 -0
  25. package/templates/action-rpg/src/loot/drops.ts +40 -0
  26. package/templates/action-rpg/src/main.ts +15 -0
  27. package/templates/action-rpg/src/physics.ts +40 -0
  28. package/templates/action-rpg/src/playtest-events.ts +15 -0
  29. package/templates/action-rpg/src/progress.ts +35 -0
  30. package/templates/action-rpg/src/render/camera.ts +26 -0
  31. package/templates/action-rpg/src/render/lighting.ts +30 -0
  32. package/templates/action-rpg/src/render/loading.ts +90 -0
  33. package/templates/action-rpg/src/render/materials.ts +40 -0
  34. package/templates/action-rpg/src/render/palette.ts +9 -0
  35. package/templates/action-rpg/src/render/postprocessing.ts +18 -0
  36. package/templates/action-rpg/src/render/shapes.ts +110 -0
  37. package/templates/action-rpg/src/render/sky.ts +18 -0
  38. package/templates/action-rpg/src/render/types.ts +3 -0
  39. package/templates/action-rpg/src/scenes/Boot.ts +12 -0
  40. package/templates/action-rpg/src/scenes/Play.ts +449 -0
  41. package/templates/action-rpg/src/state.ts +40 -0
  42. package/templates/action-rpg/src/stats/StatBlock.ts +57 -0
  43. package/templates/action-rpg/src/style.css +32 -0
  44. package/templates/action-rpg/src/ui/AbilityBar.tsx +28 -0
  45. package/templates/action-rpg/src/ui/App.tsx +21 -0
  46. package/templates/action-rpg/src/ui/CharacterPanel.tsx +31 -0
  47. package/templates/action-rpg/src/ui/Hud.tsx +29 -0
  48. package/templates/action-rpg/src/ui/InventoryPanel.tsx +37 -0
  49. package/templates/action-rpg/tailwind.config.ts +7 -0
  50. package/templates/action-rpg/threenative.config.ts +29 -0
  51. package/templates/action-rpg/tsconfig.json +17 -0
  52. package/templates/action-rpg/vite.config.ts +8 -0
  53. package/templates/defense/.mcp.json +16 -0
  54. package/templates/defense/AGENTS.md +53 -0
  55. package/templates/defense/CLAUDE.md +55 -0
  56. package/templates/defense/README.md +9 -0
  57. package/templates/defense/index.html +13 -0
  58. package/templates/defense/kit.json +7 -0
  59. package/templates/defense/package.json +46 -0
  60. package/templates/defense/playtests/leak.playtest.json +18 -0
  61. package/templates/defense/playtests/placement.playtest.json +40 -0
  62. package/templates/defense/playtests/scan.playtest.json +20 -0
  63. package/templates/defense/playtests/survive.playtest.json +26 -0
  64. package/templates/defense/playtests/survives.playtest.json +36 -0
  65. package/templates/defense/public/favicon.svg +5 -0
  66. package/templates/defense/src/attackers/Attacker.ts +104 -0
  67. package/templates/defense/src/board/Route.ts +80 -0
  68. package/templates/defense/src/economy.ts +36 -0
  69. package/templates/defense/src/entities/Player.ts +44 -0
  70. package/templates/defense/src/game.ts +30 -0
  71. package/templates/defense/src/main.ts +15 -0
  72. package/templates/defense/src/physics.ts +43 -0
  73. package/templates/defense/src/placement/Buildable.ts +49 -0
  74. package/templates/defense/src/playtest-events.ts +15 -0
  75. package/templates/defense/src/render/camera.ts +10 -0
  76. package/templates/defense/src/render/lighting.ts +32 -0
  77. package/templates/defense/src/render/loading.ts +89 -0
  78. package/templates/defense/src/render/materials.ts +13 -0
  79. package/templates/defense/src/render/palette.ts +21 -0
  80. package/templates/defense/src/render/postprocessing.ts +14 -0
  81. package/templates/defense/src/render/shapes.ts +89 -0
  82. package/templates/defense/src/render/sky.ts +45 -0
  83. package/templates/defense/src/scenes/Boot.ts +12 -0
  84. package/templates/defense/src/scenes/Defense.ts +165 -0
  85. package/templates/defense/src/state.ts +50 -0
  86. package/templates/defense/src/style.css +32 -0
  87. package/templates/defense/src/towers/Tower.ts +96 -0
  88. package/templates/defense/src/towers/targeting.ts +53 -0
  89. package/templates/defense/src/ui/App.tsx +17 -0
  90. package/templates/defense/src/ui/Hud.tsx +61 -0
  91. package/templates/defense/src/ui/Menu.tsx +7 -0
  92. package/templates/defense/src/waves.ts +40 -0
  93. package/templates/defense/tailwind.config.ts +1 -0
  94. package/templates/defense/threenative.config.ts +29 -0
  95. package/templates/defense/tsconfig.json +17 -0
  96. package/templates/defense/vite.config.ts +5 -0
  97. package/templates/minimal/.mcp.json +16 -0
  98. package/templates/minimal/AGENTS.md +400 -0
  99. package/templates/minimal/CLAUDE.md +402 -0
  100. package/templates/minimal/assets/.gitkeep +0 -0
  101. package/templates/minimal/index.html +14 -0
  102. package/templates/minimal/kit.json +7 -0
  103. package/templates/minimal/package.json +40 -0
  104. package/templates/minimal/playtests/play.playtest.json +32 -0
  105. package/templates/minimal/playtests/survives.playtest.json +32 -0
  106. package/templates/minimal/public/.gitkeep +0 -0
  107. package/templates/minimal/public/favicon.svg +4 -0
  108. package/templates/minimal/public/icon.png +0 -0
  109. package/templates/minimal/src/entities/Player.ts +66 -0
  110. package/templates/minimal/src/game.ts +28 -0
  111. package/templates/minimal/src/main.ts +17 -0
  112. package/templates/minimal/src/render/camera.ts +11 -0
  113. package/templates/minimal/src/render/hud.ts +53 -0
  114. package/templates/minimal/src/render/lighting.ts +46 -0
  115. package/templates/minimal/src/render/loading.ts +113 -0
  116. package/templates/minimal/src/render/materials.ts +16 -0
  117. package/templates/minimal/src/render/palette.ts +9 -0
  118. package/templates/minimal/src/render/postprocessing.ts +20 -0
  119. package/templates/minimal/src/render/sky.ts +41 -0
  120. package/templates/minimal/src/scenes/Boot.ts +5 -0
  121. package/templates/minimal/src/scenes/Play.ts +65 -0
  122. package/templates/minimal/src/state.ts +1 -0
  123. package/templates/minimal/src/style.css +41 -0
  124. package/templates/minimal/threenative.config.ts +32 -0
  125. package/templates/minimal/tsconfig.json +16 -0
  126. package/templates/minimal/vite.config.ts +3 -0
  127. package/templates/platformer/.mcp.json +16 -0
  128. package/templates/platformer/AGENTS.md +199 -0
  129. package/templates/platformer/CLAUDE.md +201 -0
  130. package/templates/platformer/assets/.gitkeep +0 -0
  131. package/templates/platformer/index.html +13 -0
  132. package/templates/platformer/kit.json +7 -0
  133. package/templates/platformer/package.json +50 -0
  134. package/templates/platformer/playtests/avoidance.playtest.json +23 -0
  135. package/templates/platformer/playtests/buffer.playtest.json +17 -0
  136. package/templates/platformer/playtests/chase.playtest.json +21 -0
  137. package/templates/platformer/playtests/collect.playtest.json +56 -0
  138. package/templates/platformer/playtests/collision-layers.playtest.json +36 -0
  139. package/templates/platformer/playtests/coyote.playtest.json +21 -0
  140. package/templates/platformer/playtests/damage.playtest.json +31 -0
  141. package/templates/platformer/playtests/dash.playtest.json +21 -0
  142. package/templates/platformer/playtests/jump.playtest.json +21 -0
  143. package/templates/platformer/playtests/oneway.playtest.json +17 -0
  144. package/templates/platformer/playtests/patrol.playtest.json +13 -0
  145. package/templates/platformer/playtests/performance.playtest.json +21 -0
  146. package/templates/platformer/playtests/physics.playtest.json +14 -0
  147. package/templates/platformer/playtests/respawn.playtest.json +31 -0
  148. package/templates/platformer/playtests/stomp-rise.playtest.json +41 -0
  149. package/templates/platformer/playtests/stomp.playtest.json +34 -0
  150. package/templates/platformer/playtests/survives.playtest.json +32 -0
  151. package/templates/platformer/playtests/terminal-loop-fail.playtest.json +29 -0
  152. package/templates/platformer/playtests/terminal-loop-win.playtest.json +52 -0
  153. package/templates/platformer/public/.gitkeep +0 -0
  154. package/templates/platformer/public/favicon.svg +4 -0
  155. package/templates/platformer/public/icon.png +0 -0
  156. package/templates/platformer/src/entities/Character.ts +218 -0
  157. package/templates/platformer/src/entities/Chaser.ts +118 -0
  158. package/templates/platformer/src/entities/Patrol.ts +88 -0
  159. package/templates/platformer/src/entities/Pickup.ts +72 -0
  160. package/templates/platformer/src/game.ts +27 -0
  161. package/templates/platformer/src/level/Checkpoints.ts +66 -0
  162. package/templates/platformer/src/level/Platform.ts +34 -0
  163. package/templates/platformer/src/main.ts +14 -0
  164. package/templates/platformer/src/playtest-events.ts +15 -0
  165. package/templates/platformer/src/render/camera.ts +8 -0
  166. package/templates/platformer/src/render/lighting.ts +38 -0
  167. package/templates/platformer/src/render/loading.ts +113 -0
  168. package/templates/platformer/src/render/materials.ts +11 -0
  169. package/templates/platformer/src/render/palette.ts +54 -0
  170. package/templates/platformer/src/render/postprocessing.ts +18 -0
  171. package/templates/platformer/src/render/rig.ts +60 -0
  172. package/templates/platformer/src/render/sky.ts +47 -0
  173. package/templates/platformer/src/render/terrain.ts +31 -0
  174. package/templates/platformer/src/render/touch-controls.ts +157 -0
  175. package/templates/platformer/src/render/touch-layout.ts +63 -0
  176. package/templates/platformer/src/scenes/Boot.ts +12 -0
  177. package/templates/platformer/src/scenes/Level.ts +176 -0
  178. package/templates/platformer/src/state.ts +23 -0
  179. package/templates/platformer/src/style.css +31 -0
  180. package/templates/platformer/src/ui/App.tsx +17 -0
  181. package/templates/platformer/src/ui/Hud.tsx +41 -0
  182. package/templates/platformer/src/ui/Menu.tsx +7 -0
  183. package/templates/platformer/tailwind.config.ts +2 -0
  184. package/templates/platformer/threenative.config.ts +32 -0
  185. package/templates/platformer/tsconfig.json +17 -0
  186. package/templates/platformer/vite.config.ts +5 -0
  187. package/templates/racing/.mcp.json +16 -0
  188. package/templates/racing/AGENTS.md +48 -0
  189. package/templates/racing/CLAUDE.md +50 -0
  190. package/templates/racing/index.html +13 -0
  191. package/templates/racing/kit.json +7 -0
  192. package/templates/racing/package.json +46 -0
  193. package/templates/racing/playtests/boost.playtest.json +45 -0
  194. package/templates/racing/playtests/outcome.playtest.json +78 -0
  195. package/templates/racing/playtests/ranking.playtest.json +37 -0
  196. package/templates/racing/playtests/rescue.playtest.json +28 -0
  197. package/templates/racing/playtests/reverse.playtest.json +37 -0
  198. package/templates/racing/playtests/shortcut.playtest.json +44 -0
  199. package/templates/racing/playtests/survives.playtest.json +32 -0
  200. package/templates/racing/public/favicon.svg +6 -0
  201. package/templates/racing/src/entities/RacingCar.ts +114 -0
  202. package/templates/racing/src/entities/Rival.ts +46 -0
  203. package/templates/racing/src/game.ts +29 -0
  204. package/templates/racing/src/kart/boost.ts +38 -0
  205. package/templates/racing/src/main.ts +15 -0
  206. package/templates/racing/src/playtest-events.ts +15 -0
  207. package/templates/racing/src/render/camera.ts +28 -0
  208. package/templates/racing/src/render/lighting.ts +32 -0
  209. package/templates/racing/src/render/loading.ts +58 -0
  210. package/templates/racing/src/render/materials.ts +15 -0
  211. package/templates/racing/src/render/palette.ts +30 -0
  212. package/templates/racing/src/render/postprocessing.ts +14 -0
  213. package/templates/racing/src/render/shapes.ts +37 -0
  214. package/templates/racing/src/render/sky.ts +45 -0
  215. package/templates/racing/src/scenes/Boot.ts +12 -0
  216. package/templates/racing/src/scenes/Race.ts +180 -0
  217. package/templates/racing/src/state.ts +35 -0
  218. package/templates/racing/src/style.css +32 -0
  219. package/templates/racing/src/track/Checkline.ts +19 -0
  220. package/templates/racing/src/track/Lap.ts +104 -0
  221. package/templates/racing/src/track/Ranking.ts +35 -0
  222. package/templates/racing/src/track/Track.ts +229 -0
  223. package/templates/racing/src/track/TrackSector.ts +77 -0
  224. package/templates/racing/src/track/rescue.ts +21 -0
  225. package/templates/racing/src/ui/App.tsx +17 -0
  226. package/templates/racing/src/ui/Hud.tsx +71 -0
  227. package/templates/racing/src/ui/Menu.tsx +7 -0
  228. package/templates/racing/tailwind.config.ts +2 -0
  229. package/templates/racing/threenative.config.ts +29 -0
  230. package/templates/racing/tsconfig.json +17 -0
  231. package/templates/racing/vite.config.ts +5 -0
  232. package/templates/shooter/.mcp.json +16 -0
  233. package/templates/shooter/AGENTS.md +69 -0
  234. package/templates/shooter/CLAUDE.md +71 -0
  235. package/templates/shooter/index.html +13 -0
  236. package/templates/shooter/kit.json +7 -0
  237. package/templates/shooter/package.json +46 -0
  238. package/templates/shooter/playtests/fail.playtest.json +30 -0
  239. package/templates/shooter/playtests/shooter.playtest.json +89 -0
  240. package/templates/shooter/playtests/survives.playtest.json +32 -0
  241. package/templates/shooter/public/favicon.svg +4 -0
  242. package/templates/shooter/src/combat/damage.ts +41 -0
  243. package/templates/shooter/src/entities/Pickup.ts +70 -0
  244. package/templates/shooter/src/entities/Player.ts +93 -0
  245. package/templates/shooter/src/entities/Target.ts +103 -0
  246. package/templates/shooter/src/game.ts +36 -0
  247. package/templates/shooter/src/level/SpawnPoints.ts +28 -0
  248. package/templates/shooter/src/main.ts +26 -0
  249. package/templates/shooter/src/physics.ts +49 -0
  250. package/templates/shooter/src/playtest-events.ts +15 -0
  251. package/templates/shooter/src/render/camera.ts +29 -0
  252. package/templates/shooter/src/render/lighting.ts +38 -0
  253. package/templates/shooter/src/render/loading.ts +86 -0
  254. package/templates/shooter/src/render/materials.ts +38 -0
  255. package/templates/shooter/src/render/palette.ts +9 -0
  256. package/templates/shooter/src/render/postprocessing.ts +19 -0
  257. package/templates/shooter/src/render/shapes.ts +194 -0
  258. package/templates/shooter/src/render/sky.ts +37 -0
  259. package/templates/shooter/src/render/types.ts +3 -0
  260. package/templates/shooter/src/render/ui.css +212 -0
  261. package/templates/shooter/src/render/ui.ts +59 -0
  262. package/templates/shooter/src/scenes/Boot.ts +12 -0
  263. package/templates/shooter/src/scenes/Play.ts +428 -0
  264. package/templates/shooter/src/state.ts +29 -0
  265. package/templates/shooter/src/ui/App.tsx +25 -0
  266. package/templates/shooter/src/ui/Hud.tsx +49 -0
  267. package/templates/shooter/src/ui/Menu.tsx +26 -0
  268. package/templates/shooter/src/waves.ts +50 -0
  269. package/templates/shooter/src/weapons/Hitscan.ts +43 -0
  270. package/templates/shooter/src/weapons/Projectile.ts +76 -0
  271. package/templates/shooter/tailwind.config.ts +5 -0
  272. package/templates/shooter/threenative.config.ts +29 -0
  273. package/templates/shooter/tsconfig.json +17 -0
  274. package/templates/shooter/vite.config.ts +8 -0
  275. package/templates/starter/.mcp.json +16 -0
  276. package/templates/starter/AGENTS.md +450 -0
  277. package/templates/starter/CLAUDE.md +452 -0
  278. package/templates/starter/assets/.gitkeep +0 -0
  279. package/templates/starter/index.html +13 -0
  280. package/templates/starter/kit.json +7 -0
  281. package/templates/starter/package.json +49 -0
  282. package/templates/starter/playtests/buffer.playtest.json +29 -0
  283. package/templates/starter/playtests/coyote.playtest.json +35 -0
  284. package/templates/starter/playtests/forward.playtest.json +15 -0
  285. package/templates/starter/playtests/hot-reload.playtest.json +28 -0
  286. package/templates/starter/playtests/look.playtest.json +43 -0
  287. package/templates/starter/playtests/monitoring.playtest.json +41 -0
  288. package/templates/starter/playtests/pause.playtest.json +33 -0
  289. package/templates/starter/playtests/play.playtest.json +16 -0
  290. package/templates/starter/playtests/respawn.playtest.json +28 -0
  291. package/templates/starter/playtests/restart.playtest.json +36 -0
  292. package/templates/starter/playtests/seed.playtest.json +18 -0
  293. package/templates/starter/playtests/survives.playtest.json +32 -0
  294. package/templates/starter/public/.gitkeep +0 -0
  295. package/templates/starter/public/favicon.svg +4 -0
  296. package/templates/starter/public/icon.png +0 -0
  297. package/templates/starter/public/native-proof.glb +0 -0
  298. package/templates/starter/public/native-proof.png +0 -0
  299. package/templates/starter/public/pickup.ogg +0 -0
  300. package/templates/starter/src/entities/Crate.ts +34 -0
  301. package/templates/starter/src/entities/Player.ts +80 -0
  302. package/templates/starter/src/game.ts +30 -0
  303. package/templates/starter/src/main.ts +15 -0
  304. package/templates/starter/src/render/camera.ts +57 -0
  305. package/templates/starter/src/render/lighting.ts +55 -0
  306. package/templates/starter/src/render/materials.ts +12 -0
  307. package/templates/starter/src/render/palette.ts +9 -0
  308. package/templates/starter/src/render/postprocessing.ts +18 -0
  309. package/templates/starter/src/render/shapes.ts +147 -0
  310. package/templates/starter/src/render/sky.ts +56 -0
  311. package/templates/starter/src/scenes/Play.ts +161 -0
  312. package/templates/starter/src/state.ts +10 -0
  313. package/templates/starter/src/style.css +45 -0
  314. package/templates/starter/src/ui/App.tsx +19 -0
  315. package/templates/starter/src/ui/Hud.tsx +37 -0
  316. package/templates/starter/src/ui/Menu.tsx +43 -0
  317. package/templates/starter/tailwind.config.ts +2 -0
  318. package/templates/starter/threenative.config.ts +31 -0
  319. package/templates/starter/tsconfig.json +17 -0
  320. package/templates/starter/vite.config.ts +8 -0
@@ -0,0 +1,76 @@
1
+ import type { ICtx } from "@threenative/core";
2
+ import { CollisionShape3D, type IPhysicsContext, RigidBody3D } from "@threenative/physics";
3
+ import type { Mesh, Vector3 } from "three";
4
+ import { PROJECTILE_LAYER } from "../entities/Player.js";
5
+ import { type IRayHit, directSpaceState } from "../physics.js";
6
+ import { createProjectileVisual } from "../render/shapes.js";
7
+ import type { GameState } from "../state.js";
8
+
9
+ type GameCtx = ICtx<GameState, IPhysicsContext>;
10
+
11
+ export class Projectile {
12
+ readonly mesh: Mesh;
13
+ readonly body: RigidBody3D;
14
+ readonly tags = ["projectile"];
15
+ #direction: Vector3;
16
+ #life = 2.4;
17
+ #speed = 10;
18
+ #collisionMask: number;
19
+ #onHit: (hit: IRayHit) => void;
20
+ #dead = false;
21
+
22
+ constructor(
23
+ ctx: GameCtx,
24
+ materials: Parameters<typeof createProjectileVisual>[0],
25
+ origin: Vector3,
26
+ direction: Vector3,
27
+ collisionMask: number,
28
+ onHit: (hit: IRayHit) => void,
29
+ ) {
30
+ this.#collisionMask = collisionMask;
31
+ this.#direction = direction.clone().normalize();
32
+ this.#onHit = onHit;
33
+ this.mesh = createProjectileVisual(materials);
34
+ this.mesh.position.copy(origin);
35
+ ctx.add(this.mesh);
36
+ this.body = new RigidBody3D({
37
+ collisionLayer: PROJECTILE_LAYER,
38
+ collisionMask,
39
+ object: this.mesh,
40
+ physics: ctx.physics,
41
+ shape: CollisionShape3D.sphere(0.12),
42
+ type: "kinematic",
43
+ });
44
+ }
45
+
46
+ get dead(): boolean {
47
+ return this.#dead;
48
+ }
49
+
50
+ update(ctx: GameCtx, dt: number): void {
51
+ if (this.#dead) return;
52
+ this.#life -= dt;
53
+ if (this.#life <= 0) {
54
+ this.#dead = true;
55
+ return;
56
+ }
57
+ const from = this.mesh.position.clone();
58
+ const to = from.clone().addScaledVector(this.#direction, this.#speed * dt);
59
+ const hit = directSpaceState(ctx.physics).intersectRay({
60
+ collisionMask: this.#collisionMask,
61
+ from,
62
+ to,
63
+ });
64
+ if (hit !== undefined) {
65
+ this.#dead = true;
66
+ this.#onHit(hit);
67
+ return;
68
+ }
69
+ this.mesh.position.copy(to);
70
+ }
71
+
72
+ dispose(): void {
73
+ this.body.dispose();
74
+ this.mesh.removeFromParent();
75
+ }
76
+ }
@@ -0,0 +1,5 @@
1
+ import type { Config } from "tailwindcss";
2
+
3
+ export default {
4
+ content: ["./index.html", "./src/**/*.{ts,tsx}"],
5
+ } satisfies Config;
@@ -0,0 +1,29 @@
1
+ import type { IThreeNativeConfig } from "@threenative/core";
2
+
3
+ export default {
4
+ app: {
5
+ id: "com.threenative.__PROJECT_ID__",
6
+ name: "__PROJECT_NAME__",
7
+ version: "1.0.0",
8
+ build: 1,
9
+ },
10
+ display: {
11
+ orientation: "landscape",
12
+ fullscreen: true,
13
+ keepScreenOn: true,
14
+ },
15
+ window: {
16
+ title: "__PROJECT_NAME__",
17
+ width: 1280,
18
+ height: 720,
19
+ resizable: true,
20
+ },
21
+ loading: {
22
+ backdropColor: "#090d13",
23
+ trackColor: "#172533",
24
+ progressColor: "#f6c85f",
25
+ showProgressBar: true,
26
+ },
27
+ nativeEntry: "src/game.ts",
28
+ renderer: { preferWebGPU: true },
29
+ } satisfies IThreeNativeConfig;
@@ -0,0 +1,17 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2022",
4
+ "lib": ["ES2022", "DOM", "DOM.Iterable"],
5
+ "module": "ESNext",
6
+ "moduleResolution": "bundler",
7
+ "jsx": "react-jsx",
8
+ "types": ["vite/client"],
9
+ "strict": true,
10
+ "noUncheckedIndexedAccess": true,
11
+ "noEmit": true,
12
+ "skipLibCheck": true,
13
+ "verbatimModuleSyntax": true,
14
+ "isolatedModules": true
15
+ },
16
+ "include": ["src/**/*.ts", "src/**/*.tsx", "tests/**/*.ts", "*.ts"]
17
+ }
@@ -0,0 +1,8 @@
1
+ import tailwindcss from "@tailwindcss/vite";
2
+ import react from "@vitejs/plugin-react";
3
+ import { defineConfig } from "vite";
4
+
5
+ export default defineConfig({
6
+ plugins: [react(), tailwindcss()],
7
+ server: { watch: { usePolling: true } },
8
+ });
@@ -0,0 +1,16 @@
1
+ {
2
+ "mcpServers": {
3
+ "threenative-assets": {
4
+ "command": "node",
5
+ "args": ["./node_modules/threenative-asset-mcp/dist/index.js"],
6
+ "env": {
7
+ "ASSET_DOWNLOAD_DIR": "./public/assets",
8
+ "AUDIO_DOWNLOAD_DIR": "./public/audio"
9
+ }
10
+ },
11
+ "threenative-sculpt": {
12
+ "command": "node",
13
+ "args": ["./node_modules/threenative-sculpt-mcp/dist/server.js"]
14
+ }
15
+ }
16
+ }
@@ -0,0 +1,450 @@
1
+ # AGENTS.md — __PROJECT_NAME__
2
+
3
+ Instructions for the AI agent working in this game. This project was scaffolded with
4
+ `create-threenative`. `CLAUDE.md` is a copy of this file; edit this one.
5
+
6
+ ## What the framework owns, and what you own
7
+
8
+ ThreeNative owns the plumbing: renderer bootstrap and WebGPU fallback, the fixed-step loop,
9
+ scene lifecycle, input mapping, asset loading, the physics binding, and the state bridge to
10
+ React.
11
+
12
+ **You own everything a player sees.** `src/render/`, `src/entities/`, `src/scenes/`, and
13
+ `src/ui/` are ordinary code in this repository. Nothing in `@threenative/*` reads them.
14
+ Rewrite or delete any of it.
15
+
16
+ ## Commands
17
+
18
+ ```sh
19
+ pnpm dev # Vite dev server
20
+ pnpm studio # chat, preview and proof in one page; needs claude or codex
21
+ pnpm build # web build; identical to vite build
22
+ pnpm build --target desktop # native executable; Linux is the only verified host
23
+ pnpm test # build, start the dev server, and run the committed playtest
24
+ ```
25
+
26
+ The normal `@threenative/physics` API selects native Rapier on Android; its source-workspace
27
+ APK and emulator scenario are proven without Rapier WASM. A published scaffold still cannot
28
+ ship Android or iOS until signed prebuilt runtime assets and their checksum manifest exist,
29
+ so those targets fail closed for consumers. Linux desktop is source-machine evidence, not a
30
+ clean-machine distribution proof; macOS, Windows, iOS, and physical hardware remain OPEN.
31
+
32
+ ## Keep the game portable to native
33
+
34
+ `pnpm build --target desktop` runs this same source on a native host with **no browser**.
35
+ Four things break there, and none of them fail on the web build:
36
+
37
+ 1. **The native host has no DOM and does not run React.** The starter's single HUD is the
38
+ web-only `src/ui/Hud.tsx`; native builds ship `src/scenes/` and `src/render/` without
39
+ `src/ui/`. Gameplay, scoring and state transitions live in the scene; add a native HUD in
40
+ your game-owned render code only if your game needs one.
41
+ 2. **No `document`, `window`, or `localStorage` reach outside the canvas.** Use `ctx` and
42
+ Three.js. Save games go through your own JSON, not `window.localStorage` directly.
43
+ 3. **No dynamic `import()`.** The native build is one bundled file.
44
+ 4. **`.raw` is web-only.** `ctx.physics.world.raw` is a Rapier object in the browser and
45
+ opaque on native. Anything reading it is a web-only code path by contract.
46
+
47
+ Writing against `ctx`, `three`, and the Godot-named physics nodes keeps all four correct
48
+ without thinking about it. If you only ever ship to the web, ignore this section.
49
+
50
+ ## The layout
51
+
52
+ ```mermaid
53
+ flowchart TD
54
+ project["generated project"]
55
+ src["src/"]
56
+ main["main.ts<br/>defineGame(...) + React mount"]
57
+ play["scenes/Play.ts<br/>gameplay: load, enter, update, exit"]
58
+ entities["entities/<br/>Player.ts, Crate.ts — plain classes, not an ECS"]
59
+ render["render/<br/>palette, camera, sky, lighting,<br/>materials, post — YOURS"]
60
+ ui["ui/<br/>App.tsx, Hud.tsx, Menu.tsx — React 19 + Tailwind 4"]
61
+ state["state.ts<br/>state shape the HUD subscribes to"]
62
+ scenarios["playtests/*.playtest.json<br/>committed browser scenarios, run by pnpm test"]
63
+ config["threenative.config.ts<br/>app identity, icon, display, desktop window, renderer"]
64
+
65
+ project --> src
66
+ src --> main
67
+ src --> play
68
+ src --> entities
69
+ src --> render
70
+ src --> ui
71
+ src --> state
72
+ project --> scenarios
73
+ project --> config
74
+ ```
75
+
76
+ `threenative.config.ts` is the one game-owned app-shape file. Set the launcher identity and
77
+ icon, mobile orientation and display flags, desktop window, renderer preference, and native
78
+ entry there. `package.json` may retain only `threenative.nativeEntry` as a compatibility
79
+ fallback for older projects.
80
+
81
+ `src/ui/Hud.tsx` is the starter's single HUD. It reads `game.state` through `useGameState`; keep
82
+ gameplay and state transitions in the portable scene rather than in the React component.
83
+ Touch controls are not generated yet: add the small pointer-action mapping after the core
84
+ multitouch surface from PRD-053 lands.
85
+
86
+ ## How to write gameplay here
87
+
88
+ A scene is a class with optional `load`, `enter`, `update`, `exit`, and `render`. That is
89
+ the whole lifecycle — there is nothing else to register.
90
+
91
+ `ctx` hands you real Three.js objects and backend-neutral physics handles:
92
+
93
+ ```ts
94
+ ctx.scene // THREE.Scene
95
+ ctx.camera // THREE.PerspectiveCamera
96
+ ctx.renderer // the renderer
97
+ ctx.physics.world // PhysicsWorldHandle
98
+ player.body // PhysicsBodyHandle (via CharacterBody3D)
99
+ player.mesh // THREE.Mesh
100
+ ```
101
+
102
+ The physics handles expose `.raw` as an explicitly backend-specific escape hatch: Rapier on
103
+ web, opaque on native. Code that reads `.raw` is not portable between those targets.
104
+
105
+ Any Three.js tutorial, StackOverflow answer, or snippet you already know works unchanged
106
+ inside a scene. Prefer that over hunting for a framework wrapper — **for anything Three.js
107
+ itself does (geometry, materials, lights, math), there is no wrapper and you should write
108
+ the Three.js.** The exception is the loop: scene changes, timers and tweens are on `ctx`,
109
+ not in an import, so grepping the imports of an existing file will not find them. The
110
+ table below is the complete list.
111
+
112
+ Physics uses Godot's names: `RigidBody3D`, `Area3D`, `CharacterBody3D`, `CollisionShape3D`.
113
+ Every node has `dispose()`. Register disposable entities with `ctx.entities`; the framework
114
+ clears registered entities, scene objects, and physics nodes when a scene exits. Dispose a
115
+ node explicitly only when removing it during play. **The id is the name a scenario resolves.** A playtest `subject`, and every `movement` or
116
+ `visibility` assertion, looks the entity up by that string — an unregistered player fails
117
+ `TN_PLAYTEST_VISIBILITY_FAILED` however visible it is on screen.
118
+
119
+ `input.vector("move").y` is +up; map it to world-space -z for forward with one explicit
120
+ `-move.y` conversion in the player movement code.
121
+
122
+ `CharacterBody3D.moveAndSlide(dt)` owns gravity through `body.velocity`; the player keeps
123
+ the coyote-time and jump-buffer timers in the entity so jump feel stays game-owned.
124
+
125
+ ## The `ctx` surface — you already have these, do not rebuild them
126
+
127
+ `ctx` carries six things that get reimplemented by hand in almost every project, because
128
+ they are **properties on `ctx`, never imports** — grepping an existing file's imports will
129
+ never surface them. This table is the complete list.
130
+
131
+ | You already have | Rather than | Signature |
132
+ |---|---|---|
133
+ | `ctx.goto("play")` | a hand-written `#reset()` | `(name: string) => Promise<void>` |
134
+ | `ctx.tween(obj, { y: 2 }, 0.4)` | a `Math.sin` / `lerp` accumulator | `(target, props, seconds) => Promise<void>` |
135
+ | `ctx.after(0.8, fn)` | `elapsed += dt; if (elapsed > 0.8)` | `(seconds, cb) => ScheduleHandle` |
136
+ | `ctx.every(fn)` | a per-frame branch in `update` | `(cb: (dt: number) => void) => ScheduleHandle` |
137
+ | `ctx.random.range(-1, 1)` | `Math.random()` | seeded — a replay produces identical results |
138
+ | `ctx.raycast()` | `new Raycaster()` + `intersectObject` | `(options?: { screen?, targets? }) => Intersection \| undefined` |
139
+
140
+ **`ctx.raycast()` is how you pick geometry under the pointer.** It defaults to the current
141
+ pointer position and the whole scene, returns the nearest `THREE.Intersection`, and stays
142
+ under a millisecond on meshes large enough that a plain `Raycaster` visibly stutters — it
143
+ keeps an acceleration structure per geometry and rebuilds it when that geometry's positions
144
+ change. Pass `{ targets }` to narrow it, `{ screen }` to test a point that is not the
145
+ pointer. Skinned, instanced and morphed meshes fall back
146
+ to the stock Three.js path automatically, so the result always matches
147
+ `Raycaster.intersectObject`.
148
+
149
+ **`ctx.goto(name)` restarts the current scene.** Calling `ctx.goto("play")` from inside
150
+ `Play` tears the scene down and rebuilds it: `exit()` runs, scheduled callbacks are cleared,
151
+ registered entities are cleared, the Three scene is emptied, then a fresh instance runs
152
+ `load()` and `enter()`. That is your entire restart button, and your entire death-and-retry.
153
+
154
+ Do **not** write a `#reset()` that walks your entities putting them back. It is ~15 lines
155
+ that look right and quietly miss the scheduler and anything you spawned after `enter()`, so
156
+ the second playthrough behaves differently from the first — and no gate in this project will
157
+ catch that.
158
+
159
+ **One rule when calling it from a frame function: `goto` and then `return`, immediately.**
160
+
161
+ ```ts
162
+ if (player.dead) {
163
+ void ctx.goto("play");
164
+ return; // ← required. Everything below now runs against a torn-down scene.
165
+ }
166
+ ```
167
+
168
+ From React, the same call is `game.goto("play")` — use that for a restart button instead of
169
+ routing a counter through game state.
170
+
171
+ **`ctx.tween` is for timing, not for looks.** Use it for the *when* — a pickup rising over
172
+ 0.4s, a door opening, a hit flash — and keep the *what* (colour, shape, easing feel) in
173
+ `src/render/`. Motion driven by a persistent `Math.sin(elapsed)` in `update()` is still the
174
+ right tool for a continuous idle bob; `tween` is for anything that starts, runs once, and
175
+ finishes.
176
+
177
+ **`ctx.random` is seeded from `defineGame({ seed })`.** Use it for anything a playtest needs
178
+ to reproduce — spawn positions, patrol offsets, level variation. `Math.random()` makes a
179
+ scenario that passes once and fails on replay for no visible reason.
180
+
181
+ ## Save and load
182
+
183
+ Save only the state you declare. The framework does not serialize entities, scene graphs, or
184
+ physics handles, and it never will; save those fields in your own object literal:
185
+
186
+ ```ts
187
+ const save = JSON.stringify({ state: ctx.state.getState(), playerX: player.mesh.position.x });
188
+ const loaded = JSON.parse(save) as { state: GameState; playerX: number };
189
+ ctx.state.set(loaded.state);
190
+ player.body.teleport({ x: loaded.playerX, y: player.mesh.position.y, z: player.mesh.position.z });
191
+ ```
192
+
193
+ ## Assets and animation
194
+
195
+ `AnimationPlayer` is exported by `@threenative/core` for clips from a rigged asset. Put a
196
+ `.glb` in `public/`, await `ctx.assets.model("hero.glb")` in `Scene.load()`, then construct
197
+ and update the `AnimationPlayer` beside the entity that owns the loaded model. This starter
198
+ does not ship a rigged asset; adding one belongs in `public/`, not in the framework.
199
+
200
+ Entities are plain classes. There is no ECS, and adding one is a real decision, not a
201
+ default — `pnpm add miniplex` if a game genuinely needs it.
202
+
203
+ ## Finding assets — you have an MCP server for this
204
+
205
+ **Reach for it when the asset is conventional; build anything custom yourself.**
206
+
207
+ - **Textures, materials, HDRIs and sound effects — prefer the tools.** Rusted metal, oak
208
+ planks, a studio HDRI, a UI click: these are well-established and a CC0 one beats what you
209
+ would hand-author.
210
+ - **Models — only when the thing is conventional.** A car, a plane, a crate, a barrel, a
211
+ tree, a chair. If this game's main character is a car, fetching a compatible `.glb` is the
212
+ right call.
213
+ - **Anything specific to this game — write it in `src/render/`.** A downloaded model standing
214
+ in for a bespoke design reads as a weird asset dropped into the scene, and it looks worse
215
+ than a clean composition of primitives. This is the failure the tools make easy.
216
+
217
+ When in doubt, build it programmatically. A fetched asset has to match what the game needs,
218
+ not merely exist.
219
+
220
+ `.mcp.json` in this project launches `threenative-asset-mcp` from `node_modules`, so your host
221
+ lists its tools alongside your own. It advertises 32; these 8 are the loop you will use for
222
+ nearly everything:
223
+
224
+ 1. `asset_search_sources` — start here, never at a provider. It returns every catalogued
225
+ source with its license summary, attribution requirement, browse URL, and whether an agent
226
+ can complete a download from it. **That output is the authority on what is reachable** —
227
+ not this file, and not your memory of some other project.
228
+ 2. `polyhaven_search_assets` (CC0 models, textures, HDRIs), `ambientcg_search_assets` (CC0
229
+ materials and textures), or `audio_search_assets` (Kenney, Sonniss).
230
+ 3. `polyhaven_list_files` / `ambientcg_list_files` — the license, official URL, byte size and
231
+ md5 of every resolution and format. **Read this before downloading, not after**, and pick a
232
+ sane one: Poly Haven lists 16k PNGs over 1 GB beside 8k JPEGs at 28 MB. A game does not
233
+ need the 16k.
234
+ 4. `asset_download_file` for textures and models, `audio_download_asset` for audio. Both take
235
+ `acceptLicense: true` — you are asserting you read step 3. **They ignore any path you pass
236
+ and write to the directories `.mcp.json` sets** (`public/assets/<provider>/<sha>/` and
237
+ `public/audio/<source>/<pack>/`); without that config they would write to `~/Downloads` and
238
+ never reach the game.
239
+ 5. Append the file, its source, its license and its URL to `CREDITS.md` **before the turn
240
+ ends**. Poly Haven requires a visible Poly Haven credit when its API is used, ambientCG is
241
+ CC0 per asset page, and audio and bundle licenses are per pack.
242
+
243
+ **Never state a license you did not read off a tool result.** If `polyhaven_list_files` or
244
+ `ambientcg_search_assets` did not tell you, you do not know it.
245
+
246
+ **What arrives is usually a ZIP, not a texture.** ambientCG and Kenney ship archives: unpack
247
+ one, keep only the maps you actually use (`_Color`, `_NormalGL`, `_Roughness` — not the
248
+ `.blend`, `.usdc` or displacement), and put those beside your code under `public/`. A 1K JPEG
249
+ set is right for a game; the 8K set of the same material is 200 MB.
250
+
251
+ Two argument shapes that will bite you, both learned the hard way: `ambientcg_search_assets`
252
+ takes lowercase `type` values (`material`, `hdri`, `3d-model`), and the audio catalog is
253
+ **pack-level** — `audio_search_assets` matches pack names, so `query: "pickup coin"` returns
254
+ nothing while `kind: "sfx"` returns the seven packs that exist. Pick a pack, download it,
255
+ unzip it, and choose a file yourself.
256
+
257
+ The other tools are narrower, and the directory spells out the conditions on each. The Fab
258
+ tools talk to a marketplace: the server never purchases anything, and only directly-free files
259
+ download. `smithsonian_search_assets` returns museum scans at scan resolution, which this
260
+ project has no pipeline to decimate — that geometry is the wrong shape for a game. When in
261
+ doubt check `asset_search_sources` first; its `caution` and license fields are the current
262
+ truth for the pinned version, and they change between versions.
263
+
264
+ Load what you downloaded the ordinary way — `ctx.assets.model("crate.glb")`,
265
+ `ctx.assets.texture(...)`, `ctx.assets.audio(...)` — and write your own material and lighting
266
+ around it in `src/render/`. The framework ships no asset and picks none for you.
267
+
268
+ ## Building what you cannot download — sculpt from a reference
269
+
270
+ Choose one branch before writing code:
271
+
272
+ - **Conventional and downloadable** — a crate, an oak plank texture, a click. Use the asset
273
+ tools. Sculpting one of these is slower and worse.
274
+ - **Trivial** — a platform, a wall, a pickup ring. Write it. If `BoxGeometry` finishes the
275
+ job in under 20 lines, that is the answer.
276
+ - **Bespoke, with a reference image** — an identity-bearing creature, vehicle, hero prop,
277
+ landmark, scenery composition, or environment set piece whose silhouette must match. Use
278
+ the sculpt tools to turn that reference into editable `src/render/` source.
279
+ - **Bespoke, without a reference image** — ask for one, or write it and accept that it will
280
+ be generic. Do not invent a reference: comparison without evidence is unguided iteration.
281
+
282
+ For a full environment, split the decision: sculpt the signature landmark or bounded scene
283
+ kit that makes the reference recognisable; use the asset tools for interchangeable trees,
284
+ rocks, textures, HDRIs, and sounds around it. Do not sculpt an entire world as one object.
285
+
286
+ `.mcp.json` launches `threenative-sculpt-mcp` beside the asset server. It does not generate
287
+ or ship runtime code; it guides the source you write:
288
+
289
+ 1. Call `sculpt_plan` with the image path and a one-line intent, then read the returned
290
+ grimoire resources.
291
+ 2. Write the returned object contract and loop on `sculpt_spec_gate` until every named
292
+ region and depth requirement passes. Do not write geometry before this gate is green.
293
+ 3. For each ordered pass, write or extend one factory in `src/render/`. Capture the real
294
+ frame with `npx @threenative/playtest`; the sculpt server never launches a browser.
295
+ 4. Call `sculpt_compare` with the reference and captured frame, then give that evidence to
296
+ `sculpt_pass_gate`. Advance only when it says advance; ambiguity means retry.
297
+ 5. Use `sculpt_grimoire` for a named technique topic. It rejects pages containing concrete
298
+ paste-ready material or shader recipes so the tool never owns this game's look.
299
+
300
+ A missing or blank capture is a failed run, never a finished model. Add the reference image,
301
+ its creator, license, and source URL to `CREDITS.md` before the turn ends.
302
+
303
+
304
+ ## Visuals
305
+
306
+ Edit everything in `src/render/` directly. The six baseline files are `palette.ts`,
307
+ `camera.ts`, `sky.ts`, `lighting.ts`, `materials.ts`, and `postprocessing.ts`; `shapes.ts`
308
+ is an additional helper. These are ordinary Three.js source in this project,
309
+ not a framework look or a config option. Keep the palette to six named colours with one
310
+ `accent`; import it from materials and sky. Set tonemapping and exposure deliberately, use a
311
+ rim light with soft shadows and `normalBias`, derive fog from the sky, and route bloom through
312
+ `renderer.setOutputNode()` so midtones remain readable.
313
+
314
+ What is already there, so you do not rebuild it:
315
+
316
+ - `shapes.ts` — `roundedBox`, `block`, `ball`, `tube`, `spike`, `makeRandom`. **Build props
317
+ out of these, not raw `BoxGeometry`.** A sharp box reads as Minecraft; the same box with
318
+ a 0.14 corner radius reads as a toy, and that is most of the difference between a scene
319
+ that looks designed and one that looks like a test harness.
320
+ - `lighting.ts` — key, sky/ground bounce, **rim**, ambient, with soft shadows and a
321
+ `normalBias` tuned for rounded geometry. The rim is what stops silhouettes reading as
322
+ flat cut-outs; do not delete it while "simplifying".
323
+ - `camera.ts` — `createSpringArm`, a frame-rate-independent follow camera.
324
+ - `postprocessing.ts` — ACES tone mapping and the WebGPU render pipeline.
325
+
326
+ Three traps, all of which cost real debugging time before they were written down:
327
+
328
+ 1. **`CanvasTexture` samples black under `WebGPURenderer`.** Procedurally painting a canvas
329
+ and using it as a `map` produces a black surface, silently. Get variety from alternating
330
+ material colours across a run of meshes instead — that is what `makeRandom` is for.
331
+ 2. **`flatShading` fights `roundedBox`,** which welds its seams precisely so normals
332
+ interpolate across them. Do not set both.
333
+ 3. **Import a render module and then call it.** `setupPost` and `setupLighting` are inert
334
+ if `Play.ts` only imports them, and nothing in typecheck, lint, or a playtest will fail.
335
+
336
+ Nothing in the toolchain can see your game. `pnpm test` proves behaviour, never the look —
337
+ so when you change something visual, actually look at it before reporting it done.
338
+
339
+ ## UI
340
+
341
+ React renders the HUD, menus, and overlays. **React never touches the scene graph** — no
342
+ JSX for meshes, lights, or cameras.
343
+
344
+ The bridge is a throttled store, not a per-frame render:
345
+
346
+ ```ts
347
+ ctx.state.set({ score }); // in update(), at loop rate — it coalesces
348
+ const { score } = useGameState(); // in a component, ~10Hz
349
+ ```
350
+
351
+ Never subscribe a React component to per-frame data.
352
+
353
+ The start scene owns the initial state in `static initialState`; omit a duplicate
354
+ `initialState` literal from `defineGame`. Update only the fields that changed:
355
+ `ctx.state.set({ score })`.
356
+
357
+ `main.ts` calls `acceptHotUpdate(game, import.meta.hot)` for development reloads. The
358
+ framework preserves only JSON-shaped store state, so `Play.enter()` must seed entities
359
+ from the carried values such as `playerX`; the scene graph, physics world, audio voices,
360
+ particles, and renderer are rebuilt on every update.
361
+ The keyboard and React restart paths reset `Play.initialState` before rebuilding the scene.
362
+
363
+ ## Register entities you want to inspect or test
364
+
365
+ ```ts
366
+ ctx.entities.add("player", this.player);
367
+ ```
368
+
369
+ A registered entity's `debug()` shows up in the dev overlay, in `window.__THREENATIVE__`,
370
+ and in playtest assertions. That is how a scenario checks the game state rather than
371
+ guessing from pixels.
372
+
373
+ ## Playtests
374
+
375
+ `playtests/survives.playtest.json` is the durable smoke proof. Keep it when replacing the
376
+ starter gameplay: it checks boot, diagnostics, a nonblank frame, and player movement without
377
+ depending on pickups, score, coyote time, or respawns. `playtests/play.playtest.json` and the
378
+ other scenarios are starter-game examples that you may delete or rewrite. Steps count frames,
379
+ not milliseconds — `holdFrames`, `waitFrames` — because the harness drives the fixed-step clock
380
+ instead of racing it.
381
+
382
+ A scenario fails closed: a missing entity, an absent observation, or a scenario with no
383
+ assertions is a failure, never a quiet pass. When you add a feature, add the assertion that
384
+ would catch its absence, and run the scenario before reporting the feature works.
385
+
386
+ ## Budget real time for the look
387
+
388
+ Read this as an instruction about **where your effort goes**, not as a style tip.
389
+
390
+ Every automated gate in this project — `typecheck`, `lint`, `pnpm test`, every playtest
391
+ scenario — is blind to how the game looks. All of them pass on a game that is grey boxes on
392
+ a black screen. If you let the gates define "done", you will ship grey boxes on a black
393
+ screen and the gates will tell you that you succeeded.
394
+
395
+ So the rule here is: **a feature is not done when its assertion passes. It is done when you
396
+ have looked at it and it reads well.** Plan for roughly as much work on presentation as on
397
+ mechanics. That is not gold-plating; it is the majority of what a player experiences, and
398
+ it is the part nothing else in this repo will catch.
399
+
400
+ Concretely, when you add anything a player sees, do all of these before calling it done:
401
+
402
+ 1. **Look at it.** Boot the game, get the thing on screen, take a screenshot, open the
403
+ screenshot. Reading your own diff is not looking at it.
404
+ 2. **Silhouette first.** Can you tell what it is from its outline alone? Break up long
405
+ straight edges — overhangs, fringes, props crossing the line. A shape that reads at a
406
+ glance beats a detailed shape that does not.
407
+ 3. **Give it depth.** Something bright behind it, something dark under it. Contact shadows
408
+ and a rim make a prop sit in the world instead of floating on top of it.
409
+ 4. **Make it move.** Idle bob, a squash on impact, a particle on pickup, a screen shake on
410
+ damage. A few frames of motion is the cheapest quality-per-line in the whole project.
411
+ 5. **Finish the HUD too.** Spacing, hierarchy, a transition on every number that changes.
412
+ An unstyled HUD makes a good-looking game look unfinished.
413
+
414
+ ### How to actually look at it
415
+
416
+ Run `pnpm dev`, then get eyes on it. In rough order of preference:
417
+
418
+ 1. **Browser automation against the user's real Chrome**, if you have it — Claude in Chrome
419
+ or any equivalent MCP browser tool. This is the best option by a wide margin: it runs on
420
+ a real GPU, so WebGPU works, and you can navigate, press keys, screenshot, and read the
421
+ console in the same loop you are already coding in. Drive the game, do not just load the
422
+ menu.
423
+ 2. **`npx @threenative/playtest <scenario> --browser-recipe webgpu --headed`.** The recipe
424
+ carries the Chromium flags a WebGPU capture needs, including `--enable-features=Vulkan`.
425
+ Do not hand-roll the flag list: without that one flag Chromium never reaches the Linux
426
+ Vulkan driver and serves WebGPU from SwiftShader, its CPU rasteriser — no error, healthy
427
+ limits, and a software renderer's picture. The runner now fails such a run with
428
+ `TN_PLAYTEST_SOFTWARE_ADAPTER` and prints the adapter it got; `--allow-software` accepts
429
+ the fallback if you truly want it.
430
+ 3. **Ask the user to look**, and say specifically what you want them to check.
431
+
432
+ On a machine with no screen, run any of those under a virtual display. **Do not use
433
+ `xvfb-run`:** on `xorg-server-xvfb` 21.1.x its cleanup `kill` fails after Xvfb has already
434
+ exited and that failing kill's status replaces the real one, so
435
+ `xvfb-run -a -s '-screen 0 1600x900x24' true` exits `1`. Every gate wrapped in it reports
436
+ failure whether it passed or not. Start `Xvfb` yourself on a free display and export
437
+ `DISPLAY`, or check the command's own exit code separately.
438
+
439
+ What does *not* work: **headless Chromium usually cannot render WebGPU.** The page loads,
440
+ the HUD paints, and the 3D canvas comes out blank or black. That looks exactly like a bug
441
+ in your scene, and it is not. Symptoms are `Instance dropped in popErrorScope` and
442
+ `createBuffer failed, size (N) is too large for the implementation` in the console.
443
+
444
+ So: if a screenshot comes back black or empty, suspect the capture before you rewrite the
445
+ scene. Confirm the renderer works at all before you go debugging your materials.
446
+
447
+ ### When you think you are done
448
+
449
+ Ask yourself, honestly: *would a player screenshot this?* If the answer is no, you are not
450
+ finished — and no command in this repo is going to tell you that.