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