create-threenative 0.2.5 → 0.2.7
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 +25 -3
- package/agent-docs/references/assertion-reference.md +40 -1
- package/agent-docs/references/build-profiles.md +126 -0
- package/agent-docs/references/capability-reference.md +1382 -65
- package/agent-docs/references/finding-assets.md +8 -1
- package/agent-docs/references/performance-basics.md +117 -0
- package/agent-docs/references/rigging-characters.md +51 -0
- package/agent-docs/references/sculpt-from-a-reference.md +1 -1
- package/agent-docs/references/trace-a-slow-frame.md +1 -1
- package/agent-docs/references/visual-baseline.md +8 -4
- package/agent-docs/references/webview-ui.md +3 -2
- package/agent-files/.agents/skills/file-engine-bug/SKILL.md +15 -4
- package/agent-files/.agents/skills/ponytail/SKILL.md +68 -0
- package/agent-files/.agents/skills/threenative-assets/SKILL.md +12 -4
- package/agent-files/.agents/skills/threenative-capabilities/SKILL.md +1 -1
- package/agent-files/.agents/skills/threenative-context/SKILL.md +9 -1
- package/agent-files/.agents/skills/threenative-performance/SKILL.md +26 -10
- package/agent-files/.agents/skills/threenative-playtest/SKILL.md +1 -1
- package/agent-files/.agents/skills/threenative-ui/SKILL.md +1 -1
- package/agent-files/.agents/skills/threenative-visuals/SKILL.md +4 -4
- package/agent-files/.claude/hooks/ponytail-context.mjs +51 -0
- package/agent-files/.claude/settings.json +38 -0
- package/agent-files/.codex/hooks.json +40 -0
- package/capabilities.json +1891 -101
- package/dist/index.d.ts +39 -1
- package/dist/index.js +480 -56
- package/dist/threenative.js +1247 -177
- package/package.json +6 -6
- package/template-assets/assets/mannequin-combat.glb +0 -0
- package/template-assets/assets/mannequin.glb +0 -0
- package/template-assets/assets/player-viewmodel.glb +0 -0
- package/template-assets/assets/sky.jpg +0 -0
- package/template-assets/clearwater/README.md +141 -0
- package/template-assets/clearwater/install.mjs +50 -0
- package/template-assets/clearwater/src/clearwater.ts +180 -0
- package/template-assets/clearwater/src/clearwaterDemo.ts +28 -0
- package/template-assets/clearwater/src/clearwaterLifetime.ts +28 -0
- package/{LICENSE → template-assets/clearwater/src/render/CLEARWATER-LICENSE.txt} +4 -1
- package/template-assets/clearwater/src/render/clearwater.ts +278 -0
- package/template-assets/clearwater/src/render/clearwaterCaustics.ts +138 -0
- package/template-assets/clearwater/src/render/clearwaterDemo.ts +65 -0
- package/template-assets/clearwater/src/render/clearwaterOptics.ts +33 -0
- package/template-assets/clearwater/src/render/clearwaterOptions.ts +177 -0
- package/template-assets/clearwater/src/render/clearwaterPass.ts +51 -0
- package/template-assets/patches/three@0.185.1.patch +2228 -105
- package/template-assets/worldEnvironment.ts +52 -1
- package/templates/action-rpg/AGENTS.md +43 -43
- package/templates/action-rpg/CLAUDE.md +43 -43
- package/templates/action-rpg/kit.json +1 -1
- package/templates/action-rpg/package.json +14 -8
- package/templates/action-rpg/playtests/combat.playtest.json +162 -23
- package/templates/action-rpg/playtests/performance.playtest.json +4 -3
- package/templates/action-rpg/playtests/survives.playtest.json +25 -8
- package/templates/action-rpg/src/conventions.ts +24 -18
- package/templates/action-rpg/src/entities/Enemy.ts +74 -24
- package/templates/action-rpg/src/entities/Fighter.ts +127 -0
- package/templates/action-rpg/src/entities/Player.ts +102 -32
- package/templates/action-rpg/src/game.ts +3 -3
- package/templates/action-rpg/src/render/camera.ts +18 -16
- package/templates/action-rpg/src/render/dungeon.ts +192 -0
- package/templates/action-rpg/src/render/lighting.ts +45 -28
- package/templates/action-rpg/src/render/loading.ts +4 -4
- package/templates/action-rpg/src/render/materials.ts +191 -47
- package/templates/action-rpg/src/render/palette.ts +14 -13
- package/templates/action-rpg/src/render/postprocessing.ts +12 -2
- package/templates/action-rpg/src/render/props.ts +117 -0
- package/templates/action-rpg/src/render/quality.ts +40 -82
- package/templates/action-rpg/src/render/sky.ts +36 -13
- package/templates/action-rpg/src/render/touch-controls.ts +1 -1
- package/templates/action-rpg/src/render/worldEnvironment.ts +52 -1
- package/templates/action-rpg/src/scenes/Play.ts +61 -39
- package/templates/action-rpg/src/style.css +9 -7
- package/templates/action-rpg/src/ui/AbilityBar.tsx +3 -1
- package/templates/action-rpg/src/ui/Hud.tsx +3 -3
- package/templates/action-rpg/threenative.config.ts +14 -1
- package/templates/action-rpg/vite.config.ts +4 -1
- package/templates/minimal/AGENTS.md +12 -12
- package/templates/minimal/CLAUDE.md +12 -12
- package/templates/minimal/package.json +13 -7
- package/templates/minimal/playtests/play.playtest.json +6 -5
- package/templates/minimal/playtests/sky.playtest.json +27 -0
- package/templates/minimal/src/conventions.ts +6 -3
- package/templates/minimal/src/entities/Player.ts +73 -27
- package/templates/minimal/src/main.ts +2 -3
- package/templates/minimal/src/render/camera.ts +22 -4
- package/templates/minimal/src/render/lighting.ts +24 -48
- package/templates/minimal/src/render/materials.ts +158 -13
- package/templates/minimal/src/render/palette.ts +10 -7
- package/templates/minimal/src/render/postprocessing.ts +12 -25
- package/templates/minimal/src/render/quality.ts +35 -69
- package/templates/minimal/src/render/sky.ts +35 -54
- package/templates/minimal/src/render/touch-controls.ts +1 -1
- package/templates/minimal/src/render/worldEnvironment.ts +52 -1
- package/templates/minimal/src/scenes/Play.ts +121 -111
- package/templates/minimal/src/state.ts +0 -4
- package/templates/minimal/src/style.css +0 -10
- package/templates/minimal/threenative.config.ts +15 -1
- package/templates/minimal/vite.config.ts +4 -1
- package/templates/platformer/AGENTS.md +18 -56
- package/templates/platformer/CLAUDE.md +18 -56
- package/templates/platformer/kit.json +2 -2
- package/templates/platformer/package.json +14 -10
- package/templates/platformer/playtests/buffer.playtest.json +15 -5
- package/templates/platformer/playtests/collect.playtest.json +8 -34
- package/templates/platformer/playtests/coyote.playtest.json +12 -34
- package/templates/platformer/playtests/damage.playtest.json +40 -15
- package/templates/platformer/playtests/hud.playtest.json +34 -0
- package/templates/platformer/playtests/move.playtest.json +24 -0
- package/templates/platformer/playtests/performance.playtest.json +24 -7
- package/templates/platformer/playtests/respawn.playtest.json +46 -11
- package/templates/platformer/playtests/stomp.playtest.json +49 -12
- package/templates/platformer/playtests/survives.playtest.json +3 -19
- package/templates/platformer/playtests/world.playtest.json +26 -0
- package/templates/platformer/src/entities/Fox.ts +273 -0
- package/templates/platformer/src/entities/Pickup.ts +43 -60
- package/templates/platformer/src/entities/Walker.ts +88 -0
- package/templates/platformer/src/game.ts +11 -8
- package/templates/platformer/src/level/Checkpoints.ts +29 -16
- package/templates/platformer/src/level/Stage.ts +469 -0
- package/templates/platformer/src/render/blocks.ts +94 -0
- package/templates/platformer/src/render/camera.ts +28 -3
- package/templates/platformer/src/render/fox.ts +196 -0
- package/templates/platformer/src/render/lighting.ts +42 -33
- package/templates/platformer/src/render/materials.ts +115 -5
- package/templates/platformer/src/render/palette.ts +68 -53
- package/templates/platformer/src/render/pickups.ts +142 -0
- package/templates/platformer/src/render/postprocessing.ts +12 -2
- package/templates/platformer/src/render/props.ts +147 -0
- package/templates/platformer/src/render/quality.ts +47 -99
- package/templates/platformer/src/render/scenery.ts +172 -0
- package/templates/platformer/src/render/sky.ts +120 -31
- package/templates/platformer/src/render/touch-controls.ts +5 -2
- package/templates/platformer/src/render/walkers.ts +96 -0
- package/templates/platformer/src/render/waterfall.ts +85 -0
- package/templates/platformer/src/render/worldEnvironment.ts +52 -1
- package/templates/platformer/src/scenes/Boot.ts +3 -4
- package/templates/platformer/src/scenes/Play.ts +362 -0
- package/templates/platformer/src/state.ts +16 -14
- package/templates/platformer/src/style.css +9 -8
- package/templates/platformer/src/ui/Hud.tsx +62 -29
- package/templates/platformer/src/ui/Menu.tsx +2 -2
- package/templates/platformer/threenative.config.ts +14 -1
- package/templates/platformer/vite.config.ts +4 -1
- package/templates/puzzle/AGENTS.md +21 -22
- package/templates/puzzle/CLAUDE.md +21 -22
- package/templates/puzzle/assets/native-proof.glb +0 -0
- package/templates/puzzle/assets/native-proof.png +0 -0
- package/templates/puzzle/kit.json +1 -1
- package/templates/puzzle/package.json +14 -8
- package/templates/puzzle/playtests/axis.playtest.json +20 -0
- package/templates/puzzle/playtests/blocked.playtest.json +73 -0
- package/templates/puzzle/playtests/caused.playtest.json +65 -0
- package/templates/puzzle/playtests/lit.playtest.json +74 -0
- package/templates/puzzle/playtests/performance.playtest.json +24 -7
- package/templates/{starter/playtests/respawn.playtest.json → puzzle/playtests/push.playtest.json} +24 -19
- package/templates/puzzle/playtests/replay.playtest.json +81 -0
- package/templates/puzzle/playtests/restart.playtest.json +108 -0
- package/templates/puzzle/playtests/seal.playtest.json +98 -0
- package/templates/puzzle/playtests/settle.playtest.json +100 -0
- package/templates/puzzle/playtests/survives.playtest.json +6 -29
- package/templates/{starter/playtests/hot-reload.playtest.json → puzzle/playtests/travel.playtest.json} +6 -5
- package/templates/puzzle/src/entities/Crate.ts +99 -42
- package/templates/puzzle/src/entities/Seal.ts +69 -0
- package/templates/puzzle/src/entities/Warden.ts +135 -0
- package/templates/puzzle/src/game.ts +15 -11
- package/templates/puzzle/src/render/camera.ts +66 -31
- package/templates/puzzle/src/render/crateShape.ts +70 -0
- package/templates/puzzle/src/render/lighting.ts +41 -41
- package/templates/puzzle/src/render/loading.ts +4 -4
- package/templates/puzzle/src/render/materials.ts +131 -27
- package/templates/puzzle/src/render/palette.ts +19 -29
- package/templates/puzzle/src/render/postprocessing.ts +15 -3
- package/templates/puzzle/src/render/quality.ts +71 -80
- package/templates/puzzle/src/render/shapes.ts +109 -108
- package/templates/puzzle/src/render/sky.ts +18 -10
- package/templates/puzzle/src/render/touch-controls.ts +8 -51
- package/templates/puzzle/src/render/vault.ts +315 -0
- package/templates/puzzle/src/render/warden.ts +46 -0
- package/templates/puzzle/src/render/worldEnvironment.ts +52 -1
- package/templates/puzzle/src/scenes/Play.ts +793 -0
- package/templates/puzzle/src/state.ts +55 -24
- package/templates/puzzle/src/style.css +7 -8
- package/templates/puzzle/src/ui/App.tsx +2 -2
- package/templates/puzzle/src/ui/Hud.tsx +92 -40
- package/templates/puzzle/src/ui/Menu.tsx +40 -2
- package/templates/puzzle/threenative.config.ts +14 -1
- package/templates/puzzle/vite.config.ts +4 -1
- package/templates/racing/AGENTS.md +20 -21
- package/templates/racing/CLAUDE.md +20 -21
- package/templates/racing/package.json +14 -8
- package/templates/racing/playtests/boost.playtest.json +33 -12
- package/templates/racing/playtests/outcome.playtest.json +32 -50
- package/templates/racing/playtests/performance.playtest.json +2 -1
- package/templates/racing/playtests/ranking.playtest.json +5 -14
- package/templates/racing/playtests/rescue.playtest.json +2 -2
- package/templates/racing/playtests/reverse.playtest.json +30 -8
- package/templates/racing/playtests/shortcut.playtest.json +54 -9
- package/templates/racing/playtests/touch-controls.playtest.json +32 -5
- package/templates/racing/src/entities/CarBody.ts +327 -0
- package/templates/racing/src/entities/LineDriver.ts +220 -0
- package/templates/racing/src/entities/RacingCar.ts +150 -89
- package/templates/racing/src/entities/Rival.ts +61 -24
- package/templates/racing/src/game.ts +5 -0
- package/templates/racing/src/render/camera.ts +49 -7
- package/templates/racing/src/render/lighting.ts +36 -37
- package/templates/racing/src/render/materials.ts +239 -19
- package/templates/racing/src/render/palette.ts +19 -21
- package/templates/racing/src/render/postprocessing.ts +12 -2
- package/templates/racing/src/render/quality.ts +43 -82
- package/templates/racing/src/render/shapes.ts +20 -6
- package/templates/racing/src/render/sky.ts +47 -39
- package/templates/racing/src/render/touch-controls.ts +1 -1
- package/templates/racing/src/render/worldEnvironment.ts +52 -1
- package/templates/racing/src/scenes/Race.ts +107 -54
- package/templates/racing/src/state.ts +2 -0
- package/templates/racing/src/track/Checkline.ts +22 -7
- package/templates/racing/src/track/Lap.ts +64 -36
- package/templates/racing/src/track/Ranking.ts +20 -11
- package/templates/racing/src/track/Track.ts +809 -361
- package/templates/racing/src/track/TrackSector.ts +40 -11
- package/templates/racing/src/track/circuit.ts +477 -0
- package/templates/racing/src/track/rescue.ts +16 -4
- package/templates/racing/threenative.config.ts +14 -1
- package/templates/racing/vite.config.ts +4 -1
- package/templates/rts/AGENTS.md +96 -0
- package/templates/rts/CLAUDE.md +98 -0
- package/templates/rts/kit.json +7 -0
- package/templates/{defense → rts}/package.json +14 -8
- package/templates/{defense → rts}/playtests/performance.playtest.json +28 -26
- package/templates/rts/playtests/rts-ai-attack.playtest.json +24 -0
- package/templates/rts/playtests/rts-attack.playtest.json +75 -0
- package/templates/rts/playtests/rts-build.playtest.json +68 -0
- package/templates/rts/playtests/rts-orders.playtest.json +150 -0
- package/templates/rts/playtests/rts-train.playtest.json +62 -0
- package/templates/rts/playtests/survives.playtest.json +58 -0
- package/templates/rts/public/favicon.svg +4 -0
- package/templates/rts/src/game.ts +64 -0
- package/templates/rts/src/orders.ts +22 -0
- package/templates/rts/src/render/army.ts +346 -0
- package/templates/rts/src/render/camera.ts +123 -0
- package/templates/rts/src/render/lighting.ts +61 -0
- package/templates/rts/src/render/loading.ts +33 -0
- package/templates/rts/src/render/materials.ts +152 -0
- package/templates/rts/src/render/models.ts +705 -0
- package/templates/rts/src/render/palette.ts +17 -0
- package/templates/rts/src/render/picking.ts +93 -0
- package/templates/{defense → rts}/src/render/postprocessing.ts +15 -3
- package/templates/rts/src/render/quality.ts +128 -0
- package/templates/rts/src/render/resources.ts +141 -0
- package/templates/rts/src/render/sky.ts +44 -0
- package/templates/rts/src/render/terrain.ts +116 -0
- package/templates/{defense → rts}/src/render/worldEnvironment.ts +52 -1
- package/templates/rts/src/scenes/Play.ts +650 -0
- package/templates/rts/src/sim/ai.ts +1140 -0
- package/templates/rts/src/sim/combat.ts +416 -0
- package/templates/rts/src/sim/construction.ts +374 -0
- package/templates/rts/src/sim/economy.ts +167 -0
- package/templates/rts/src/sim/game.ts +1082 -0
- package/templates/rts/src/sim/movement.ts +371 -0
- package/templates/rts/src/sim/nav.ts +276 -0
- package/templates/rts/src/sim/production.ts +180 -0
- package/templates/rts/src/sim/terrain.ts +170 -0
- package/templates/rts/src/sim/types.ts +647 -0
- package/templates/rts/src/sim/vision.ts +46 -0
- package/templates/rts/src/state.ts +100 -0
- package/templates/{defense → rts}/src/style.css +21 -8
- package/templates/rts/src/ui/App.tsx +21 -0
- package/templates/rts/src/ui/Commands.tsx +129 -0
- package/templates/rts/src/ui/GameUi.tsx +22 -0
- package/templates/rts/src/ui/Hud.tsx +165 -0
- package/templates/rts/src/ui/Minimap.tsx +84 -0
- package/templates/rts/tailwind.config.ts +2 -0
- package/templates/rts/threenative.config.ts +56 -0
- package/templates/rts/tsconfig.json +17 -0
- package/templates/{defense → rts}/vite.config.ts +4 -1
- package/templates/runner/AGENTS.md +8 -12
- package/templates/runner/CLAUDE.md +8 -12
- package/templates/runner/README.md +3 -3
- package/templates/runner/package.json +14 -8
- package/templates/runner/playtests/performance.playtest.json +2 -2
- package/templates/runner/src/conventions.ts +4 -3
- package/templates/runner/src/entities/Runner.ts +54 -7
- package/templates/runner/src/game.ts +2 -0
- package/templates/runner/src/render/camera.ts +4 -2
- package/templates/runner/src/render/dust.ts +5 -2
- package/templates/runner/src/render/lighting.ts +41 -45
- package/templates/runner/src/render/loading.ts +2 -2
- package/templates/runner/src/render/materials.ts +165 -25
- package/templates/runner/src/render/palette.ts +17 -28
- package/templates/runner/src/render/postprocessing.ts +12 -2
- package/templates/runner/src/render/quality.ts +42 -96
- package/templates/runner/src/render/shapes.ts +59 -37
- package/templates/runner/src/render/sky.ts +32 -41
- package/templates/runner/src/render/touch-controls.ts +1 -1
- package/templates/runner/src/render/worldEnvironment.ts +52 -1
- package/templates/runner/src/scenes/Run.ts +26 -6
- package/templates/runner/src/track.ts +6 -1
- package/templates/runner/threenative.config.ts +14 -1
- package/templates/runner/vite.config.ts +4 -1
- package/templates/sailing/AGENTS.md +14 -14
- package/templates/sailing/CLAUDE.md +14 -14
- package/templates/sailing/assets/ship.glb +0 -0
- package/templates/sailing/package.json +14 -8
- package/templates/sailing/playtests/float-after-the-run-ends.playtest.json +10 -6
- package/templates/sailing/playtests/sails.playtest.json +33 -0
- package/templates/sailing/playtests/win.playtest.json +156 -8
- package/templates/sailing/src/conventions.ts +29 -2
- package/templates/sailing/src/entities/Ship.ts +381 -57
- package/templates/sailing/src/game.ts +14 -0
- package/templates/sailing/src/render/camera.ts +63 -9
- package/templates/sailing/src/render/lighting.ts +49 -27
- package/templates/sailing/src/render/materials.ts +50 -15
- package/templates/sailing/src/render/ocean.ts +647 -60
- package/templates/sailing/src/render/palette.ts +16 -12
- package/templates/sailing/src/render/postprocessing.ts +12 -2
- package/templates/sailing/src/render/props.ts +316 -442
- package/templates/sailing/src/render/quality.ts +14 -4
- package/templates/sailing/src/render/sky.ts +116 -23
- package/templates/sailing/src/render/worldEnvironment.ts +52 -1
- package/templates/sailing/src/scenes/Boot.ts +21 -0
- package/templates/sailing/src/scenes/Sailing.ts +173 -39
- package/templates/sailing/src/state.ts +6 -0
- package/templates/sailing/src/ui/Hud.tsx +41 -9
- package/templates/sailing/threenative.config.ts +14 -1
- package/templates/sailing/vite.config.ts +4 -1
- package/templates/shooter/AGENTS.md +29 -44
- package/templates/shooter/CLAUDE.md +29 -44
- package/templates/shooter/index.html +1 -0
- package/templates/shooter/package.json +14 -8
- package/templates/shooter/playtests/aim-alignment.playtest.json +58 -0
- package/templates/shooter/playtests/breakable-shatters.playtest.json +62 -0
- package/templates/shooter/playtests/bullet-holes.playtest.json +56 -0
- package/templates/shooter/playtests/camera-tracks-body-vertically.playtest.json +61 -0
- package/templates/shooter/playtests/crouch-lowers-the-eye.playtest.json +41 -0
- package/templates/shooter/playtests/death-no-snap.playtest.json +77 -0
- package/templates/shooter/playtests/debug-ads.playtest.json +58 -0
- package/templates/shooter/playtests/debug-clear.playtest.json +383 -0
- package/templates/shooter/playtests/debug-endurance.playtest.json +61 -0
- package/templates/shooter/playtests/debug-fire.playtest.json +119 -0
- package/templates/shooter/playtests/debug-restart.playtest.json +24 -0
- package/templates/shooter/playtests/enemy-body-is-a-body.playtest.json +79 -0
- package/templates/shooter/playtests/enemy-death-settles.playtest.json +64 -0
- package/templates/shooter/playtests/enemy-flinches-when-hit.playtest.json +75 -0
- package/templates/shooter/playtests/enemy-foot-contact.playtest.json +41 -0
- package/templates/shooter/playtests/enemy-material-is-not-shared.playtest.json +59 -0
- package/templates/shooter/playtests/enemy-reaches-walkway.playtest.json +80 -0
- package/templates/shooter/playtests/enemy-rifle-grip.playtest.json +101 -0
- package/templates/shooter/playtests/enemy-scale.playtest.json +56 -0
- package/templates/shooter/playtests/enemy-stops-without-snapping.playtest.json +486 -0
- package/templates/shooter/playtests/enemy-stride-matches-speed.playtest.json +198 -0
- package/templates/shooter/playtests/enemy-stride-under-crouch.playtest.json +87 -0
- package/templates/shooter/playtests/enemy-uses-crouch-clips.playtest.json +74 -0
- package/templates/shooter/playtests/five-soldiers.playtest.json +83 -0
- package/templates/shooter/playtests/flash-retires.playtest.json +62 -0
- package/templates/shooter/playtests/headshot-hits-head.playtest.json +132 -0
- package/templates/shooter/playtests/hold-to-fire.playtest.json +45 -0
- package/templates/shooter/playtests/input-control.playtest.json +43 -98
- package/templates/shooter/playtests/minimap-state.playtest.json +75 -0
- package/templates/shooter/playtests/performance.playtest.json +62 -26
- package/templates/{starter/playtests/forward.playtest.json → shooter/playtests/round-clock.playtest.json} +11 -16
- package/templates/shooter/playtests/shot-tracks-crosshair.playtest.json +79 -0
- package/templates/shooter/playtests/survives.playtest.json +36 -30
- package/templates/shooter/playtests/walkway-reachable.playtest.json +67 -0
- package/templates/shooter/src/entities/Breakables.ts +412 -0
- package/templates/shooter/src/entities/Enemy.ts +2095 -0
- package/templates/shooter/src/entities/FpsPlayer.ts +283 -0
- package/templates/shooter/src/entities/Rifle.ts +442 -0
- package/templates/shooter/src/entities/Target.ts +199 -83
- package/templates/shooter/src/entities/TouchControls.ts +276 -0
- package/templates/shooter/src/game.ts +75 -41
- package/templates/shooter/src/main.ts +0 -1
- package/templates/shooter/src/postPhysics.ts +36 -0
- package/templates/shooter/src/render/camera.ts +78 -74
- package/templates/shooter/src/render/decals.ts +142 -82
- package/templates/shooter/src/render/facade.ts +1373 -0
- package/templates/shooter/src/render/gunfx.ts +704 -0
- package/templates/shooter/src/render/lighting.ts +52 -38
- package/templates/shooter/src/render/loading.ts +2 -2
- package/templates/shooter/src/render/materials.ts +100 -88
- package/templates/shooter/src/render/occlusion.ts +108 -0
- package/templates/shooter/src/render/palette.ts +10 -10
- package/templates/shooter/src/render/palm.ts +455 -0
- package/templates/shooter/src/render/pooled-billboards.ts +144 -0
- package/templates/shooter/src/render/postprocessing.ts +15 -3
- package/templates/shooter/src/render/quality.ts +40 -82
- package/templates/shooter/src/render/scale.ts +148 -15
- package/templates/shooter/src/render/shapes.ts +138 -613
- package/templates/shooter/src/render/sky.ts +35 -35
- package/templates/shooter/src/render/town-schematic.ts +120 -0
- package/templates/shooter/src/render/town.ts +986 -0
- package/templates/shooter/src/render/townMaterials.ts +160 -0
- package/templates/shooter/src/render/vehicles.ts +741 -0
- package/templates/shooter/src/render/worldEnvironment.ts +52 -1
- package/templates/shooter/src/scenes/Play.ts +727 -650
- package/templates/shooter/src/state.ts +26 -41
- package/templates/shooter/src/style.css +207 -11
- package/templates/shooter/src/surfaces.ts +131 -0
- package/templates/shooter/src/ui/App.tsx +9 -10
- package/templates/shooter/src/ui/Crosshair.tsx +25 -18
- package/templates/shooter/src/ui/GameUi.tsx +6 -9
- package/templates/shooter/src/ui/Hud.tsx +428 -39
- package/templates/shooter/src/ui/Minimap.tsx +164 -0
- package/templates/shooter/src/ui/TouchOverlay.tsx +54 -0
- package/templates/shooter/src/ui/main.tsx +2 -3
- package/templates/shooter/threenative.config.ts +14 -1
- package/templates/shooter/vite.config.ts +4 -1
- package/templates/starter/AGENTS.md +20 -20
- package/templates/starter/CLAUDE.md +20 -20
- package/templates/starter/native-playtests/render-chain.playtest.json +13 -45
- package/templates/starter/package.json +15 -9
- package/templates/starter/playtests/play.playtest.json +2 -1
- package/templates/starter/playtests/{restart.playtest.json → production-readiness.playtest.json} +17 -12
- package/templates/starter/playtests/survives.playtest.json +1 -1
- package/templates/starter/src/conventions.ts +6 -3
- package/templates/starter/src/entities/Goal.ts +35 -42
- package/templates/starter/src/entities/Player.ts +99 -16
- package/templates/starter/src/render/arena.ts +131 -0
- package/templates/starter/src/render/lighting.ts +27 -44
- package/templates/starter/src/render/materials.ts +164 -35
- package/templates/starter/src/render/palette.ts +16 -16
- package/templates/starter/src/render/postprocessing.ts +6 -7
- package/templates/starter/src/render/quality.ts +43 -101
- package/templates/starter/src/render/shapes.ts +1 -1
- package/templates/starter/src/render/sky.ts +39 -45
- package/templates/starter/src/render/touch-controls.ts +3 -1
- package/templates/starter/src/render/worldEnvironment.ts +52 -1
- package/templates/starter/src/scenes/Play.ts +82 -81
- package/templates/starter/src/ui/Hud.tsx +2 -2
- package/templates/starter/src/ui/Menu.tsx +5 -1
- package/templates/starter/threenative.config.ts +14 -1
- package/templates/starter/vite.config.ts +4 -1
- package/templates/tower-defense/.codex/config.toml +19 -0
- package/templates/tower-defense/.cursor/mcp.json +32 -0
- package/templates/tower-defense/.gemini/settings.json +32 -0
- package/templates/tower-defense/.mcp.json +32 -0
- package/templates/tower-defense/.vscode/mcp.json +36 -0
- package/templates/tower-defense/.zed/settings.json +36 -0
- package/templates/{defense → tower-defense}/AGENTS.md +16 -14
- package/templates/{defense → tower-defense}/CLAUDE.md +16 -14
- package/templates/tower-defense/README.md +16 -0
- package/templates/tower-defense/index.html +12 -0
- package/templates/tower-defense/kit.json +7 -0
- package/templates/tower-defense/opencode.json +41 -0
- package/templates/tower-defense/package.json +56 -0
- package/templates/tower-defense/playtests/arsenal.playtest.json +214 -0
- package/templates/tower-defense/playtests/defeat.playtest.json +85 -0
- package/templates/tower-defense/playtests/look.playtest.json +130 -0
- package/templates/tower-defense/playtests/performance.playtest.json +77 -0
- package/templates/tower-defense/playtests/placement.playtest.json +115 -0
- package/templates/{defense → tower-defense}/playtests/pointer-placement.playtest.json +21 -49
- package/templates/tower-defense/playtests/strike.playtest.json +98 -0
- package/templates/tower-defense/playtests/survives.playtest.json +85 -0
- package/templates/tower-defense/playtests/target-priority.playtest.json +177 -0
- package/templates/tower-defense/playtests/upgrade-recycle.playtest.json +124 -0
- package/templates/tower-defense/playtests/victory.playtest.json +810 -0
- package/templates/tower-defense/src/balance.ts +187 -0
- package/templates/tower-defense/src/board/Board.ts +100 -0
- package/templates/tower-defense/src/board/Route.ts +84 -0
- package/templates/tower-defense/src/camera-rig.ts +62 -0
- package/templates/tower-defense/src/economy.ts +64 -0
- package/templates/tower-defense/src/effects/Effects.ts +284 -0
- package/templates/tower-defense/src/enemies/Enemy.ts +198 -0
- package/templates/tower-defense/src/game.ts +72 -0
- package/templates/tower-defense/src/intents.ts +21 -0
- package/templates/tower-defense/src/main.ts +15 -0
- package/templates/tower-defense/src/physics.ts +6 -0
- package/templates/tower-defense/src/render/camera.ts +38 -0
- package/templates/tower-defense/src/render/lighting.ts +42 -0
- package/templates/{defense → tower-defense}/src/render/loading.ts +3 -3
- package/templates/tower-defense/src/render/materials.ts +103 -0
- package/templates/tower-defense/src/render/palette.ts +58 -0
- package/templates/tower-defense/src/render/postprocessing.ts +46 -0
- package/templates/tower-defense/src/render/quality.ts +128 -0
- package/templates/tower-defense/src/render/shapes.ts +550 -0
- package/templates/tower-defense/src/render/sky.ts +27 -0
- package/templates/tower-defense/src/render/worldEnvironment.ts +809 -0
- package/templates/tower-defense/src/scenes/Battle.ts +539 -0
- package/templates/{shooter → tower-defense}/src/scenes/Boot.ts +3 -3
- package/templates/tower-defense/src/state.ts +88 -0
- package/templates/tower-defense/src/style.css +137 -0
- package/templates/tower-defense/src/towers/Tower.ts +230 -0
- package/templates/tower-defense/src/towers/targeting.ts +97 -0
- package/templates/tower-defense/src/ui/Hud.tsx +270 -0
- package/templates/tower-defense/src/ui/Menu.tsx +134 -0
- package/templates/tower-defense/src/ui/icons.tsx +54 -0
- package/templates/tower-defense/src/ui/main.tsx +14 -0
- package/templates/tower-defense/src/waves.ts +90 -0
- package/templates/{defense → tower-defense}/threenative.config.ts +14 -1
- package/templates/tower-defense/vite.config.ts +41 -0
- package/agent-files/.claude/skills/file-engine-bug/SKILL.md +0 -59
- package/agent-files/.claude/skills/prd-creator/SKILL.md +0 -40
- package/agent-files/.claude/skills/threenative-assets/SKILL.md +0 -45
- package/agent-files/.claude/skills/threenative-capabilities/SKILL.md +0 -27
- package/agent-files/.claude/skills/threenative-context/SKILL.md +0 -57
- package/agent-files/.claude/skills/threenative-performance/SKILL.md +0 -42
- package/agent-files/.claude/skills/threenative-playtest/SKILL.md +0 -44
- package/agent-files/.claude/skills/threenative-ui/SKILL.md +0 -20
- package/agent-files/.claude/skills/threenative-visuals/SKILL.md +0 -41
- package/agent-files/AGENT-ROLES.md +0 -26
- package/templates/action-rpg/src/render/shapes.ts +0 -269
- package/templates/action-rpg/src/render/types.ts +0 -3
- package/templates/action-rpg/src/scenes/Boot.ts +0 -12
- package/templates/defense/README.md +0 -10
- package/templates/defense/kit.json +0 -7
- package/templates/defense/playtests/leak.playtest.json +0 -23
- package/templates/defense/playtests/placement.playtest.json +0 -40
- package/templates/defense/playtests/scan.playtest.json +0 -20
- package/templates/defense/playtests/survive.playtest.json +0 -45
- package/templates/defense/playtests/survives.playtest.json +0 -36
- package/templates/defense/src/attackers/Attacker.ts +0 -120
- package/templates/defense/src/board/Route.ts +0 -94
- package/templates/defense/src/conventions.ts +0 -18
- package/templates/defense/src/economy.ts +0 -36
- package/templates/defense/src/entities/Player.ts +0 -52
- package/templates/defense/src/game.ts +0 -51
- package/templates/defense/src/physics.ts +0 -13
- package/templates/defense/src/placement/Buildable.ts +0 -49
- package/templates/defense/src/render/camera.ts +0 -16
- package/templates/defense/src/render/lighting.ts +0 -37
- package/templates/defense/src/render/materials.ts +0 -22
- package/templates/defense/src/render/palette.ts +0 -28
- package/templates/defense/src/render/quality.ts +0 -170
- package/templates/defense/src/render/shapes.ts +0 -246
- package/templates/defense/src/render/sky.ts +0 -45
- package/templates/defense/src/scenes/Boot.ts +0 -12
- package/templates/defense/src/scenes/Defense.ts +0 -231
- package/templates/defense/src/state.ts +0 -56
- package/templates/defense/src/towers/Tower.ts +0 -95
- package/templates/defense/src/towers/targeting.ts +0 -53
- package/templates/defense/src/ui/Hud.tsx +0 -62
- package/templates/defense/src/ui/Menu.tsx +0 -7
- package/templates/defense/src/waves.ts +0 -40
- package/templates/minimal/playtests/atmosphere.playtest.json +0 -32
- package/templates/minimal/src/render/hud.ts +0 -69
- package/templates/platformer/playtests/avoidance.playtest.json +0 -28
- package/templates/platformer/playtests/chase.playtest.json +0 -21
- package/templates/platformer/playtests/collision-layers.playtest.json +0 -36
- package/templates/platformer/playtests/oneway.playtest.json +0 -44
- package/templates/platformer/playtests/patrol.playtest.json +0 -13
- package/templates/platformer/playtests/physics.playtest.json +0 -14
- package/templates/platformer/playtests/stomp-rise.playtest.json +0 -55
- package/templates/platformer/playtests/terminal-loop-fail.playtest.json +0 -41
- package/templates/platformer/playtests/terminal-loop-win.playtest.json +0 -52
- package/templates/platformer/src/conventions.ts +0 -18
- package/templates/platformer/src/entities/Character.ts +0 -286
- package/templates/platformer/src/entities/Chaser.ts +0 -118
- package/templates/platformer/src/entities/Patrol.ts +0 -93
- package/templates/platformer/src/level/Platform.ts +0 -46
- package/templates/platformer/src/render/rig.ts +0 -60
- package/templates/platformer/src/render/terrain.ts +0 -31
- package/templates/platformer/src/scenes/Level.ts +0 -241
- package/templates/puzzle/README.md +0 -43
- package/templates/puzzle/playtests/carry.playtest.json +0 -71
- package/templates/puzzle/playtests/swing.playtest.json +0 -38
- package/templates/puzzle/src/conventions.ts +0 -25
- package/templates/puzzle/src/entities/Ball.ts +0 -70
- package/templates/puzzle/src/entities/Gripper.ts +0 -69
- package/templates/puzzle/src/entities/Pendulum.ts +0 -89
- package/templates/puzzle/src/physics.ts +0 -19
- package/templates/puzzle/src/room.ts +0 -83
- package/templates/puzzle/src/scenes/Boot.ts +0 -12
- package/templates/puzzle/src/scenes/Puzzle.ts +0 -158
- package/templates/shooter/playtests/combat.playtest.json +0 -48
- package/templates/shooter/playtests/fail.playtest.json +0 -31
- package/templates/shooter/playtests/per-item.playtest.json +0 -59
- package/templates/shooter/playtests/shooter.playtest.json +0 -99
- package/templates/shooter/playtests/touch-controls.playtest.json +0 -42
- package/templates/shooter/playtests/weapon-cycle.playtest.json +0 -164
- package/templates/shooter/src/combat/damage.ts +0 -40
- package/templates/shooter/src/conventions.ts +0 -51
- package/templates/shooter/src/entities/Pickup.ts +0 -70
- package/templates/shooter/src/entities/Player.ts +0 -310
- package/templates/shooter/src/level/SpawnPoints.ts +0 -28
- package/templates/shooter/src/playtest-events.ts +0 -15
- package/templates/shooter/src/render/touch-controls.ts +0 -305
- package/templates/shooter/src/render/types.ts +0 -3
- package/templates/shooter/src/render/ui.css +0 -330
- package/templates/shooter/src/render/ui.ts +0 -75
- package/templates/shooter/src/render/vfx.ts +0 -215
- package/templates/shooter/src/ui/Menu.tsx +0 -41
- package/templates/shooter/src/waves.ts +0 -50
- package/templates/shooter/src/weapons/Hitscan.ts +0 -42
- package/templates/shooter/src/weapons/Projectile.ts +0 -92
- package/templates/shooter/src/weapons/Viewmodel.ts +0 -275
- package/templates/starter/playtests/assets.playtest.json +0 -65
- package/templates/starter/playtests/buffer.playtest.json +0 -79
- package/templates/starter/playtests/cloth.playtest.json +0 -113
- package/templates/starter/playtests/coyote.playtest.json +0 -87
- package/templates/starter/playtests/gameover.playtest.json +0 -66
- package/templates/starter/playtests/goal.playtest.json +0 -67
- package/templates/starter/playtests/look.playtest.json +0 -175
- package/templates/starter/playtests/models-baseline.png +0 -0
- package/templates/starter/playtests/models.playtest.json +0 -74
- package/templates/starter/playtests/monitoring.playtest.json +0 -72
- package/templates/starter/playtests/odometer.playtest.json +0 -54
- package/templates/starter/playtests/seed.playtest.json +0 -54
- package/templates/starter/playtests/textures-baseline.png +0 -0
- package/templates/starter/playtests/textures.playtest.json +0 -74
- package/templates/starter/playtests/touch-controls.playtest.json +0 -42
- package/templates/starter/playtests/zoom-pinch.playtest.json +0 -86
- package/templates/starter/playtests/zoom-wheel.playtest.json +0 -59
- package/templates/starter/src/render/coast.ts +0 -199
- package/templates/starter/src/render/hero.ts +0 -88
- package/templates/starter/src/render/implicitSurface.ts +0 -199
- package/templates/starter/src/render/kuwahara.ts +0 -174
- package/templates/starter/src/render/outline.ts +0 -141
- package/templates/starter/src/render/painterly.ts +0 -86
- package/templates/starter/src/render/rockRidge.ts +0 -198
- package/templates/starter/src/render/rockRidge.worker.ts +0 -77
- package/templates/starter/src/render/scenery.ts +0 -40
- package/templates/starter/src/render/textureLifetime.ts +0 -53
- package/templates/starter/src/render/water.ts +0 -38
- package/templates/starter/src/render/watercolor.ts +0 -85
- /package/templates/{starter → puzzle}/playtests/boot-failure.playtest.json +0 -0
- /package/templates/{starter → puzzle}/playtests/pause.playtest.json +0 -0
- /package/templates/{defense → rts}/.codex/config.toml +0 -0
- /package/templates/{defense → rts}/.cursor/mcp.json +0 -0
- /package/templates/{defense → rts}/.gemini/settings.json +0 -0
- /package/templates/{defense → rts}/.mcp.json +0 -0
- /package/templates/{defense → rts}/.vscode/mcp.json +0 -0
- /package/templates/{defense → rts}/.zed/settings.json +0 -0
- /package/templates/{defense → rts}/index.html +0 -0
- /package/templates/{defense → rts}/opencode.json +0 -0
- /package/templates/{defense → rts}/src/main.ts +0 -0
- /package/templates/{defense → rts}/src/ui/main.tsx +0 -0
- /package/templates/{defense → tower-defense}/public/favicon.svg +0 -0
- /package/templates/{defense → tower-defense}/src/playtest-events.ts +0 -0
- /package/templates/{defense → tower-defense}/src/ui/App.tsx +0 -0
- /package/templates/{defense → tower-defense}/src/ui/GameUi.tsx +0 -0
- /package/templates/{defense → tower-defense}/tailwind.config.ts +0 -0
- /package/templates/{defense → tower-defense}/tsconfig.json +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-threenative",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.7",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "Scaffold a readable ThreeNative game project.",
|
|
6
6
|
"keywords": [
|
|
@@ -77,13 +77,13 @@
|
|
|
77
77
|
"tsup": "8.5.1",
|
|
78
78
|
"typescript": "5.9.3",
|
|
79
79
|
"vite": "8.2.0",
|
|
80
|
-
"@threenative/
|
|
81
|
-
"@threenative/
|
|
82
|
-
"@threenative/
|
|
83
|
-
"threenative-blender-mcp": "0.1.
|
|
80
|
+
"@threenative/core": "0.3.4",
|
|
81
|
+
"@threenative/physics": "0.3.4",
|
|
82
|
+
"@threenative/assets": "0.3.5",
|
|
83
|
+
"threenative-blender-mcp": "0.1.4"
|
|
84
84
|
},
|
|
85
85
|
"peerDependencies": {
|
|
86
|
-
"@threenative/assets": ">=0.3.
|
|
86
|
+
"@threenative/assets": ">=0.3.5 <0.4.0"
|
|
87
87
|
},
|
|
88
88
|
"scripts": {
|
|
89
89
|
"build": "tsup --config tsup.config.ts && publint",
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# Clearwater for ThreeNative
|
|
2
|
+
|
|
3
|
+
An opt-in, editable shallow-water abstraction adapted from
|
|
4
|
+
[Aurélien / Lumaris's Clearwater](https://github.com/Aureliengmz/clearwater).
|
|
5
|
+
It composes ThreeNative's existing FFT ocean, ripple field and water-surface capture;
|
|
6
|
+
it does not embed a second WebGL renderer or replace your scene, camera, lights or postprocessing.
|
|
7
|
+
|
|
8
|
+
**Qualification:** implementation candidate. The numerical/lifecycle contracts and installer
|
|
9
|
+
have been executed locally. Browser WebGPU pixels, desktop-native parity and mobile performance
|
|
10
|
+
remain unverified. This is not a claim of pixel-identical reproduction of the upstream demo.
|
|
11
|
+
|
|
12
|
+
## Install into an existing game
|
|
13
|
+
|
|
14
|
+
Use the `create-threenative` package built from this branch; older published versions do not
|
|
15
|
+
contain this module. From the game's root:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
node node_modules/create-threenative/template-assets/clearwater/install.mjs
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
From an engine checkout, the equivalent is:
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
node packages/create-threenative/template-assets/clearwater/install.mjs /absolute/path/to/game
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
This copies source and the upstream license into `src/`, refusing to overwrite existing files.
|
|
28
|
+
The installer is optional: copying this bundle's `src/` contents does exactly the same thing.
|
|
29
|
+
There is no new runtime dependency and no new `threenative` CLI command. Default scaffold
|
|
30
|
+
files and their appearance are unchanged. Keep the license with redistributed adapted source.
|
|
31
|
+
|
|
32
|
+
## Add water
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
import { createClearwater } from "./clearwater.js";
|
|
36
|
+
|
|
37
|
+
// Inside Scene.enter(ctx):
|
|
38
|
+
const water = createClearwater(ctx, {
|
|
39
|
+
size: 32,
|
|
40
|
+
center: [0, 0],
|
|
41
|
+
level: 0,
|
|
42
|
+
depth: 2,
|
|
43
|
+
sunDirection: [0.45, 0.82, 0.3],
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
// World-space events: footsteps, a projectile impact or an object hitting the surface.
|
|
47
|
+
water.disturb(1, 2, 0.25, -0.04);
|
|
48
|
+
water.follow(player.position.x, player.position.z);
|
|
49
|
+
|
|
50
|
+
// Optional live controls and CPU height query.
|
|
51
|
+
water.setLevel(0.5);
|
|
52
|
+
water.setSunDirection([0.3, 0.9, 0.2]);
|
|
53
|
+
const sample = water.sampleHeight(1, 2); // undefined until GPU readback arrives
|
|
54
|
+
if (sample !== undefined && sample.staleFrames <= 6) {
|
|
55
|
+
// sample.height includes mean level, spectral height and the current local ripple.
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
// Explicit early removal; normal scene-root removal also disposes automatically.
|
|
59
|
+
water.dispose();
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
No manual `update()` or render-target juggling is required. The factory registers the fixed
|
|
63
|
+
clock and a single before-render dispatch; it unregisters both and releases its geometry,
|
|
64
|
+
materials, buffers, textures and reflection target on disposal. Do not also add `water.ocean`
|
|
65
|
+
to the scene: that would register a second compute dispatch. The exposed `mesh`, `material`,
|
|
66
|
+
`ripples`, `ocean` and `causticsTexture` are ordinary engine/Three.js objects, not wrappers.
|
|
67
|
+
|
|
68
|
+
Keep `mesh` as an untransformed scene-root child. `center` and `setLevel` are world-space;
|
|
69
|
+
parent transforms, rotating the surface and non-horizontal water volumes are unsupported.
|
|
70
|
+
|
|
71
|
+
## What is included
|
|
72
|
+
|
|
73
|
+
- Two cascaded GPU FFT bands, reusing `SpectralOcean` rather than duplicating Clearwater's FFT.
|
|
74
|
+
- A moving finite `RippleField`, uploaded only when changed; local disturbances never repeat
|
|
75
|
+
across the ocean. The bounded patch intentionally returns false for out-of-patch impulses.
|
|
76
|
+
- Exact air-to-water dielectric Fresnel, Beer–Lambert RGB extinction, approximate in-scattering,
|
|
77
|
+
scene reflection/refraction and derivative-widened sun glints.
|
|
78
|
+
- A three-channel refracted ray grid: the same height/normal field as the visible surface
|
|
79
|
+
focuses light onto a planar receiver. This is not a scrolling noise caustic texture.
|
|
80
|
+
- Explicit bounded resolution controls; no hidden adaptive quality or global tone-mapping changes.
|
|
81
|
+
|
|
82
|
+
`reflectionLayers` can exclude expensive objects from the mirrored scene.
|
|
83
|
+
`reflectionScale` and `reflectionRefreshInterval` control mirror cost.
|
|
84
|
+
For a lower-cost starting point use `resolution: 32`, `segments: 64`,
|
|
85
|
+
`rippleResolution: 32`, `causticsResolution: 256`, `causticsSegments: 64` and
|
|
86
|
+
`reflectionScale: 0.25`. These are cost controls, not measured phone-performance guarantees.
|
|
87
|
+
`caustics: false` and `reflection: false` explicitly omit those passes.
|
|
88
|
+
|
|
89
|
+
## Demo and validation
|
|
90
|
+
|
|
91
|
+
The installer also copies the optional `ClearwaterDemo` scene, with a real opaque bed,
|
|
92
|
+
submerged blocks, a foreground pillar and a periodic disturbance. It has no DOM dependencies.
|
|
93
|
+
To run the fixture, select it in a scratch game's `src/game.ts`:
|
|
94
|
+
|
|
95
|
+
```ts
|
|
96
|
+
import { defineGame } from "@threenative/core";
|
|
97
|
+
import config from "../threenative.config.js";
|
|
98
|
+
import { ClearwaterDemo } from "./clearwaterDemo.js";
|
|
99
|
+
|
|
100
|
+
export default defineGame({
|
|
101
|
+
display: config.display,
|
|
102
|
+
render: config.renderer,
|
|
103
|
+
scenes: { water: ClearwaterDemo },
|
|
104
|
+
start: "water",
|
|
105
|
+
});
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Use the game's existing browser/native entrypoints. Keep any UI disabled in this scratch fixture.
|
|
109
|
+
Check the bed through the water, the pillar's dry portion for refraction bleed, the reflection,
|
|
110
|
+
periodic rings, moving RGB caustics, two simultaneous water bodies, level/sun changes, scene
|
|
111
|
+
re-entry and disposal. Compare browser and native captures at the same time/camera before
|
|
112
|
+
calling either path qualified.
|
|
113
|
+
|
|
114
|
+
Repository checks:
|
|
115
|
+
|
|
116
|
+
```sh
|
|
117
|
+
pnpm exec vitest run packages/create-threenative/__tests__/clearwater*.spec.ts
|
|
118
|
+
pnpm typecheck
|
|
119
|
+
pnpm lint
|
|
120
|
+
pnpm test
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
The graph-construction test uses real Three.js objects but is not a WGSL compilation or pixel test.
|
|
124
|
+
|
|
125
|
+
## Boundaries
|
|
126
|
+
|
|
127
|
+
Requires ThreeNative's **WebGPU** renderer, including its native WebGPU path. It explicitly
|
|
128
|
+
rejects WebGL2: ThreeNative's FFT uses storage buffers/compute, unlike the upstream fragment-pass
|
|
129
|
+
FFT. Native, Android and iOS execution must each be qualified; shared source alone is not proof.
|
|
130
|
+
|
|
131
|
+
This is an **above-water**, finite, horizontal shallow-water surface, not an underwater-camera
|
|
132
|
+
system or deep-ocean terrain solver. The scene must provide real opaque geometry below it.
|
|
133
|
+
Refraction uses the opaque screen snapshot, so offscreen scenery and transparent objects are
|
|
134
|
+
not traced. Caustics are focused at `depth` below the mean level and fade when the actual receiver
|
|
135
|
+
is far from that plane. They modulate captured receiver colour, not individual direct-light
|
|
136
|
+
terms or shadow visibility: steep beds, cliffs, oblique receivers and exact radiometry require
|
|
137
|
+
a more advanced receiver/light integration. No chromatic-aberration postprocess, lens glare,
|
|
138
|
+
embedded pebble image or baked headland is copied from the standalone demo.
|
|
139
|
+
|
|
140
|
+
Optics, colours, sun radiance and tessellation live in `src/render/clearwater*.ts` and are yours
|
|
141
|
+
to edit. The original MIT notice is in `src/render/CLEARWATER-LICENSE.txt`.
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { cp, lstat, mkdir, readdir } from "node:fs/promises";
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
import { fileURLToPath } from "node:url";
|
|
4
|
+
|
|
5
|
+
// Explicit opt-in source installation, not a new threenative CLI command or runtime dependency.
|
|
6
|
+
const source = fileURLToPath(new URL("./src/", import.meta.url));
|
|
7
|
+
const destination = path.resolve(process.argv[2] ?? process.cwd(), "src");
|
|
8
|
+
const files = [];
|
|
9
|
+
const directories = [""];
|
|
10
|
+
async function walk(directory, prefix = "") {
|
|
11
|
+
for (const entry of await readdir(directory, { withFileTypes: true })) {
|
|
12
|
+
const relative = path.join(prefix, entry.name);
|
|
13
|
+
if (entry.isDirectory()) {
|
|
14
|
+
directories.push(relative);
|
|
15
|
+
await walk(path.join(directory, entry.name), relative);
|
|
16
|
+
} else files.push(relative);
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
await walk(source);
|
|
20
|
+
// Check parents first: lstat(file) follows directory links, including links outside the game.
|
|
21
|
+
// A dangling directory link must also fail before any earlier source file has been copied.
|
|
22
|
+
for (const relative of directories) {
|
|
23
|
+
const target = path.join(destination, relative);
|
|
24
|
+
try {
|
|
25
|
+
const stat = await lstat(target);
|
|
26
|
+
if (stat.isSymbolicLink())
|
|
27
|
+
throw new Error(`Refusing to install through symbolic link ${target}.`);
|
|
28
|
+
if (!stat.isDirectory()) throw new Error(`Refusing to install into non-directory ${target}.`);
|
|
29
|
+
} catch (error) {
|
|
30
|
+
if (error.code !== "ENOENT") throw error;
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
// Preflight all names before the first copy. Existing game source must never be overwritten.
|
|
34
|
+
for (const relative of files) {
|
|
35
|
+
const target = path.join(destination, relative);
|
|
36
|
+
try {
|
|
37
|
+
await lstat(target);
|
|
38
|
+
throw new Error(`Refusing to overwrite ${target}. Move or review the existing source first.`);
|
|
39
|
+
} catch (error) {
|
|
40
|
+
if (error.code !== "ENOENT") throw error;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
for (const relative of files) {
|
|
44
|
+
const target = path.join(destination, relative);
|
|
45
|
+
await mkdir(path.dirname(target), { recursive: true });
|
|
46
|
+
await cp(path.join(source, relative), target, { errorOnExist: true, force: false });
|
|
47
|
+
}
|
|
48
|
+
console.log(
|
|
49
|
+
`Installed Clearwater source into ${destination}. Import createClearwater from ./clearwater.js.`,
|
|
50
|
+
);
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
import { type ICtx, RippleField, SpectralOcean, WaterSurface3D } from "@threenative/core";
|
|
2
|
+
import type { WebGPURenderer } from "three/webgpu";
|
|
3
|
+
import { DisposalScope } from "./clearwaterLifetime.js";
|
|
4
|
+
import { createClearwaterAppearance } from "./render/clearwater.js";
|
|
5
|
+
import {
|
|
6
|
+
type IClearwaterOptions,
|
|
7
|
+
type WaterRgb,
|
|
8
|
+
finiteWaterNumber,
|
|
9
|
+
resolveClearwaterOptions,
|
|
10
|
+
waterSunDirection,
|
|
11
|
+
} from "./render/clearwaterOptions.js";
|
|
12
|
+
|
|
13
|
+
export type { IClearwaterOptions } from "./render/clearwaterOptions.js";
|
|
14
|
+
export type Clearwater = ReturnType<typeof createClearwater>;
|
|
15
|
+
type WaterContext = Pick<ICtx, "renderer" | "scene" | "camera" | "add" | "every" | "beforeRender">;
|
|
16
|
+
|
|
17
|
+
function isWebGPURenderer(value: unknown): value is WebGPURenderer {
|
|
18
|
+
return (
|
|
19
|
+
typeof value === "object" &&
|
|
20
|
+
value !== null &&
|
|
21
|
+
"isWebGPURenderer" in value &&
|
|
22
|
+
value.isWebGPURenderer === true
|
|
23
|
+
);
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* One call, no render loop to install: the scene owns the clock, draw hook and removal lifecycle.
|
|
28
|
+
* The mesh is horizontal, in world coordinates, and must remain an untransformed scene-root child.
|
|
29
|
+
* Appearance lives in ./render/clearwater*.ts. Existing games can copy these generated source files.
|
|
30
|
+
*/
|
|
31
|
+
export function createClearwater(ctx: WaterContext, input: IClearwaterOptions = {}) {
|
|
32
|
+
const options = resolveClearwaterOptions(input);
|
|
33
|
+
const renderer = ctx.renderer.raw;
|
|
34
|
+
if (ctx.renderer.kind !== "webgpu" || !isWebGPURenderer(renderer)) {
|
|
35
|
+
throw new Error(
|
|
36
|
+
"Clearwater requires ThreeNative's WebGPU renderer (FFT storage/compute); WebGL2 is not a supported fallback.",
|
|
37
|
+
);
|
|
38
|
+
}
|
|
39
|
+
const scope = new DisposalScope();
|
|
40
|
+
try {
|
|
41
|
+
// Keep the simulation out of ctx.add(): this factory dispatches it once, immediately before
|
|
42
|
+
// its caustic pass. Registering it with the engine as well would dispatch the FFT twice.
|
|
43
|
+
const ocean = new SpectralOcean({
|
|
44
|
+
resolution: options.resolution,
|
|
45
|
+
cascades: [{ patchSize: 8 }, { patchSize: 2 }],
|
|
46
|
+
amplitude: options.waveAmplitude,
|
|
47
|
+
windSpeed: options.windSpeed,
|
|
48
|
+
windDirection: 0.55,
|
|
49
|
+
gravity: 9.81,
|
|
50
|
+
directionality: 1.5,
|
|
51
|
+
choppiness: 0,
|
|
52
|
+
smallWaveCutoff: 0.08,
|
|
53
|
+
seed: options.seed,
|
|
54
|
+
cadence: "render",
|
|
55
|
+
readbackResolution: 16,
|
|
56
|
+
readbackEveryFrames: 3,
|
|
57
|
+
});
|
|
58
|
+
scope.defer(() => ocean.detach());
|
|
59
|
+
const ripples = new RippleField({
|
|
60
|
+
resolution: options.rippleResolution,
|
|
61
|
+
size: options.rippleSize,
|
|
62
|
+
speed: 1.2,
|
|
63
|
+
damping: 0.9,
|
|
64
|
+
maxSteps: 8,
|
|
65
|
+
});
|
|
66
|
+
ripples.recenter(options.center[0], options.center[1]);
|
|
67
|
+
const surface = new WaterSurface3D({
|
|
68
|
+
level: options.level,
|
|
69
|
+
maxThickness: options.depth * 12,
|
|
70
|
+
reflection: options.reflection
|
|
71
|
+
? {
|
|
72
|
+
resolutionScale: options.reflectionScale,
|
|
73
|
+
refreshInterval: options.reflectionRefreshInterval,
|
|
74
|
+
layers: options.reflectionLayers,
|
|
75
|
+
}
|
|
76
|
+
: undefined,
|
|
77
|
+
});
|
|
78
|
+
scope.defer(() => surface.dispose());
|
|
79
|
+
const appearance = createClearwaterAppearance(ocean, ripples, surface, options);
|
|
80
|
+
scope.defer(() => appearance.dispose());
|
|
81
|
+
scope.defer(() => appearance.mesh.removeFromParent());
|
|
82
|
+
const onRemoved = () => scope.dispose();
|
|
83
|
+
appearance.mesh.addEventListener("removed", onRemoved);
|
|
84
|
+
scope.defer(() => appearance.mesh.removeEventListener("removed", onRemoved));
|
|
85
|
+
let seconds = 0;
|
|
86
|
+
const tick = ctx.every((dt) => {
|
|
87
|
+
if (scope.disposed) return;
|
|
88
|
+
seconds += dt;
|
|
89
|
+
ocean.advance(seconds);
|
|
90
|
+
ripples.advance(dt);
|
|
91
|
+
});
|
|
92
|
+
scope.defer(() => tick.cancel());
|
|
93
|
+
const unhook = ctx.beforeRender(() => {
|
|
94
|
+
if (scope.disposed) return;
|
|
95
|
+
ocean.process(ctx.renderer);
|
|
96
|
+
appearance.uploadRipples();
|
|
97
|
+
appearance.caustics?.render(renderer);
|
|
98
|
+
});
|
|
99
|
+
scope.defer(unhook);
|
|
100
|
+
ctx.add(appearance.mesh);
|
|
101
|
+
|
|
102
|
+
const assertLive = () => {
|
|
103
|
+
if (scope.disposed) throw new Error("Clearwater has been disposed.");
|
|
104
|
+
};
|
|
105
|
+
return {
|
|
106
|
+
mesh: appearance.mesh,
|
|
107
|
+
material: appearance.material,
|
|
108
|
+
causticsTexture: appearance.caustics?.texture,
|
|
109
|
+
ocean,
|
|
110
|
+
ripples,
|
|
111
|
+
get disposed(): boolean {
|
|
112
|
+
return scope.disposed;
|
|
113
|
+
},
|
|
114
|
+
/** World-space disturbance. Returns false outside either the surface or the current patch. */
|
|
115
|
+
disturb(x: number, z: number, radius = 0.2, strength = -0.04): boolean {
|
|
116
|
+
assertLive();
|
|
117
|
+
finiteWaterNumber("disturb.x", x);
|
|
118
|
+
finiteWaterNumber("disturb.z", z);
|
|
119
|
+
finiteWaterNumber("disturb.radius", radius);
|
|
120
|
+
finiteWaterNumber("disturb.strength", strength);
|
|
121
|
+
if (radius <= 0 || Math.abs(strength) > 10)
|
|
122
|
+
throw new RangeError("Clearwater disturbance needs radius > 0 and |strength| <= 10.");
|
|
123
|
+
if (
|
|
124
|
+
Math.abs(x - options.center[0]) > options.size / 2 ||
|
|
125
|
+
Math.abs(z - options.center[1]) > options.size / 2
|
|
126
|
+
)
|
|
127
|
+
return false;
|
|
128
|
+
return ripples.impulse(x, z, radius, strength);
|
|
129
|
+
},
|
|
130
|
+
/** Keep the finite interaction grid near a character without tiling or wrapping old ripples. */
|
|
131
|
+
follow(x: number, z: number): void {
|
|
132
|
+
assertLive();
|
|
133
|
+
ripples.recenter(x, z);
|
|
134
|
+
},
|
|
135
|
+
setLevel(value: number): void {
|
|
136
|
+
assertLive();
|
|
137
|
+
finiteWaterNumber("level", value);
|
|
138
|
+
surface.setLevel(value);
|
|
139
|
+
appearance.level.value = value;
|
|
140
|
+
},
|
|
141
|
+
setSunDirection(value: WaterRgb): void {
|
|
142
|
+
assertLive();
|
|
143
|
+
appearance.sunDirection.value.set(...waterSunDirection(value));
|
|
144
|
+
},
|
|
145
|
+
/** Undefined until GPU readback arrives. staleFrames covers the FFT, not the current CPU ripple. */
|
|
146
|
+
sampleHeight(x: number, z: number) {
|
|
147
|
+
assertLive();
|
|
148
|
+
finiteWaterNumber("sampleHeight.x", x);
|
|
149
|
+
finiteWaterNumber("sampleHeight.z", z);
|
|
150
|
+
if (
|
|
151
|
+
Math.abs(x - options.center[0]) > options.size / 2 ||
|
|
152
|
+
Math.abs(z - options.center[1]) > options.size / 2
|
|
153
|
+
)
|
|
154
|
+
return undefined;
|
|
155
|
+
const sample = ocean.sampleHeight(x, z);
|
|
156
|
+
if (sample === undefined) return undefined;
|
|
157
|
+
// Match rippleAt()'s two-texel smoothstep in render/clearwater.ts, including after follow().
|
|
158
|
+
const edge =
|
|
159
|
+
0.5 -
|
|
160
|
+
Math.max(Math.abs(x - ripples.centerX), Math.abs(z - ripples.centerZ)) / ripples.size;
|
|
161
|
+
const t = Math.max(0, Math.min(1, (edge * ripples.resolution) / 2));
|
|
162
|
+
const rippleHeight = ripples.heightAt(x, z) * t * t * (3 - 2 * t);
|
|
163
|
+
return {
|
|
164
|
+
height: appearance.level.value + sample.height + rippleHeight,
|
|
165
|
+
staleFrames: sample.staleFrames,
|
|
166
|
+
};
|
|
167
|
+
},
|
|
168
|
+
dispose(): void {
|
|
169
|
+
scope.dispose();
|
|
170
|
+
},
|
|
171
|
+
};
|
|
172
|
+
} catch (error) {
|
|
173
|
+
try {
|
|
174
|
+
scope.dispose();
|
|
175
|
+
} catch {
|
|
176
|
+
/* Preserve the initialization failure, after releasing everything possible. */
|
|
177
|
+
}
|
|
178
|
+
throw error;
|
|
179
|
+
}
|
|
180
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { type ICtx, Scene } from "@threenative/core";
|
|
2
|
+
import { type Clearwater, createClearwater } from "./clearwater.js";
|
|
3
|
+
import { setupClearwaterDemo } from "./render/clearwaterDemo.js";
|
|
4
|
+
|
|
5
|
+
/** Optional, DOM-free fixture. Select it explicitly; installing water never replaces a game's scene. */
|
|
6
|
+
export class ClearwaterDemo extends Scene {
|
|
7
|
+
#water: Clearwater | undefined;
|
|
8
|
+
#release: (() => void) | undefined;
|
|
9
|
+
#elapsed = 0;
|
|
10
|
+
override enter(ctx: ICtx): void {
|
|
11
|
+
this.#elapsed = 0;
|
|
12
|
+
this.#release = setupClearwaterDemo(ctx.scene, ctx.camera);
|
|
13
|
+
this.#water = createClearwater(ctx, { size: 16, depth: 2 });
|
|
14
|
+
}
|
|
15
|
+
override update(_ctx: ICtx, dt: number): void {
|
|
16
|
+
this.#elapsed += dt;
|
|
17
|
+
if (this.#elapsed >= 2) {
|
|
18
|
+
this.#elapsed %= 2;
|
|
19
|
+
this.#water?.disturb(0, 0, 0.25, -0.04);
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
override exit(): void {
|
|
23
|
+
this.#water?.dispose();
|
|
24
|
+
this.#release?.();
|
|
25
|
+
this.#water = undefined;
|
|
26
|
+
this.#release = undefined;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/** Small scene-owned disposal stack. It owns no renderer, scene, or appearance. */
|
|
2
|
+
export class DisposalScope {
|
|
3
|
+
#disposed = false;
|
|
4
|
+
#cleanups: (() => void)[] = [];
|
|
5
|
+
|
|
6
|
+
get disposed(): boolean {
|
|
7
|
+
return this.#disposed;
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
defer(cleanup: () => void): void {
|
|
11
|
+
if (this.#disposed) cleanup();
|
|
12
|
+
else this.#cleanups.push(cleanup);
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
dispose(): void {
|
|
16
|
+
if (this.#disposed) return;
|
|
17
|
+
this.#disposed = true;
|
|
18
|
+
const errors: unknown[] = [];
|
|
19
|
+
for (const cleanup of this.#cleanups.splice(0).reverse()) {
|
|
20
|
+
try {
|
|
21
|
+
cleanup();
|
|
22
|
+
} catch (error) {
|
|
23
|
+
errors.push(error);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
if (errors.length > 0) throw new AggregateError(errors, "Clearwater resource cleanup failed.");
|
|
27
|
+
}
|
|
28
|
+
}
|
|
@@ -1,6 +1,9 @@
|
|
|
1
|
+
Clearwater — https://github.com/Aureliengmz/clearwater
|
|
2
|
+
Optical equations and refracted-grid caustics adapted for Three.js TSL.
|
|
3
|
+
|
|
1
4
|
MIT License
|
|
2
5
|
|
|
3
|
-
Copyright (c) 2026
|
|
6
|
+
Copyright (c) 2026 Lumaris
|
|
4
7
|
|
|
5
8
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
9
|
of this software and associated documentation files (the "Software"), to deal
|