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,402 @@
|
|
|
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. Scaffolded with `create-threenative`
|
|
6
|
+
(`minimal` template: no React, no Tailwind). `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 store.
|
|
12
|
+
|
|
13
|
+
**You own everything a player sees.** `src/render/`, `src/entities/`, and `src/scenes/` are
|
|
14
|
+
ordinary code in this repository. Nothing in `@threenative/*` reads them. Rewrite or delete
|
|
15
|
+
any of it.
|
|
16
|
+
|
|
17
|
+
## Commands
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
pnpm dev # Vite dev server
|
|
21
|
+
pnpm studio # chat, preview and proof in one page; needs claude or codex
|
|
22
|
+
pnpm build # web build; identical to vite build
|
|
23
|
+
pnpm build --target desktop # native executable; Linux is the only verified host
|
|
24
|
+
pnpm test # build, start the dev server, and run the committed playtest
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The normal `@threenative/physics` API selects native Rapier on Android; its source-workspace
|
|
28
|
+
APK and emulator scenario are proven without Rapier WASM. A published scaffold still cannot
|
|
29
|
+
ship Android or iOS until signed prebuilt runtime assets and their checksum manifest exist,
|
|
30
|
+
so those targets fail closed for consumers. Linux desktop is source-machine evidence, not a
|
|
31
|
+
clean-machine distribution proof; macOS, Windows, iOS, and physical hardware remain OPEN.
|
|
32
|
+
|
|
33
|
+
## Keep the game portable to native
|
|
34
|
+
|
|
35
|
+
`pnpm build --target desktop` runs this same source on a native host with **no browser**.
|
|
36
|
+
Three things break there, and none of them fail on the web build:
|
|
37
|
+
|
|
38
|
+
1. **No real DOM.** `document` exists only as a Three.js compatibility stub. The accessible
|
|
39
|
+
DOM score in `main.ts` remains a web convenience; the generated `src/render/hud.ts` is
|
|
40
|
+
camera-parented Three.js geometry, so its score, counter and clock run with the game.
|
|
41
|
+
2. **No dynamic `import()` and no `window.localStorage` reach.** The native build is one
|
|
42
|
+
bundled file; save games go through your own JSON via `ctx.state`.
|
|
43
|
+
3. **`.raw` is web-only.** `ctx.physics.world.raw` is a Rapier object in the browser and
|
|
44
|
+
opaque on native. Anything reading it is a web-only code path by contract.
|
|
45
|
+
|
|
46
|
+
Writing against `ctx`, `three`, and the Godot-named physics nodes keeps all three correct
|
|
47
|
+
without thinking about it. If you only ever ship to the web, ignore this section.
|
|
48
|
+
|
|
49
|
+
## The layout
|
|
50
|
+
|
|
51
|
+
```mermaid
|
|
52
|
+
flowchart TD
|
|
53
|
+
project["generated project"]
|
|
54
|
+
src["src/"]
|
|
55
|
+
main["main.ts<br/>defineGame(...) + accessible web DOM score"]
|
|
56
|
+
play["scenes/Play.ts<br/>gameplay: load, enter, update, exit"]
|
|
57
|
+
player["entities/Player.ts<br/>plain class, not an ECS"]
|
|
58
|
+
render["render/<br/>palette, camera, lighting, HUD geometry,<br/>materials, post — YOURS"]
|
|
59
|
+
state["state.ts<br/>state shape gameplay publishes"]
|
|
60
|
+
playtest["playtests/survives.playtest.json<br/>durable smoke proof, run by pnpm test"]
|
|
61
|
+
config["threenative.config.ts<br/>app identity, icon, display, desktop window, renderer"]
|
|
62
|
+
|
|
63
|
+
project --> src
|
|
64
|
+
src --> main
|
|
65
|
+
src --> play
|
|
66
|
+
src --> player
|
|
67
|
+
src --> render
|
|
68
|
+
src --> state
|
|
69
|
+
project --> playtest
|
|
70
|
+
project --> config
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
`threenative.config.ts` is the one game-owned app-shape file. Set the launcher identity and
|
|
74
|
+
icon, mobile orientation and display flags, desktop window, renderer preference, and native
|
|
75
|
+
entry there. `package.json` may retain only `threenative.nativeEntry` as a compatibility
|
|
76
|
+
fallback for older projects.
|
|
77
|
+
|
|
78
|
+
`src/render/hud.ts` is generated user-owned source, not a framework widget. It uses instanced
|
|
79
|
+
plane geometry rather than `CanvasTexture`, and the scene registers it with `ctx.entities` so
|
|
80
|
+
native and web dispose it the same way. Rewrite its glyphs, labels, colours or layout freely.
|
|
81
|
+
Touch controls are not generated yet: keep keyboard mappings for now, then add the small
|
|
82
|
+
pointer-action mapping when the core multitouch surface from PRD-053 is available.
|
|
83
|
+
|
|
84
|
+
## How to write gameplay here
|
|
85
|
+
|
|
86
|
+
A scene is a class with optional `load`, `enter`, `update`, `exit`, and `render`. That is
|
|
87
|
+
the whole lifecycle — there is nothing else to register.
|
|
88
|
+
|
|
89
|
+
`ctx` hands you real Three.js objects and backend-neutral physics handles:
|
|
90
|
+
|
|
91
|
+
```ts
|
|
92
|
+
ctx.scene // THREE.Scene
|
|
93
|
+
ctx.camera // THREE.PerspectiveCamera
|
|
94
|
+
ctx.renderer // the renderer
|
|
95
|
+
ctx.physics.world // PhysicsWorldHandle
|
|
96
|
+
player.body // PhysicsBodyHandle (via CharacterBody3D)
|
|
97
|
+
player.mesh // THREE.Mesh
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
The physics handles expose `.raw` as an explicitly backend-specific escape hatch: Rapier on
|
|
101
|
+
web, opaque on native. Code that reads `.raw` is not portable between those targets.
|
|
102
|
+
|
|
103
|
+
Any Three.js tutorial, StackOverflow answer, or snippet you already know works unchanged
|
|
104
|
+
inside a scene. Prefer that over hunting for a framework wrapper — **for anything Three.js
|
|
105
|
+
itself does (geometry, materials, lights, math), there is no wrapper and you should write
|
|
106
|
+
the Three.js.** The exception is the loop: scene changes, timers and tweens are on `ctx`,
|
|
107
|
+
not in an import, so grepping the imports of an existing file will not find them. The
|
|
108
|
+
table below is the complete list.
|
|
109
|
+
|
|
110
|
+
Physics uses Godot's names: `RigidBody3D`, `Area3D`, `CharacterBody3D`, `CollisionShape3D`.
|
|
111
|
+
Every node has `dispose()`. Register disposable entities with `ctx.entities`; the framework
|
|
112
|
+
clears registered entities, scene objects, and physics nodes when a scene exits. Dispose a
|
|
113
|
+
node explicitly only when removing it during play. **The id is the name a scenario resolves.** A playtest `subject`, and every `movement` or
|
|
114
|
+
`visibility` assertion, looks the entity up by that string — an unregistered player fails
|
|
115
|
+
`TN_PLAYTEST_VISIBILITY_FAILED` however visible it is on screen.
|
|
116
|
+
|
|
117
|
+
`input.vector("move").y` is +up; map it to world-space -z for forward with one explicit
|
|
118
|
+
`-move.y` conversion in the player movement code.
|
|
119
|
+
|
|
120
|
+
`CharacterBody3D.moveAndSlide(dt)` owns gravity through `body.velocity`; keep coyote time
|
|
121
|
+
and the jump buffer in `src/entities/Player.ts` so the two templates teach the same motion
|
|
122
|
+
API.
|
|
123
|
+
|
|
124
|
+
## The `ctx` surface — you already have these, do not rebuild them
|
|
125
|
+
|
|
126
|
+
`ctx` carries six things that get reimplemented by hand in almost every project, because
|
|
127
|
+
they are **properties on `ctx`, never imports** — grepping an existing file's imports will
|
|
128
|
+
never surface them. This table is the complete list.
|
|
129
|
+
|
|
130
|
+
| You already have | Rather than | Signature |
|
|
131
|
+
|---|---|---|
|
|
132
|
+
| `ctx.goto("play")` | a hand-written `#reset()` | `(name: string) => Promise<void>` |
|
|
133
|
+
| `ctx.tween(obj, { y: 2 }, 0.4)` | a `Math.sin` / `lerp` accumulator | `(target, props, seconds) => Promise<void>` |
|
|
134
|
+
| `ctx.after(0.8, fn)` | `elapsed += dt; if (elapsed > 0.8)` | `(seconds, cb) => ScheduleHandle` |
|
|
135
|
+
| `ctx.every(fn)` | a per-frame branch in `update` | `(cb: (dt: number) => void) => ScheduleHandle` |
|
|
136
|
+
| `ctx.random.range(-1, 1)` | `Math.random()` | seeded — a replay produces identical results |
|
|
137
|
+
| `ctx.raycast()` | `new Raycaster()` + `intersectObject` | `(options?: { screen?, targets? }) => Intersection \| undefined` |
|
|
138
|
+
|
|
139
|
+
**`ctx.raycast()` is how you pick geometry under the pointer.** It defaults to the current
|
|
140
|
+
pointer position and the whole scene, returns the nearest `THREE.Intersection`, and stays
|
|
141
|
+
under a millisecond on meshes large enough that a plain `Raycaster` visibly stutters — it
|
|
142
|
+
keeps an acceleration structure per geometry and rebuilds it when that geometry's positions
|
|
143
|
+
change. Pass `{ targets }` to narrow it, `{ screen }` to test a point that is not the
|
|
144
|
+
pointer. Skinned, instanced and morphed meshes fall back to the stock Three.js path
|
|
145
|
+
automatically, so the result always matches `Raycaster.intersectObject`.
|
|
146
|
+
|
|
147
|
+
**`ctx.goto(name)` restarts the current scene.** Calling `ctx.goto("play")` from inside
|
|
148
|
+
`Play` tears the scene down and rebuilds it: `exit()` runs, scheduled callbacks are cleared,
|
|
149
|
+
registered entities are cleared, the Three scene is emptied, then a fresh instance runs
|
|
150
|
+
`load()` and `enter()`. That is your entire restart button, and your entire death-and-retry.
|
|
151
|
+
|
|
152
|
+
Do **not** write a `#reset()` that walks your entities putting them back. It is ~15 lines
|
|
153
|
+
that look right and quietly miss the scheduler and anything you spawned after `enter()`, so
|
|
154
|
+
the second playthrough behaves differently from the first — and no gate in this project will
|
|
155
|
+
catch that.
|
|
156
|
+
|
|
157
|
+
**One rule when calling it from a frame function: `goto` and then `return`, immediately.**
|
|
158
|
+
|
|
159
|
+
```ts
|
|
160
|
+
if (player.dead) {
|
|
161
|
+
void ctx.goto("play");
|
|
162
|
+
return; // ← required. Everything below now runs against a torn-down scene.
|
|
163
|
+
}
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
From React, the same call is `game.goto("play")` — use that for a restart button instead of
|
|
167
|
+
routing a counter through game state.
|
|
168
|
+
|
|
169
|
+
**`ctx.tween` is for timing, not for looks.** Use it for the *when* — a pickup rising over
|
|
170
|
+
0.4s, a door opening, a hit flash — and keep the *what* (colour, shape, easing feel) in
|
|
171
|
+
`src/render/`. Motion driven by a persistent `Math.sin(elapsed)` in `update()` is still the
|
|
172
|
+
right tool for a continuous idle bob; `tween` is for anything that starts, runs once, and
|
|
173
|
+
finishes.
|
|
174
|
+
|
|
175
|
+
**`ctx.random` is seeded from `defineGame({ seed })`.** Use it for anything a playtest needs
|
|
176
|
+
to reproduce — spawn positions, patrol offsets, level variation. `Math.random()` makes a
|
|
177
|
+
scenario that passes once and fails on replay for no visible reason.
|
|
178
|
+
|
|
179
|
+
## Assets and animation
|
|
180
|
+
|
|
181
|
+
`AnimationPlayer` is exported by `@threenative/core` for clips from a rigged asset. Put a
|
|
182
|
+
`.glb` in `public/`, await `ctx.assets.model("hero.glb")` in `Scene.load()`, then construct
|
|
183
|
+
and update the `AnimationPlayer` beside the entity that owns the loaded model. This minimal
|
|
184
|
+
template does not ship a rigged asset; adding one belongs in `public/`, not in the framework.
|
|
185
|
+
|
|
186
|
+
## Finding assets — you have an MCP server for this
|
|
187
|
+
|
|
188
|
+
**Reach for it when the asset is conventional; build anything custom yourself.**
|
|
189
|
+
|
|
190
|
+
- **Textures, materials, HDRIs and sound effects — prefer the tools.** Rusted metal, oak
|
|
191
|
+
planks, a studio HDRI, a UI click: these are well-established and a CC0 one beats what you
|
|
192
|
+
would hand-author.
|
|
193
|
+
- **Models — only when the thing is conventional.** A car, a plane, a crate, a barrel, a
|
|
194
|
+
tree, a chair. If this game's main character is a car, fetching a compatible `.glb` is the
|
|
195
|
+
right call.
|
|
196
|
+
- **Anything specific to this game — write it in `src/render/`.** A downloaded model standing
|
|
197
|
+
in for a bespoke design reads as a weird asset dropped into the scene, and it looks worse
|
|
198
|
+
than a clean composition of primitives. This is the failure the tools make easy.
|
|
199
|
+
|
|
200
|
+
When in doubt, build it programmatically. A fetched asset has to match what the game needs,
|
|
201
|
+
not merely exist.
|
|
202
|
+
|
|
203
|
+
`.mcp.json` in this project launches `threenative-asset-mcp` from `node_modules`, so your host
|
|
204
|
+
lists its tools alongside your own. It advertises 32; these 8 are the loop you will use for
|
|
205
|
+
nearly everything:
|
|
206
|
+
|
|
207
|
+
1. `asset_search_sources` — start here, never at a provider. It returns every catalogued
|
|
208
|
+
source with its license summary, attribution requirement, browse URL, and whether an agent
|
|
209
|
+
can complete a download from it. **That output is the authority on what is reachable** —
|
|
210
|
+
not this file, and not your memory of some other project.
|
|
211
|
+
2. `polyhaven_search_assets` (CC0 models, textures, HDRIs), `ambientcg_search_assets` (CC0
|
|
212
|
+
materials and textures), or `audio_search_assets` (Kenney, Sonniss).
|
|
213
|
+
3. `polyhaven_list_files` / `ambientcg_list_files` — the license, official URL, byte size and
|
|
214
|
+
md5 of every resolution and format. **Read this before downloading, not after**, and pick a
|
|
215
|
+
sane one: Poly Haven lists 16k PNGs over 1 GB beside 8k JPEGs at 28 MB. A game does not
|
|
216
|
+
need the 16k.
|
|
217
|
+
4. `asset_download_file` for textures and models, `audio_download_asset` for audio. Both take
|
|
218
|
+
`acceptLicense: true` — you are asserting you read step 3. **They ignore any path you pass
|
|
219
|
+
and write to the directories `.mcp.json` sets** (`public/assets/<provider>/<sha>/` and
|
|
220
|
+
`public/audio/<source>/<pack>/`); without that config they would write to `~/Downloads` and
|
|
221
|
+
never reach the game.
|
|
222
|
+
5. Append the file, its source, its license and its URL to `CREDITS.md` **before the turn
|
|
223
|
+
ends**. Poly Haven requires a visible Poly Haven credit when its API is used, ambientCG is
|
|
224
|
+
CC0 per asset page, and audio and bundle licenses are per pack.
|
|
225
|
+
|
|
226
|
+
**Never state a license you did not read off a tool result.** If `polyhaven_list_files` or
|
|
227
|
+
`ambientcg_search_assets` did not tell you, you do not know it.
|
|
228
|
+
|
|
229
|
+
**What arrives is usually a ZIP, not a texture.** ambientCG and Kenney ship archives: unpack
|
|
230
|
+
one, keep only the maps you actually use (`_Color`, `_NormalGL`, `_Roughness` — not the
|
|
231
|
+
`.blend`, `.usdc` or displacement), and put those beside your code under `public/`. A 1K JPEG
|
|
232
|
+
set is right for a game; the 8K set of the same material is 200 MB.
|
|
233
|
+
|
|
234
|
+
Two argument shapes that will bite you, both learned the hard way: `ambientcg_search_assets`
|
|
235
|
+
takes lowercase `type` values (`material`, `hdri`, `3d-model`), and the audio catalog is
|
|
236
|
+
**pack-level** — `audio_search_assets` matches pack names, so `query: "pickup coin"` returns
|
|
237
|
+
nothing while `kind: "sfx"` returns the seven packs that exist. Pick a pack, download it,
|
|
238
|
+
unzip it, and choose a file yourself.
|
|
239
|
+
|
|
240
|
+
The other tools are narrower, and the directory spells out the conditions on each. The Fab
|
|
241
|
+
tools talk to a marketplace: the server never purchases anything, and only directly-free files
|
|
242
|
+
download. `smithsonian_search_assets` returns museum scans at scan resolution, which this
|
|
243
|
+
project has no pipeline to decimate — that geometry is the wrong shape for a game. When in
|
|
244
|
+
doubt check `asset_search_sources` first; its `caution` and license fields are the current
|
|
245
|
+
truth for the pinned version, and they change between versions.
|
|
246
|
+
|
|
247
|
+
Load what you downloaded the ordinary way — `ctx.assets.model("crate.glb")`,
|
|
248
|
+
`ctx.assets.texture(...)`, `ctx.assets.audio(...)` — and write your own material and lighting
|
|
249
|
+
around it in `src/render/`. The framework ships no asset and picks none for you.
|
|
250
|
+
|
|
251
|
+
## Building what you cannot download — sculpt from a reference
|
|
252
|
+
|
|
253
|
+
Choose one branch before writing code:
|
|
254
|
+
|
|
255
|
+
- **Conventional and downloadable** — a crate, an oak plank texture, a click. Use the asset
|
|
256
|
+
tools. Sculpting one of these is slower and worse.
|
|
257
|
+
- **Trivial** — a platform, a wall, a pickup ring. Write it. If `BoxGeometry` finishes the
|
|
258
|
+
job in under 20 lines, that is the answer.
|
|
259
|
+
- **Bespoke, with a reference image** — an identity-bearing creature, vehicle, hero prop,
|
|
260
|
+
landmark, scenery composition, or environment set piece whose silhouette must match. Use
|
|
261
|
+
the sculpt tools to turn that reference into editable `src/render/` source.
|
|
262
|
+
- **Bespoke, without a reference image** — ask for one, or write it and accept that it will
|
|
263
|
+
be generic. Do not invent a reference: comparison without evidence is unguided iteration.
|
|
264
|
+
|
|
265
|
+
For a full environment, split the decision: sculpt the signature landmark or bounded scene
|
|
266
|
+
kit that makes the reference recognisable; use the asset tools for interchangeable trees,
|
|
267
|
+
rocks, textures, HDRIs, and sounds around it. Do not sculpt an entire world as one object.
|
|
268
|
+
|
|
269
|
+
`.mcp.json` launches `threenative-sculpt-mcp` beside the asset server. It does not generate
|
|
270
|
+
or ship runtime code; it guides the source you write:
|
|
271
|
+
|
|
272
|
+
1. Call `sculpt_plan` with the image path and a one-line intent, then read the returned
|
|
273
|
+
grimoire resources.
|
|
274
|
+
2. Write the returned object contract and loop on `sculpt_spec_gate` until every named
|
|
275
|
+
region and depth requirement passes. Do not write geometry before this gate is green.
|
|
276
|
+
3. For each ordered pass, write or extend one factory in `src/render/`. Capture the real
|
|
277
|
+
frame with `npx @threenative/playtest`; the sculpt server never launches a browser.
|
|
278
|
+
4. Call `sculpt_compare` with the reference and captured frame, then give that evidence to
|
|
279
|
+
`sculpt_pass_gate`. Advance only when it says advance; ambiguity means retry.
|
|
280
|
+
5. Use `sculpt_grimoire` for a named technique topic. It rejects pages containing concrete
|
|
281
|
+
paste-ready material or shader recipes so the tool never owns this game's look.
|
|
282
|
+
|
|
283
|
+
A missing or blank capture is a failed run, never a finished model. Add the reference image,
|
|
284
|
+
its creator, license, and source URL to `CREDITS.md` before the turn ends.
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
## Visuals
|
|
288
|
+
|
|
289
|
+
Edit the six files in `src/render/` directly: `palette.ts`, `camera.ts`, `sky.ts`,
|
|
290
|
+
`lighting.ts`, `materials.ts`, and `postprocessing.ts`. They are ordinary Three.js source in
|
|
291
|
+
this project, not a framework look or a config option. Keep the palette to six named colours
|
|
292
|
+
with one `accent`; import it from materials and sky. Set tonemapping and exposure deliberately,
|
|
293
|
+
use a rim light with soft shadows and `normalBias`, derive fog from the sky, and route bloom
|
|
294
|
+
through `renderer.setOutputNode()` so midtones remain readable.
|
|
295
|
+
|
|
296
|
+
`lighting.ts` ships key, bounce, **rim** and ambient with soft shadows. The rim is what
|
|
297
|
+
stops silhouettes reading as flat cut-outs against the background; do not delete it while
|
|
298
|
+
"simplifying".
|
|
299
|
+
|
|
300
|
+
Two traps worth knowing before you spend an afternoon on either:
|
|
301
|
+
|
|
302
|
+
1. **`CanvasTexture` samples black under `WebGPURenderer`.** Painting a canvas and using it
|
|
303
|
+
as a `map` silently produces a black surface. Vary material colours across meshes
|
|
304
|
+
instead. (The `starter` template ships a `shapes.ts` with rounded primitives and a
|
|
305
|
+
seeded RNG for exactly this; copy it in if you want it.)
|
|
306
|
+
2. **Import a render module and then call it.** `setupPost` is inert if `Play.ts` only
|
|
307
|
+
imports it, and no gate here will fail.
|
|
308
|
+
|
|
309
|
+
Nothing in the toolchain can see your game. `pnpm test` proves behaviour, never the look.
|
|
310
|
+
|
|
311
|
+
## HUD
|
|
312
|
+
|
|
313
|
+
This template has no React. `main.ts` subscribes a plugin to the store and writes to a DOM
|
|
314
|
+
node. `ctx.state.set()` coalesces, so write it from `update()` freely — but never rebuild
|
|
315
|
+
the DOM per frame.
|
|
316
|
+
|
|
317
|
+
If the UI grows past a few readouts, scaffold with the `starter` template instead, which
|
|
318
|
+
ships React 19 + Tailwind and `@threenative/ui`.
|
|
319
|
+
|
|
320
|
+
The start scene owns the initial state in `static initialState`; omit a duplicate
|
|
321
|
+
`initialState` literal from `defineGame`. `ctx.state.set({ playerX })` is a partial patch.
|
|
322
|
+
|
|
323
|
+
For development hot reload, `main.ts` calls `acceptHotUpdate(game, import.meta.hot)`. The
|
|
324
|
+
framework carries only JSON-shaped store state; rebuild the scene in `enter()` from the
|
|
325
|
+
state values you want to keep. Meshes, physics bodies, audio voices, and renderer objects
|
|
326
|
+
are always rebuilt.
|
|
327
|
+
|
|
328
|
+
## Register entities you want to inspect or test
|
|
329
|
+
|
|
330
|
+
```ts
|
|
331
|
+
ctx.entities.add("player", this.player);
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
A registered entity's `debug()` shows up in `window.__THREENATIVE__` in dev, and in playtest
|
|
335
|
+
assertions. That is how a scenario checks game state instead of guessing from pixels.
|
|
336
|
+
|
|
337
|
+
## Playtests
|
|
338
|
+
|
|
339
|
+
`playtests/survives.playtest.json` is the durable smoke proof. Keep it when replacing the
|
|
340
|
+
minimal gameplay: it checks boot, diagnostics, a nonblank canvas, and player movement without
|
|
341
|
+
depending on the pickup or score. `playtests/play.playtest.json` is the minimal-game example.
|
|
342
|
+
Steps count frames, not milliseconds — `holdFrames`, `waitFrames` — because the harness drives
|
|
343
|
+
the fixed-step clock instead of racing it.
|
|
344
|
+
|
|
345
|
+
A scenario fails closed: a missing entity, an absent observation, or a scenario with no
|
|
346
|
+
assertions is a failure, never a quiet pass. Add the assertion that would catch a feature's
|
|
347
|
+
absence, and run it before reporting the feature works.
|
|
348
|
+
|
|
349
|
+
## Budget real time for the look
|
|
350
|
+
|
|
351
|
+
Read this as an instruction about **where your effort goes**, not as a style tip.
|
|
352
|
+
|
|
353
|
+
Every automated gate here — `typecheck`, `lint`, `pnpm test`, every playtest scenario — is
|
|
354
|
+
blind to how the game looks. All of them pass on a game that is grey boxes on a black
|
|
355
|
+
screen. If you let the gates define "done", that is what you will ship, and the gates will
|
|
356
|
+
tell you that you succeeded.
|
|
357
|
+
|
|
358
|
+
**A feature is not done when its assertion passes. It is done when you have looked at it
|
|
359
|
+
and it reads well.** Plan for roughly as much work on presentation as on mechanics.
|
|
360
|
+
|
|
361
|
+
When you add anything a player sees, do all of these before calling it done:
|
|
362
|
+
|
|
363
|
+
1. **Look at it.** Boot the game, get it on screen, screenshot, open the screenshot.
|
|
364
|
+
Reading your own diff is not looking at it.
|
|
365
|
+
2. **Silhouette first.** Can you tell what it is from its outline? Break up long straight
|
|
366
|
+
edges. A shape that reads at a glance beats a detailed shape that does not.
|
|
367
|
+
3. **Give it depth.** Something bright behind it, something dark under it. Contact shadows
|
|
368
|
+
and the rim light make a prop sit in the world instead of floating on it.
|
|
369
|
+
4. **Make it move.** Idle bob, squash on impact, a particle on pickup. A few frames of
|
|
370
|
+
motion is the cheapest quality-per-line in the project.
|
|
371
|
+
5. **Finish the HUD.** Spacing, hierarchy, a transition on numbers that change.
|
|
372
|
+
|
|
373
|
+
### How to actually look at it
|
|
374
|
+
|
|
375
|
+
Run `pnpm dev`, then get eyes on it. In rough order of preference:
|
|
376
|
+
|
|
377
|
+
1. **Browser automation against the user's real Chrome**, if available — Claude in Chrome
|
|
378
|
+
or an equivalent MCP browser tool. Best option by far: real GPU, so WebGPU works, and
|
|
379
|
+
you can navigate, press keys, screenshot and read the console in one loop. Drive the
|
|
380
|
+
game, do not just load the menu.
|
|
381
|
+
2. **`npx @threenative/playtest <scenario> --browser-recipe webgpu --headed`.** The recipe
|
|
382
|
+
carries the Chromium flags a WebGPU capture needs, including `--enable-features=Vulkan`.
|
|
383
|
+
Without that one flag Chromium serves WebGPU from SwiftShader, its CPU rasteriser, with no
|
|
384
|
+
error and healthy-looking limits; the runner fails that run with
|
|
385
|
+
`TN_PLAYTEST_SOFTWARE_ADAPTER` rather than reporting a software renderer's picture.
|
|
386
|
+
3. **Ask the user to look**, saying specifically what to check.
|
|
387
|
+
|
|
388
|
+
On a machine with no screen, run under a virtual display — but **not `xvfb-run`**: its
|
|
389
|
+
cleanup `kill` fails after Xvfb exits and replaces the real exit status, so
|
|
390
|
+
`xvfb-run -a -s '-screen 0 1600x900x24' true` exits `1` and every gate wrapped in it reports
|
|
391
|
+
failure whether it passed or not. Start `Xvfb` yourself and export `DISPLAY`.
|
|
392
|
+
|
|
393
|
+
What does *not* work: **headless Chromium usually cannot render WebGPU.** The page loads,
|
|
394
|
+
the DOM HUD paints, and the 3D canvas comes out blank — which looks exactly like a bug in
|
|
395
|
+
your scene and is not. Look for `Instance dropped in popErrorScope` in the console.
|
|
396
|
+
|
|
397
|
+
If a screenshot comes back black, suspect the capture before you rewrite the scene.
|
|
398
|
+
|
|
399
|
+
### When you think you are done
|
|
400
|
+
|
|
401
|
+
Ask honestly: *would a player screenshot this?* If not, you are not finished — and no
|
|
402
|
+
command here is going to tell you that.
|
|
File without changes
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
<main id="app">
|
|
11
|
+
</main>
|
|
12
|
+
<script type="module" src="/src/main.ts"></script>
|
|
13
|
+
</body>
|
|
14
|
+
</html>
|
|
@@ -0,0 +1,40 @@
|
|
|
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
|
+
"pretest": "playwright install chromium",
|
|
14
|
+
"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\"",
|
|
15
|
+
"typecheck": "tsc --noEmit -p tsconfig.json"
|
|
16
|
+
},
|
|
17
|
+
"dependencies": {
|
|
18
|
+
"@threenative/core": "0.2.0",
|
|
19
|
+
"@threenative/physics": "0.2.0",
|
|
20
|
+
"three": "0.185.1"
|
|
21
|
+
},
|
|
22
|
+
"devDependencies": {
|
|
23
|
+
"@threenative/playtest": "0.2.0",
|
|
24
|
+
"@threenative/studio": "0.2.0",
|
|
25
|
+
"@types/three": "0.185.3",
|
|
26
|
+
"create-threenative": "0.2.0",
|
|
27
|
+
"esbuild": "0.27.0",
|
|
28
|
+
"playwright": "1.62.1",
|
|
29
|
+
"threenative-asset-mcp": "0.4.0",
|
|
30
|
+
"threenative-sculpt-mcp": "0.1.0",
|
|
31
|
+
"typescript": "5.9.3",
|
|
32
|
+
"vite": "8.2.0"
|
|
33
|
+
},
|
|
34
|
+
"optionalDependencies": {
|
|
35
|
+
"@threenative/runtime-native": "0.2.0"
|
|
36
|
+
},
|
|
37
|
+
"pnpm": {
|
|
38
|
+
"onlyBuiltDependencies": ["@threenative/runtime-native"]
|
|
39
|
+
}
|
|
40
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "play",
|
|
3
|
+
"target": "web",
|
|
4
|
+
"schemaVersion": 1,
|
|
5
|
+
"viewport": {
|
|
6
|
+
"width": 1280,
|
|
7
|
+
"height": 720
|
|
8
|
+
},
|
|
9
|
+
"warmupFrames": 10,
|
|
10
|
+
"steps": [
|
|
11
|
+
{
|
|
12
|
+
"kind": "input",
|
|
13
|
+
"press": "ArrowRight",
|
|
14
|
+
"holdFrames": 120,
|
|
15
|
+
"release": true
|
|
16
|
+
}
|
|
17
|
+
],
|
|
18
|
+
"assert": {
|
|
19
|
+
"diagnostics": {
|
|
20
|
+
"noConsoleErrors": true,
|
|
21
|
+
"runtimeReady": true
|
|
22
|
+
},
|
|
23
|
+
"components": [
|
|
24
|
+
{
|
|
25
|
+
"changed": true,
|
|
26
|
+
"component": "glyphs",
|
|
27
|
+
"entity": "hud"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"performance": {}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "survives",
|
|
3
|
+
"target": "web",
|
|
4
|
+
"schemaVersion": 1,
|
|
5
|
+
"viewport": { "width": 1280, "height": 720 },
|
|
6
|
+
"warmupFrames": 10,
|
|
7
|
+
"subject": "player",
|
|
8
|
+
"steps": [
|
|
9
|
+
{ "kind": "input", "label": "move", "press": "ArrowUp", "holdTicks": 60, "release": true },
|
|
10
|
+
{ "kind": "wait", "label": "settle", "waitTicks": 10, "release": true }
|
|
11
|
+
],
|
|
12
|
+
"assert": {
|
|
13
|
+
"diagnostics": {
|
|
14
|
+
"noConsoleErrors": true,
|
|
15
|
+
"noNetworkErrors": true,
|
|
16
|
+
"noRuntimeDiagnostics": true,
|
|
17
|
+
"runtimeReady": true
|
|
18
|
+
},
|
|
19
|
+
"movement": { "entity": "player", "minDistance": 0.5 },
|
|
20
|
+
"visual": [
|
|
21
|
+
{
|
|
22
|
+
"region": {
|
|
23
|
+
"x": 0,
|
|
24
|
+
"y": 0,
|
|
25
|
+
"width": 1280,
|
|
26
|
+
"height": 720,
|
|
27
|
+
"minNonblankPixelRatio": 0.01
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
]
|
|
31
|
+
}
|
|
32
|
+
}
|
|
File without changes
|
|
Binary file
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import type { ICtx } from "@threenative/core";
|
|
2
|
+
import { CharacterBody3D, CollisionShape3D, type IPhysicsContext } from "@threenative/physics";
|
|
3
|
+
import { BoxGeometry, Mesh } from "three";
|
|
4
|
+
import { defaultMaterial } from "../render/materials.js";
|
|
5
|
+
import type { GameState } from "../state.js";
|
|
6
|
+
|
|
7
|
+
type GameCtx = ICtx<GameState, IPhysicsContext>;
|
|
8
|
+
|
|
9
|
+
const COYOTE_TIME = 0.12;
|
|
10
|
+
const JUMP_BUFFER = 0.14;
|
|
11
|
+
const JUMP_SPEED = 5;
|
|
12
|
+
const MOVE_SPEED = 2;
|
|
13
|
+
const SPAWN = { x: -2, y: 0.5, z: 0 } as const;
|
|
14
|
+
|
|
15
|
+
export class Player {
|
|
16
|
+
readonly mesh = new Mesh(new BoxGeometry(0.6, 1, 0.6), defaultMaterial);
|
|
17
|
+
readonly body: CharacterBody3D;
|
|
18
|
+
#coyoteTime = 0;
|
|
19
|
+
#jumpBuffer = 0;
|
|
20
|
+
#jumps = 0;
|
|
21
|
+
#coyoteJumps = 0;
|
|
22
|
+
|
|
23
|
+
constructor(ctx: GameCtx) {
|
|
24
|
+
this.mesh.position.set(SPAWN.x, SPAWN.y, SPAWN.z);
|
|
25
|
+
this.mesh.castShadow = true;
|
|
26
|
+
ctx.add(this.mesh);
|
|
27
|
+
this.body = new CharacterBody3D({
|
|
28
|
+
autostep: { maxHeight: 0.4, minWidth: 0.2 },
|
|
29
|
+
object: this.mesh,
|
|
30
|
+
physics: ctx.physics,
|
|
31
|
+
shape: CollisionShape3D.capsule(0.2, 0.3),
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
update(ctx: GameCtx, dt: number): void {
|
|
36
|
+
this.#coyoteTime = Math.max(0, this.#coyoteTime - dt);
|
|
37
|
+
this.#jumpBuffer = Math.max(0, this.#jumpBuffer - dt);
|
|
38
|
+
if (this.body.grounded) this.#coyoteTime = COYOTE_TIME;
|
|
39
|
+
if (ctx.input.justPressed("jump")) this.#jumpBuffer = JUMP_BUFFER;
|
|
40
|
+
if (this.#jumpBuffer > 0 && this.#coyoteTime > 0) {
|
|
41
|
+
this.body.velocity.y = JUMP_SPEED;
|
|
42
|
+
this.#jumpBuffer = 0;
|
|
43
|
+
this.#coyoteTime = 0;
|
|
44
|
+
this.#jumps += 1;
|
|
45
|
+
this.#coyoteJumps += 1;
|
|
46
|
+
}
|
|
47
|
+
const move = ctx.input.vector("move");
|
|
48
|
+
this.body.velocity.x = move.x * MOVE_SPEED;
|
|
49
|
+
this.body.velocity.z = -move.y * MOVE_SPEED;
|
|
50
|
+
this.body.moveAndSlide(dt);
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
debug(): Record<string, unknown> {
|
|
54
|
+
return {
|
|
55
|
+
coyoteJumps: this.#coyoteJumps,
|
|
56
|
+
grounded: this.body.grounded,
|
|
57
|
+
jumps: this.#jumps,
|
|
58
|
+
position: this.mesh.position.toArray(),
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
dispose(): void {
|
|
63
|
+
this.body.dispose();
|
|
64
|
+
this.mesh.removeFromParent();
|
|
65
|
+
}
|
|
66
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { defineGame } from "@threenative/core";
|
|
2
|
+
import { playtest } from "@threenative/core/playtest";
|
|
3
|
+
import type { IPhysicsContext } from "@threenative/physics";
|
|
4
|
+
import { rapier } from "@threenative/physics";
|
|
5
|
+
import config from "../threenative.config.js";
|
|
6
|
+
import { Play } from "./scenes/Play.js";
|
|
7
|
+
import type { GameState } from "./state.js";
|
|
8
|
+
|
|
9
|
+
const game = defineGame<GameState, IPhysicsContext>({
|
|
10
|
+
input: {
|
|
11
|
+
// The four directions of `input.vector("move")`. Declared rather than inherited from the
|
|
12
|
+
// default binding, so the axis every scene reads is visible where the game is defined.
|
|
13
|
+
move: {
|
|
14
|
+
down: ["ArrowDown", "KeyS"],
|
|
15
|
+
left: ["ArrowLeft", "KeyA"],
|
|
16
|
+
right: ["ArrowRight", "KeyD"],
|
|
17
|
+
up: ["ArrowUp", "KeyW"],
|
|
18
|
+
},
|
|
19
|
+
},
|
|
20
|
+
// `playtest()` installs the bridge a scenario needs to observe entities and state. Without
|
|
21
|
+
// it, semantic assertions fail closed with TN_PLAYTEST_BRIDGE_MISSING rather than passing.
|
|
22
|
+
plugins: [rapier(), playtest()],
|
|
23
|
+
render: config.renderer,
|
|
24
|
+
scenes: { play: Play },
|
|
25
|
+
start: "play",
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
export default game;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { acceptHotUpdate } from "@threenative/core/hot";
|
|
2
|
+
import game from "./game.js";
|
|
3
|
+
import "./style.css";
|
|
4
|
+
|
|
5
|
+
const app = document.querySelector<HTMLElement>("#app");
|
|
6
|
+
if (app === null) throw new Error("Missing #app element.");
|
|
7
|
+
|
|
8
|
+
// No DOM readout here. This template's HUD is `src/render/hud.ts`, drawn in the scene so it
|
|
9
|
+
// survives on native, and a second DOM copy of the same score rendered on top of it: a blind score
|
|
10
|
+
// of the first frame read "a small Score: 0 chip overlapping a large glowing SCORE 0". One HUD.
|
|
11
|
+
|
|
12
|
+
import.meta.hot?.accept();
|
|
13
|
+
acceptHotUpdate(game, import.meta.hot);
|
|
14
|
+
void game.start().then(() => {
|
|
15
|
+
const canvas = game.ctx?.renderer.domElement;
|
|
16
|
+
if (canvas !== undefined) app.prepend(canvas);
|
|
17
|
+
});
|