@jgengine/shell 0.19.0 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (215) hide show
  1. package/CHANGELOG.md +364 -0
  2. package/dist/GameHost.d.ts +12 -1
  3. package/dist/GameHost.js +14 -1
  4. package/dist/GamePlayerShell.js +113 -15
  5. package/dist/Shell3dPresentation.d.ts +2 -2
  6. package/dist/Shell3dPresentation.js +49 -7
  7. package/dist/ShellChrome.d.ts +2 -1
  8. package/dist/ShellChrome.js +22 -6
  9. package/dist/ShellHudPresentation.d.ts +11 -1
  10. package/dist/ShellHudPresentation.js +20 -6
  11. package/dist/audio/audioEngine.d.ts +16 -0
  12. package/dist/audio/audioEngine.js +178 -89
  13. package/dist/audio/audioWire.js +2 -2
  14. package/dist/audio/synthEngine.d.ts +7 -1
  15. package/dist/audio/synthEngine.js +103 -38
  16. package/dist/camera/GameCameraRig.js +2 -1
  17. package/dist/camera/GameFirstPersonCamera.d.ts +2 -2
  18. package/dist/camera/GameFirstPersonCamera.js +17 -13
  19. package/dist/camera/cameraRigs.js +8 -2
  20. package/dist/camera/chaseHeading.d.ts +9 -0
  21. package/dist/camera/chaseHeading.js +10 -0
  22. package/dist/camera/customMuzzle.d.ts +14 -0
  23. package/dist/camera/customMuzzle.js +68 -0
  24. package/dist/camera/index.d.ts +1 -0
  25. package/dist/camera/index.js +1 -0
  26. package/dist/camera/rigResolve.d.ts +3 -0
  27. package/dist/camera/rigResolve.js +11 -0
  28. package/dist/combat/ProjectileModels.d.ts +31 -0
  29. package/dist/combat/ProjectileModels.js +70 -0
  30. package/dist/commandSink.d.ts +1 -2
  31. package/dist/commandSink.js +3 -2
  32. package/dist/defineGame.d.ts +12 -5
  33. package/dist/defineGame.js +25 -10
  34. package/dist/devtools/DevtoolsOverlay.d.ts +2 -69
  35. package/dist/devtools/DevtoolsOverlay.js +14 -168
  36. package/dist/devtools/DevtoolsRuntime.d.ts +7 -0
  37. package/dist/devtools/DevtoolsRuntime.js +61 -0
  38. package/dist/devtools/agentBridge.js +1 -1
  39. package/dist/devtools/devtoolsReports.d.ts +68 -0
  40. package/dist/devtools/devtoolsReports.js +100 -0
  41. package/dist/devtools/latencyInstrumentation.d.ts +3 -0
  42. package/dist/devtools/latencyInstrumentation.js +11 -0
  43. package/dist/devtools/playtestProbe.d.ts +4 -0
  44. package/dist/devtools/playtestProbe.js +22 -0
  45. package/dist/drivers/FrameDriver.js +25 -21
  46. package/dist/drivers/HudOnlyDriver.d.ts +6 -1
  47. package/dist/drivers/HudOnlyDriver.js +32 -14
  48. package/dist/environment/EnvironmentScene.js +19 -15
  49. package/dist/environment/terrainGroundColor.d.ts +5 -4
  50. package/dist/environment/terrainGroundColor.js +19 -8
  51. package/dist/inputSink.d.ts +6 -6
  52. package/dist/inputSink.js +60 -21
  53. package/dist/lazyShell3dPresentation.d.ts +9 -0
  54. package/dist/lazyShell3dPresentation.js +24 -0
  55. package/dist/materialOverride.d.ts +42 -0
  56. package/dist/materialOverride.js +95 -36
  57. package/dist/multiplayer.d.ts +33 -3
  58. package/dist/multiplayer.js +105 -22
  59. package/dist/pointer/pointerService.d.ts +2 -0
  60. package/dist/pointer/pointerService.js +12 -2
  61. package/dist/postfx/PostProcessing.d.ts +10 -0
  62. package/dist/postfx/PostProcessing.js +9 -41
  63. package/dist/postfx/gradeShader.d.ts +1 -1
  64. package/dist/postfx/gradeShader.js +30 -2
  65. package/dist/postfx/shadowPrepass.d.ts +3 -0
  66. package/dist/postfx/shadowPrepass.js +18 -0
  67. package/dist/presentationRecovery.d.ts +75 -0
  68. package/dist/presentationRecovery.js +204 -0
  69. package/dist/presentationRecovery3d.d.ts +4 -0
  70. package/dist/presentationRecovery3d.js +32 -0
  71. package/dist/presentationResolve.d.ts +8 -1
  72. package/dist/presentationResolve.js +5 -2
  73. package/dist/render/CascadedShadows.d.ts +7 -2
  74. package/dist/render/CascadedShadows.js +98 -20
  75. package/dist/render/EnvironmentLighting.js +74 -35
  76. package/dist/render/HairCards.d.ts +7 -0
  77. package/dist/render/HairCards.js +23 -0
  78. package/dist/render/SceneModels.js +51 -77
  79. package/dist/render/authoredSurfaceMaterial.d.ts +43 -0
  80. package/dist/render/authoredSurfaceMaterial.js +108 -0
  81. package/dist/render/materialAppearanceSignals.d.ts +23 -0
  82. package/dist/render/materialAppearanceSignals.js +58 -0
  83. package/dist/render/materialAsset.d.ts +98 -0
  84. package/dist/render/materialAsset.js +454 -0
  85. package/dist/render/measureBounds.js +16 -3
  86. package/dist/render/measureCollisionMesh.js +8 -1
  87. package/dist/render/modelAssets.d.ts +8 -0
  88. package/dist/render/modelAssets.js +43 -0
  89. package/dist/render/modelBindPose.d.ts +5 -0
  90. package/dist/render/modelBindPose.js +35 -0
  91. package/dist/render/modelLoad.d.ts +3 -0
  92. package/dist/render/modelLoad.js +9 -0
  93. package/dist/render/modelNodeVisibility.d.ts +6 -0
  94. package/dist/render/modelNodeVisibility.js +18 -0
  95. package/dist/render/modelRender.d.ts +18 -1
  96. package/dist/render/modelRender.js +81 -3
  97. package/dist/render/projectedOverdraw.d.ts +35 -0
  98. package/dist/render/projectedOverdraw.js +204 -0
  99. package/dist/render/resolveModel.d.ts +12 -2
  100. package/dist/render/resolveModel.js +21 -4
  101. package/dist/render/rigNode.d.ts +26 -0
  102. package/dist/render/rigNode.js +32 -0
  103. package/dist/render/spriteRender.d.ts +4 -0
  104. package/dist/render/spriteRender.js +5 -0
  105. package/dist/render/staticShapeInstances.d.ts +34 -0
  106. package/dist/render/staticShapeInstances.js +78 -0
  107. package/dist/render/useFootIk.js +76 -11
  108. package/dist/render/useModelAnimation.d.ts +28 -2
  109. package/dist/render/useModelAnimation.js +194 -69
  110. package/dist/render/useModelInstance.d.ts +25 -0
  111. package/dist/render/useModelInstance.js +43 -0
  112. package/dist/scatter/scatterModels.d.ts +3 -2
  113. package/dist/scatter/scatterModels.js +15 -7
  114. package/dist/scene/AuthoredScene.d.ts +14 -6
  115. package/dist/scene/AuthoredScene.js +30 -9
  116. package/dist/scene/GeneratedAssetRenderer.js +11 -42
  117. package/dist/scene/GrassFieldRenderer.js +20 -2
  118. package/dist/settings/SettingsMenu.js +11 -18
  119. package/dist/settings/SettingsRuntime.d.ts +5 -0
  120. package/dist/settings/SettingsRuntime.js +29 -2
  121. package/dist/shellControlSuspension.d.ts +18 -0
  122. package/dist/shellControlSuspension.js +28 -0
  123. package/dist/shellInputPublication.d.ts +28 -0
  124. package/dist/shellInputPublication.js +49 -0
  125. package/dist/shellPointerInput.d.ts +18 -0
  126. package/dist/shellPointerInput.js +49 -0
  127. package/dist/structures/BuildingKitBatch.d.ts +3 -1
  128. package/dist/structures/BuildingKitBatch.js +34 -59
  129. package/dist/structures/BuildingRenderBudget.d.ts +23 -0
  130. package/dist/structures/BuildingRenderBudget.js +54 -0
  131. package/dist/structures/GeneratedBuilding.js +13 -8
  132. package/dist/structures/buildingKitMaterials.d.ts +20 -0
  133. package/dist/structures/buildingKitMaterials.js +70 -0
  134. package/dist/structures/buildingSpatialBatch.d.ts +11 -0
  135. package/dist/structures/buildingSpatialBatch.js +45 -0
  136. package/dist/terrain/CarvedTerrain.d.ts +2 -1
  137. package/dist/terrain/CarvedTerrain.js +2 -2
  138. package/dist/terrain/GrassField.d.ts +3 -1
  139. package/dist/terrain/GrassField.js +61 -6
  140. package/dist/terrain/grassGeometry.d.ts +13 -0
  141. package/dist/terrain/grassGeometry.js +57 -1
  142. package/dist/terrain/grassMaterial.js +2 -2
  143. package/dist/terrain/index.d.ts +1 -0
  144. package/dist/terrain/index.js +1 -0
  145. package/dist/terrain/terrainDetailMaterial.d.ts +3 -3
  146. package/dist/terrain/terrainDetailMaterial.js +7 -7
  147. package/dist/terrain/terrainMath.d.ts +2 -0
  148. package/dist/terrain/terrainMath.js +2 -0
  149. package/dist/terrain/terrainPaintColor.d.ts +11 -0
  150. package/dist/terrain/terrainPaintColor.js +47 -0
  151. package/dist/touch/TouchControlsOverlay.js +4 -4
  152. package/dist/useShellMultiplayerSync.js +4 -0
  153. package/dist/vfx/ParticleField.d.ts +23 -20
  154. package/dist/vfx/ParticleField.js +168 -50
  155. package/dist/visibility/CullingProvider.js +2 -62
  156. package/dist/visibility/cullingDriver.d.ts +9 -0
  157. package/dist/visibility/cullingDriver.js +68 -0
  158. package/dist/weather/AuthoredWeatherLayer.d.ts +16 -0
  159. package/dist/weather/AuthoredWeatherLayer.js +31 -0
  160. package/dist/weather/DustField.d.ts +2 -1
  161. package/dist/weather/DustField.js +17 -3
  162. package/dist/weather/FireSpreadLayer.d.ts +4 -2
  163. package/dist/weather/FireSpreadLayer.js +5 -11
  164. package/dist/weather/LightningStrike.d.ts +4 -1
  165. package/dist/weather/LightningStrike.js +13 -17
  166. package/dist/weather/RainField.d.ts +2 -1
  167. package/dist/weather/RainField.js +17 -3
  168. package/dist/weather/RainImpactField.d.ts +16 -0
  169. package/dist/weather/RainImpactField.js +89 -0
  170. package/dist/weather/SnowField.d.ts +2 -1
  171. package/dist/weather/SnowField.js +17 -3
  172. package/dist/weather/WeatherLayer.d.ts +11 -2
  173. package/dist/weather/WeatherLayer.js +30 -6
  174. package/dist/weather/index.d.ts +2 -0
  175. package/dist/weather/index.js +2 -0
  176. package/dist/weather/weatherMath.d.ts +2 -0
  177. package/dist/weather/weatherMath.js +8 -0
  178. package/dist/weather/weatherShelter.d.ts +18 -0
  179. package/dist/weather/weatherShelter.js +75 -0
  180. package/dist/weather/weatherUniforms.d.ts +40 -1
  181. package/dist/weather/weatherUniforms.js +29 -9
  182. package/dist/world/AuthoredFlocks.d.ts +22 -0
  183. package/dist/world/AuthoredFlocks.js +87 -0
  184. package/dist/world/StaticObjectModels.d.ts +8 -0
  185. package/dist/world/StaticObjectModels.js +75 -0
  186. package/dist/world/WorldHud.d.ts +14 -6
  187. package/dist/world/WorldHud.js +25 -12
  188. package/dist/world/WorldParticles.d.ts +10 -23
  189. package/dist/world/WorldParticles.js +209 -61
  190. package/dist/world/WorldScene.d.ts +3 -1
  191. package/dist/world/WorldScene.js +41 -26
  192. package/dist/world/staticObjectBatches.d.ts +35 -0
  193. package/dist/world/staticObjectBatches.js +163 -0
  194. package/dist/world/worldBarSamples.d.ts +37 -33
  195. package/dist/world/worldBarSamples.js +117 -75
  196. package/package.json +4 -4
  197. package/skills/ce-handoff/SKILL.md +1 -1
  198. package/skills/game-design/SKILL.md +2 -0
  199. package/skills/jgengine/SKILL.md +23 -2
  200. package/skills/jgengine/api.md +28 -17
  201. package/skills/jgengine/recipes/minimal-game.md +7 -2
  202. package/skills/jgengine-ui/SKILL.md +3 -1
  203. package/skills/jgengine-ui/api.md +219 -70
  204. package/skills/jgengine-ui/capabilities.md +119 -1
  205. package/skills/jgengine-ui/reference-primitives.md +93 -3
  206. package/skills/jgengine-ui/reference.md +2 -0
  207. package/skills/jgengine-world/SKILL.md +12 -3
  208. package/skills/jgengine-world/api.md +201 -58
  209. package/skills/jgengine-world/capabilities.md +116 -3
  210. package/skills/jgengine-world/recipes/character-animation.md +31 -8
  211. package/skills/jgengine-world/recipes/controls.md +4 -0
  212. package/skills/jgengine-world/recipes/npc-senses.md +12 -0
  213. package/skills/jgengine-world/recipes/vehicle-feel.md +3 -1
  214. package/skills/jgengine-world/reference.md +167 -5
  215. package/skills/jgengine-world/visibility.md +28 -1
@@ -1,50 +1,106 @@
1
1
  import * as THREE from "three";
2
+ /** Physical texture roles mapped to the pinned Three renderer's native properties. @internal */
3
+ export const MATERIAL_TEXTURE_PROPERTIES = {
4
+ color: "map", normal: "normalMap", roughness: "roughnessMap", ao: "aoMap", metalness: "metalnessMap", emissive: "emissiveMap", height: "displacementMap", alpha: "alphaMap",
5
+ sheenColor: "sheenColorMap", sheenRoughness: "sheenRoughnessMap", anisotropy: "anisotropyMap", clearcoat: "clearcoatMap", clearcoatRoughness: "clearcoatRoughnessMap", clearcoatNormal: "clearcoatNormalMap", specularIntensity: "specularIntensityMap", specularColor: "specularColorMap", transmission: "transmissionMap", thickness: "thicknessMap", iridescence: "iridescenceMap", iridescenceThickness: "iridescenceThicknessMap",
6
+ };
7
+ const physicalNumbers = ["sheen", "sheenRoughness", "anisotropy", "anisotropyRotation", "clearcoat", "clearcoatRoughness", "ior", "specularIntensity", "transmission", "thickness", "attenuationDistance", "iridescence", "iridescenceIOR"];
8
+ const physicalColors = ["sheenColor", "specularColor", "attenuationColor"];
9
+ /** Whether authored settings require a physical shader; ordinary PBR stays standard. @internal */
10
+ export function requiresPhysicalMaterial(override, textures) {
11
+ return [...physicalNumbers, ...physicalColors, "iridescenceThicknessRange"].some(key => override[key] !== undefined) || Object.keys(textures ?? {}).some(key => ["sheenColor", "sheenRoughness", "anisotropy", "clearcoat", "clearcoatRoughness", "clearcoatNormal", "specularIntensity", "specularColor", "transmission", "thickness", "iridescence", "iridescenceThickness"].includes(key));
12
+ }
2
13
  /** @internal */
3
14
  export function applyMaterialOverride(root, override, options) {
4
15
  const clone = options?.clone !== false;
5
16
  const textures = options?.textures;
17
+ const applied = new Map();
18
+ const apply = (material) => {
19
+ const cached = applied.get(material);
20
+ if (cached !== undefined)
21
+ return cached;
22
+ const target = applyMaterialOverrideToMaterial(material, override, clone, textures);
23
+ applied.set(material, target);
24
+ if (target !== material)
25
+ options?.ownMaterial?.(target);
26
+ return target;
27
+ };
6
28
  root.traverse((node) => {
7
29
  const mesh = node;
8
30
  if (!mesh.isMesh)
9
31
  return;
10
- mesh.material = Array.isArray(mesh.material)
11
- ? mesh.material.map((material) => overrideOne(material, override, clone, textures))
12
- : overrideOne(mesh.material, override, clone, textures);
32
+ mesh.material = Array.isArray(mesh.material) ? mesh.material.map(apply) : apply(mesh.material);
13
33
  });
14
34
  }
15
- function overrideOne(material, override, clone, textures) {
35
+ /** Apply the shared override contract to one material. @internal */
36
+ export function applyMaterialOverrideToMaterial(material, override, clone, textures) {
16
37
  if (!isStandardOrPhysicalMaterial(material))
17
38
  return material;
18
- const target = clone ? material.clone() : material;
19
- if (override.color !== undefined)
20
- target.color.set(override.color);
21
- if (override.metalness !== undefined)
22
- target.metalness = override.metalness;
23
- if (override.roughness !== undefined)
24
- target.roughness = override.roughness;
25
- if (override.emissive !== undefined)
26
- target.emissive.set(override.emissive);
27
- if (override.emissiveIntensity !== undefined)
28
- target.emissiveIntensity = override.emissiveIntensity;
29
- if (textures?.color !== undefined)
30
- target.map = textures.color;
31
- if (textures?.normal !== undefined)
32
- target.normalMap = textures.normal;
33
- if (textures?.roughness !== undefined)
34
- target.roughnessMap = textures.roughness;
35
- if (textures?.ao !== undefined)
36
- target.aoMap = textures.ao;
37
- if (textures?.metalness !== undefined)
38
- target.metalnessMap = textures.metalness;
39
- if (textures?.emissive !== undefined)
40
- target.emissiveMap = textures.emissive;
41
- if (textures?.height !== undefined)
42
- target.displacementMap = textures.height;
43
- if (textures !== undefined)
44
- target.needsUpdate = true;
45
- if (override.rim !== undefined)
46
- applyRimLight(target, override.rim);
47
- return target;
39
+ const promote = requiresPhysicalMaterial(override, textures) && !material.isMeshPhysicalMaterial;
40
+ const target = promote ? new THREE.MeshPhysicalMaterial() : clone ? material.clone() : material;
41
+ try {
42
+ if (promote)
43
+ THREE.MeshStandardMaterial.prototype.copy.call(target, material);
44
+ if (clone || promote) {
45
+ target.onBeforeCompile = material.onBeforeCompile;
46
+ target.customProgramCacheKey = material.customProgramCacheKey;
47
+ }
48
+ if (override.color !== undefined)
49
+ target.color.set(override.color);
50
+ if (override.metalness !== undefined)
51
+ target.metalness = override.metalness;
52
+ if (override.roughness !== undefined)
53
+ target.roughness = override.roughness;
54
+ if (override.emissive !== undefined)
55
+ target.emissive.set(override.emissive);
56
+ if (override.emissiveIntensity !== undefined)
57
+ target.emissiveIntensity = override.emissiveIntensity;
58
+ if (override.normalScale !== undefined)
59
+ target.normalScale.set(...override.normalScale);
60
+ const physical = target;
61
+ for (const key of physicalNumbers)
62
+ if (override[key] !== undefined)
63
+ physical[key] = override[key];
64
+ for (const key of physicalColors)
65
+ if (override[key] !== undefined)
66
+ physical[key].set(override[key]);
67
+ if (override.iridescenceThicknessRange !== undefined)
68
+ physical.iridescenceThicknessRange = [...override.iridescenceThicknessRange];
69
+ if (override.alphaMode !== undefined) {
70
+ target.transparent = override.alphaMode === "blend";
71
+ target.alphaTest = override.alphaMode === "mask" ? override.alphaCutoff ?? 0.5 : 0;
72
+ target.depthWrite = override.alphaMode !== "blend";
73
+ }
74
+ else if (override.alphaCutoff !== undefined)
75
+ target.alphaTest = override.alphaCutoff;
76
+ if (override.opacity !== undefined)
77
+ target.opacity = override.opacity;
78
+ if (override.doubleSided !== undefined)
79
+ target.side = override.doubleSided ? THREE.DoubleSide : THREE.FrontSide;
80
+ for (const [role, texture] of Object.entries(textures ?? {})) {
81
+ const property = MATERIAL_TEXTURE_PROPERTIES[role];
82
+ if (property !== undefined)
83
+ target[property] = texture;
84
+ }
85
+ if (textures !== undefined)
86
+ target.needsUpdate = true;
87
+ if (override.rim !== undefined)
88
+ applyRimLight(target, override.rim);
89
+ if (override.alphaMode !== undefined || override.doubleSided !== undefined)
90
+ target.needsUpdate = true;
91
+ return target;
92
+ }
93
+ catch (error) {
94
+ if (target !== material) {
95
+ try {
96
+ target.dispose();
97
+ }
98
+ finally {
99
+ throw error;
100
+ }
101
+ }
102
+ throw error;
103
+ }
48
104
  }
49
105
  function isStandardOrPhysicalMaterial(material) {
50
106
  return material.isMeshStandardMaterial === true;
@@ -60,7 +116,10 @@ function applyRimLight(target, rim) {
60
116
  const power = rim.power ?? 2.5;
61
117
  if (strength <= 0)
62
118
  return;
63
- target.onBeforeCompile = (shader) => {
119
+ const previousCompile = target.onBeforeCompile;
120
+ const previousKey = target.customProgramCacheKey();
121
+ target.onBeforeCompile = (shader, renderer) => {
122
+ previousCompile.call(target, shader, renderer);
64
123
  shader.uniforms.uJgRimColor = { value: color };
65
124
  shader.uniforms.uJgRimStrength = { value: strength };
66
125
  shader.uniforms.uJgRimPower = { value: power };
@@ -74,6 +133,6 @@ outgoingLight += uJgRimColor * jgRim * uJgRimStrength;
74
133
  #include <opaque_fragment>`);
75
134
  };
76
135
  // Two materials differing only in rim tuning must not share a compiled program.
77
- target.customProgramCacheKey = () => `jgengine-rim-${rim.color ?? "#ffffff"}-${strength}-${power}`;
136
+ target.customProgramCacheKey = () => `${previousKey}|jgengine-rim-${rim.color ?? "#ffffff"}-${strength}-${power}`;
78
137
  target.needsUpdate = true;
79
138
  }
@@ -1,5 +1,8 @@
1
1
  import type { GameDefinition } from "@jgengine/core/game/defineGame";
2
2
  import type { MultiplayerSession } from "@jgengine/core/runtime/transport";
3
+ import { type HostedWorldStore } from "@jgengine/core/runtime/hostedWorldSession";
4
+ import type { PlayableGame } from "./registry.js";
5
+ import { type PeerHost, type PeerHostOptions, type PeerGuest, type PeerGuestOptions, type PeerSignaling } from "@jgengine/ws/peer";
3
6
  export type ShellMultiplayer = MultiplayerSession;
4
7
  export declare const DEFAULT_FEED_ACTIONS: string[];
5
8
  export declare function randomPlayerId(): string;
@@ -12,12 +15,39 @@ export type ResolveShellMultiplayerArgs = {
12
15
  feedActions?: string[];
13
16
  };
14
17
  export declare function resolveShellMultiplayer(args: ResolveShellMultiplayerArgs): ShellMultiplayer | null;
15
- export declare function resolvePeerShellMultiplayer(args: {
18
+ /** Alternate peer factories for hosts that provide their own WebRTC implementation or transport pipe. */
19
+ export interface PeerShellFactories {
20
+ host(options: PeerHostOptions): PeerHost;
21
+ guest(options: PeerGuestOptions): PeerGuest;
22
+ }
23
+ /** Peer bootstrap options; passing a playable hosts its authoritative GameContext world. */
24
+ export interface ResolvePeerShellMultiplayerArgs {
16
25
  gameId: string;
17
26
  role: "host" | "join";
18
27
  room?: string;
19
28
  userId?: string;
20
29
  feedActions?: string[];
21
- }): Promise<ShellMultiplayer & {
22
- close: () => void;
30
+ /** Requires an adapter with `authority: "server"`; joiners mount the same playable. */
31
+ playable?: PlayableGame;
32
+ /** Maximum active players in the authoritative world, including the host player. */
33
+ slotsPerServer?: number;
34
+ /** Authoritative tick interval in milliseconds; defaults to 1000 / 30. */
35
+ tickMs?: number;
36
+ /** Minimum automatic save interval; joins, commands and close still save immediately. Defaults to 1000 ms. */
37
+ saveIntervalMs?: number;
38
+ /** Persistence for the authoritative host world; defaults to an in-memory store. */
39
+ store?: HostedWorldStore;
40
+ /** Signaling ownership transfers to the returned session, which closes it on teardown. */
41
+ signaling?: PeerSignaling;
42
+ peers?: PeerShellFactories;
43
+ /** Inject host scheduling; the returned cancellation is called before transport teardown. */
44
+ scheduleTicks?: (tick: () => void, intervalMs: number) => () => void;
45
+ }
46
+ /**
47
+ * Opens a peer session. With `playable`, one host runs the game loop and guests mirror its shared world.
48
+ * Await `close()` to finish authoritative persistence. Same-origin rooms use BroadcastChannel signaling.
49
+ * @capability multiplayer-p2p bootstrap a playable authoritative world for browser peer co-op
50
+ */
51
+ export declare function resolvePeerShellMultiplayer(args: ResolvePeerShellMultiplayerArgs): Promise<ShellMultiplayer & {
52
+ close: () => Promise<void>;
23
53
  }>;
@@ -1,4 +1,6 @@
1
1
  import { adapterOf, isServerAuthoritative } from "@jgengine/core/runtime/adapter";
2
+ import { createHostedWorldSession, createHostedWorldSessionAsync } from "@jgengine/core/runtime/hostedWorldSession";
3
+ import { createWorldGameHost } from "@jgengine/ws/worldHost";
2
4
  import { createWsBackend } from "@jgengine/ws/createWsBackend";
3
5
  import { announcePeerHost, broadcastChannelSignaling, createPeerGuest, createPeerHost, joinPeerSession, } from "@jgengine/ws/peer";
4
6
  export const DEFAULT_FEED_ACTIONS = ["entity.died"];
@@ -47,35 +49,116 @@ export function resolveShellMultiplayer(args) {
47
49
  `so the game shipped single-player. Wire up the ${adapter.kind} transport or switch to ws()/lan().`);
48
50
  return null;
49
51
  }
52
+ /**
53
+ * Opens a peer session. With `playable`, one host runs the game loop and guests mirror its shared world.
54
+ * Await `close()` to finish authoritative persistence. Same-origin rooms use BroadcastChannel signaling.
55
+ * @capability multiplayer-p2p bootstrap a playable authoritative world for browser peer co-op
56
+ */
50
57
  export async function resolvePeerShellMultiplayer(args) {
58
+ if (args.playable !== undefined && !isServerAuthoritative(args.playable.game.multiplayer)) {
59
+ throw new Error("playable peer worlds require authority: server");
60
+ }
61
+ const tickMs = args.tickMs ?? 1000 / 30;
62
+ if (!Number.isFinite(tickMs) || tickMs <= 0 || tickMs > 1000)
63
+ throw new Error("tickMs must be greater than zero and at most 1000");
64
+ const saveIntervalMs = args.saveIntervalMs ?? 1000;
65
+ if (!Number.isFinite(saveIntervalMs) || saveIntervalMs < 0)
66
+ throw new Error("saveIntervalMs must be nonnegative and finite");
51
67
  const userId = args.userId ?? randomPlayerId();
52
68
  const feedActions = args.feedActions ?? DEFAULT_FEED_ACTIONS;
53
- const signaling = broadcastChannelSignaling(args.room ?? `jg-p2p-${args.gameId}`);
69
+ const signaling = args.signaling ?? broadcastChannelSignaling(args.room ?? `jg-p2p-${args.gameId}`);
70
+ const peers = args.peers ?? { host: createPeerHost, guest: createPeerGuest };
54
71
  if (args.role === "host") {
55
- const peerHost = createPeerHost({ userId });
56
- const stopAnnouncing = announcePeerHost(peerHost, signaling);
72
+ let closed = false;
73
+ let activeSession = null;
74
+ let host;
75
+ let cancelTicks = () => { };
76
+ let stopAnnouncing = () => { };
77
+ let peerHost;
78
+ let closing = null;
79
+ try {
80
+ if (args.playable !== undefined) {
81
+ const playable = args.playable;
82
+ let loading = null;
83
+ host = createWorldGameHost({
84
+ slotsPerServer: args.slotsPerServer,
85
+ session({ gameId, serverId }) {
86
+ if (closed || gameId !== args.gameId || serverId !== args.gameId)
87
+ return null;
88
+ if (loading === null) {
89
+ const attempt = args.store === undefined
90
+ ? Promise.resolve(createHostedWorldSession({ definition: playable.game, content: playable.content, host: { userId, isNew: true }, saveIntervalMs }))
91
+ : createHostedWorldSessionAsync({ definition: playable.game, content: playable.content, host: { userId, isNew: true }, store: args.store, saveIntervalMs });
92
+ loading = attempt;
93
+ void attempt.catch(() => { if (loading === attempt)
94
+ loading = null; });
95
+ }
96
+ return loading.then(session => { activeSession = session; return session; });
97
+ },
98
+ });
99
+ }
100
+ peerHost = peers.host({ userId, ...(host === undefined ? {} : { host }) });
101
+ stopAnnouncing = announcePeerHost(peerHost, signaling);
102
+ if (host !== undefined) {
103
+ const worldHost = host;
104
+ const tick = () => { if (!closed && activeSession !== null && activeSession.members().length > 0)
105
+ worldHost.tick(tickMs / 1000); };
106
+ cancelTicks = args.scheduleTicks?.(tick, tickMs) ?? (() => {
107
+ const timer = setInterval(tick, tickMs);
108
+ return () => clearInterval(timer);
109
+ })();
110
+ }
111
+ const resolvedPeerHost = peerHost;
112
+ return {
113
+ gameId: args.gameId, userId, backend: resolvedPeerHost.backend, feedActions,
114
+ close() {
115
+ if (closing !== null)
116
+ return closing;
117
+ closed = true;
118
+ cancelTicks();
119
+ stopAnnouncing();
120
+ signaling.close();
121
+ resolvedPeerHost.close();
122
+ closing = resolvedPeerHost.router.drain().then(async () => {
123
+ if (host !== undefined)
124
+ await host.stop();
125
+ });
126
+ return closing;
127
+ },
128
+ };
129
+ }
130
+ catch (error) {
131
+ closed = true;
132
+ cancelTicks();
133
+ stopAnnouncing();
134
+ signaling.close();
135
+ peerHost?.close();
136
+ await peerHost?.router.drain();
137
+ if (host !== undefined)
138
+ await host.stop();
139
+ throw error;
140
+ }
141
+ }
142
+ let guest;
143
+ try {
144
+ guest = peers.guest({ userId });
145
+ const backend = await joinPeerSession(guest, signaling);
146
+ const resolvedGuest = guest;
147
+ let closed = false;
57
148
  return {
58
- gameId: args.gameId,
59
- userId,
60
- backend: peerHost.backend,
61
- feedActions,
62
- close: () => {
63
- stopAnnouncing();
149
+ gameId: args.gameId, userId, backend, feedActions,
150
+ async close() {
151
+ if (closed)
152
+ return;
153
+ closed = true;
64
154
  signaling.close();
65
- peerHost.close();
155
+ resolvedGuest.close();
66
156
  },
67
157
  };
68
158
  }
69
- const guest = createPeerGuest({ userId });
70
- const backend = await joinPeerSession(guest, signaling);
71
- return {
72
- gameId: args.gameId,
73
- userId,
74
- backend,
75
- feedActions,
76
- close: () => {
77
- signaling.close();
78
- guest.close();
79
- },
80
- };
159
+ catch (error) {
160
+ signaling.close();
161
+ guest?.close();
162
+ throw error;
163
+ }
81
164
  }
@@ -2,6 +2,8 @@ import * as THREE from "three";
2
2
  import type { PointerHit, PointerVec3 } from "@jgengine/core/input/pointer";
3
3
  export declare const POINTER_ENTITY_KEY = "jgEntityId";
4
4
  export declare const POINTER_OBJECT_KEY = "jgObjectId";
5
+ /** Object-store identities indexed by the current compacted GPU instance slot. @internal */
6
+ export declare const POINTER_OBJECT_INSTANCES_KEY = "jgObjectInstances";
5
7
  export type PointerHitFilter = (object: THREE.Object3D) => boolean;
6
8
  interface PointerDeps {
7
9
  camera: THREE.Camera;
@@ -1,6 +1,8 @@
1
1
  import * as THREE from "three";
2
2
  export const POINTER_ENTITY_KEY = "jgEntityId";
3
3
  export const POINTER_OBJECT_KEY = "jgObjectId";
4
+ /** Object-store identities indexed by the current compacted GPU instance slot. @internal */
5
+ export const POINTER_OBJECT_INSTANCES_KEY = "jgObjectInstances";
4
6
  function tagOf(object, key) {
5
7
  let cursor = object;
6
8
  while (cursor !== null) {
@@ -24,6 +26,8 @@ export function createPointerService() {
24
26
  const centerNdc = new THREE.Vector2(0, 0);
25
27
  const scratch = new THREE.Vector3();
26
28
  const normalMatrix = new THREE.Matrix3();
29
+ const instanceMatrix = new THREE.Matrix4();
30
+ const hitMatrix = new THREE.Matrix4();
27
31
  const groundPlane = new THREE.Plane(new THREE.Vector3(0, 1, 0), 0);
28
32
  let deps = null;
29
33
  let cursorPresent = false;
@@ -45,7 +49,12 @@ export function createPointerService() {
45
49
  const point = [hit.point.x, hit.point.y, hit.point.z];
46
50
  let normal = [0, 1, 0];
47
51
  if (hit.face !== null && hit.face !== undefined) {
48
- normalMatrix.getNormalMatrix(hit.object.matrixWorld);
52
+ hitMatrix.copy(hit.object.matrixWorld);
53
+ if (mesh.isInstancedMesh && hit.instanceId !== undefined) {
54
+ mesh.getMatrixAt(hit.instanceId, instanceMatrix);
55
+ hitMatrix.multiply(instanceMatrix);
56
+ }
57
+ normalMatrix.getNormalMatrix(hitMatrix);
49
58
  scratch.copy(hit.face.normal).applyMatrix3(normalMatrix).normalize();
50
59
  normal = [scratch.x, scratch.y, scratch.z];
51
60
  }
@@ -54,7 +63,8 @@ export function createPointerService() {
54
63
  point,
55
64
  normal,
56
65
  entity: tagOf(hit.object, POINTER_ENTITY_KEY),
57
- object: tagOf(hit.object, POINTER_OBJECT_KEY),
66
+ object: hit.instanceId === undefined ? tagOf(hit.object, POINTER_OBJECT_KEY) :
67
+ hit.object.userData[POINTER_OBJECT_INSTANCES_KEY]?.[hit.instanceId] ?? tagOf(hit.object, POINTER_OBJECT_KEY),
58
68
  ...(uv !== undefined ? { uv } : {}),
59
69
  material: standardMaterialSample(mesh.material),
60
70
  ...(hit.instanceId !== undefined ? { instanceId: hit.instanceId } : {}),
@@ -1,5 +1,14 @@
1
+ import { EffectComposer, type ShaderPass } from "three-stdlib";
1
2
  import type { PostProcessingConfig } from "@jgengine/core/render/postProcessing";
2
3
  import type { GraphicsQuality } from "@jgengine/core/settings/settingsModel";
4
+ interface BuiltGraph {
5
+ composer: EffectComposer;
6
+ grade: ShaderPass | null;
7
+ }
8
+ /** Release each pass and the composer's owned targets. @internal */
9
+ export declare function disposeGraph(built: BuiltGraph): void;
10
+ /** Resize the composer and its passes at the renderer's pixel ratio. @internal */
11
+ export declare function syncSize(built: BuiltGraph, width: number, height: number, pixelRatio: number): void;
3
12
  /**
4
13
  * Mounts an `EffectComposer` inside the shell Canvas and takes over rendering
5
14
  * (priority-1 `useFrame`, which disables R3F auto-render) to run the configured
@@ -20,3 +29,4 @@ export declare function PostProcessing({ config, quality, stages }: {
20
29
  smaa: boolean;
21
30
  };
22
31
  }): null;
32
+ export {};
@@ -8,7 +8,7 @@ import { BokehPass } from "three/examples/jsm/postprocessing/BokehPass.js";
8
8
  import { SMAAPass } from "three/examples/jsm/postprocessing/SMAAPass.js";
9
9
  import { createGradePass } from "./gradeShader.js";
10
10
  import { StylizePass } from "./stylizePass.js";
11
- import { hidePostfxOverlays, restorePostfxOverlays } from "./postfxOverlay.js";
11
+ import { renderShadowlessPrepass } from "./shadowPrepass.js";
12
12
  /**
13
13
  * GTAO renders the scene with an `overrideMaterial` normal/depth prepass, which stamps
14
14
  * transparent overlay quads (additive VFX sprites, telegraphs, debug gizmos) into the AO
@@ -19,18 +19,14 @@ import { hidePostfxOverlays, restorePostfxOverlays } from "./postfxOverlay.js";
19
19
  class OverlayAwareGTAOPass extends GTAOPass {
20
20
  hiddenOverlays = [];
21
21
  render(renderer, writeBuffer, readBuffer, deltaTime, maskActive) {
22
- hidePostfxOverlays(this.scene, this.hiddenOverlays);
23
- super.render(renderer, writeBuffer, readBuffer, deltaTime, maskActive);
24
- restorePostfxOverlays(this.hiddenOverlays);
22
+ renderShadowlessPrepass(renderer, this.scene, this.hiddenOverlays, () => super.render(renderer, writeBuffer, readBuffer, deltaTime, maskActive));
25
23
  }
26
24
  }
27
25
  /** DOF's depth prepass has the same `overrideMaterial` overlay-stamping problem as GTAO. */
28
26
  class OverlayAwareBokehPass extends BokehPass {
29
27
  hiddenOverlays = [];
30
28
  render(renderer, writeBuffer, readBuffer, deltaTime, maskActive) {
31
- hidePostfxOverlays(this.scene, this.hiddenOverlays);
32
- super.render(renderer, writeBuffer, readBuffer, deltaTime, maskActive);
33
- restorePostfxOverlays(this.hiddenOverlays);
29
+ renderShadowlessPrepass(renderer, this.scene, this.hiddenOverlays, () => super.render(renderer, writeBuffer, readBuffer, deltaTime, maskActive));
34
30
  }
35
31
  }
36
32
  const TONE_MAPPING = {
@@ -41,22 +37,16 @@ const TONE_MAPPING = {
41
37
  linear: THREE.LinearToneMapping,
42
38
  none: THREE.NoToneMapping,
43
39
  };
44
- function disposeGraph(built) {
40
+ /** Release each pass and the composer's owned targets. @internal */
41
+ export function disposeGraph(built) {
45
42
  for (const pass of built.composer.passes)
46
43
  pass.dispose();
47
- if (built.dof !== null) {
48
- built.dof.renderTargetDepth.dispose();
49
- built.dof.materialDepth.dispose();
50
- built.dof.materialBokeh.dispose();
51
- built.dof.fsQuad.dispose();
52
- }
53
44
  built.composer.dispose();
54
45
  }
55
- function syncSize(built, width, height, pixelRatio) {
46
+ /** Resize the composer and its passes at the renderer's pixel ratio. @internal */
47
+ export function syncSize(built, width, height, pixelRatio) {
56
48
  built.composer.setPixelRatio(pixelRatio);
57
49
  built.composer.setSize(width, height);
58
- if (built.dof !== null)
59
- built.dof.renderTargetDepth.setSize(width * pixelRatio, height * pixelRatio);
60
50
  }
61
51
  /**
62
52
  * Mounts an `EffectComposer` inside the shell Canvas and takes over rendering
@@ -102,10 +92,9 @@ export function PostProcessing({ config, quality = "high", stages }) {
102
92
  const b = config.bloom ?? {};
103
93
  composer.addPass(new UnrealBloomPass(new THREE.Vector2(width, height), b.strength ?? 0.32, b.radius ?? 0.55, b.threshold ?? 0.85));
104
94
  }
105
- let dof = null;
106
95
  if (resolvedStages.dof && config.dof !== undefined && config.dof !== false) {
107
96
  const d = config.dof;
108
- dof = new OverlayAwareBokehPass(scene, camera, {
97
+ const dof = new OverlayAwareBokehPass(scene, camera, {
109
98
  focus: d.focus ?? 18,
110
99
  aperture: d.aperture ?? (quality === "high" ? 0.00025 : 0.00012),
111
100
  maxblur: d.maxBlur ?? 0.01,
@@ -125,7 +114,7 @@ export function PostProcessing({ config, quality = "high", stages }) {
125
114
  grade = createGradePass(config.grade ?? {});
126
115
  composer.addPass(grade);
127
116
  }
128
- const graph = { composer, grade, dof };
117
+ const graph = { composer, grade };
129
118
  syncSize(graph, width, height, gl.getPixelRatio());
130
119
  builtRef.current = graph;
131
120
  return () => {
@@ -133,27 +122,6 @@ export function PostProcessing({ config, quality = "high", stages }) {
133
122
  builtRef.current = null;
134
123
  };
135
124
  }, [gl, scene, camera, config, quality, stages]);
136
- useEffect(() => {
137
- const lut = config.grade !== undefined && config.grade !== false ? config.grade.lut : undefined;
138
- const grade = builtRef.current?.grade;
139
- if (lut === undefined || grade === null || grade === undefined)
140
- return;
141
- let cancelled = false;
142
- const loader = new THREE.TextureLoader();
143
- loader.loadAsync(lut.url).then((texture) => {
144
- if (cancelled) {
145
- texture.dispose();
146
- return;
147
- }
148
- texture.colorSpace = THREE.SRGBColorSpace;
149
- texture.minFilter = THREE.NearestFilter;
150
- texture.magFilter = THREE.NearestFilter;
151
- texture.generateMipmaps = false;
152
- grade.uniforms.uLut.value = texture;
153
- grade.uniforms.uLutSize.value = lut.size ?? 32;
154
- }).catch(() => undefined);
155
- return () => { cancelled = true; };
156
- }, [config.grade]);
157
125
  useEffect(() => {
158
126
  const prevTone = gl.toneMapping;
159
127
  const prevExposure = gl.toneMappingExposure;
@@ -1,4 +1,4 @@
1
1
  import { ShaderPass } from "three-stdlib";
2
2
  import type { GradeConfig } from "@jgengine/core/render/postProcessing";
3
- /** Build the display-space colour-grade pass (lift/gain/gamma, saturation, vignette, grain). Advance `uniforms.uTime.value` each frame to animate the grain. */
3
+ /** Build the display-space colour-grade pass and load its optional LUT. Dispose the pass to release its LUT; advance `uniforms.uTime.value` each frame to animate grain. */
4
4
  export declare function createGradePass(config?: GradeConfig): ShaderPass;
@@ -61,11 +61,11 @@ const vertexShader = /* glsl */ `
61
61
  gl_Position = projectionMatrix * modelViewMatrix * vec4(position, 1.0);
62
62
  }
63
63
  `;
64
- /** Build the display-space colour-grade pass (lift/gain/gamma, saturation, vignette, grain). Advance `uniforms.uTime.value` each frame to animate the grain. */
64
+ /** Build the display-space colour-grade pass and load its optional LUT. Dispose the pass to release its LUT; advance `uniforms.uTime.value` each frame to animate grain. */
65
65
  export function createGradePass(config = {}) {
66
66
  const lift = config.lift ?? DEFAULT_LIFT;
67
67
  const gain = config.gain ?? DEFAULT_GAIN;
68
- return new ShaderPass({
68
+ const pass = new ShaderPass({
69
69
  uniforms: {
70
70
  tDiffuse: { value: null },
71
71
  uLift: { value: new THREE.Vector3(lift[0], lift[1], lift[2]) },
@@ -82,4 +82,32 @@ export function createGradePass(config = {}) {
82
82
  vertexShader,
83
83
  fragmentShader,
84
84
  });
85
+ let disposed = false;
86
+ let lutTexture = null;
87
+ const dispose = pass.dispose.bind(pass);
88
+ pass.dispose = () => {
89
+ if (disposed)
90
+ return;
91
+ disposed = true;
92
+ lutTexture?.dispose();
93
+ lutTexture = null;
94
+ dispose();
95
+ };
96
+ if (config.lut !== undefined) {
97
+ const lut = config.lut;
98
+ void new THREE.TextureLoader().loadAsync(lut.url).then((texture) => {
99
+ if (disposed) {
100
+ texture.dispose();
101
+ return;
102
+ }
103
+ lutTexture = texture;
104
+ texture.colorSpace = THREE.SRGBColorSpace;
105
+ texture.minFilter = THREE.NearestFilter;
106
+ texture.magFilter = THREE.NearestFilter;
107
+ texture.generateMipmaps = false;
108
+ pass.uniforms.uLut.value = texture;
109
+ pass.uniforms.uLutSize.value = lut.size ?? 32;
110
+ }).catch(() => undefined);
111
+ }
112
+ return pass;
85
113
  }
@@ -0,0 +1,3 @@
1
+ import type * as THREE from "three";
2
+ /** Reuse the beauty pass's shadow maps while drawing a scene prepass. @internal */
3
+ export declare function renderShadowlessPrepass<T>(renderer: Pick<THREE.WebGLRenderer, "shadowMap">, scene: THREE.Object3D, hiddenOverlays: THREE.Object3D[], render: () => T): T;
@@ -0,0 +1,18 @@
1
+ import { hidePostfxOverlays, restorePostfxOverlays } from "./postfxOverlay.js";
2
+ /** Reuse the beauty pass's shadow maps while drawing a scene prepass. @internal */
3
+ export function renderShadowlessPrepass(renderer, scene, hiddenOverlays, render) {
4
+ const shadowMap = renderer.shadowMap;
5
+ const autoUpdate = shadowMap.autoUpdate;
6
+ const needsUpdate = shadowMap.needsUpdate;
7
+ hidePostfxOverlays(scene, hiddenOverlays);
8
+ shadowMap.autoUpdate = false;
9
+ shadowMap.needsUpdate = false;
10
+ try {
11
+ return render();
12
+ }
13
+ finally {
14
+ shadowMap.autoUpdate = autoUpdate;
15
+ shadowMap.needsUpdate = needsUpdate;
16
+ restorePostfxOverlays(hiddenOverlays);
17
+ }
18
+ }