@nayan-ui/engine 1.0.0-beta.5 → 1.0.0-beta.6

package/README.md

@@ -216,6 +216,46 @@ audio.enabled = settings.sounds; // respect the player's preferences
 haptics.enabled = settings.haptics;
 ```
 
+### System speech
+
+```ts
+import { speech } from '@nayan-ui/engine';
+
+await speech.speak('Well done!', { language: 'en-US', rate: 1, pitch: 1, volume: 1 });
+const voices = await speech.getAvailableVoicesAsync();
+await speech.speak('Your next turn', { voice: voices[0]?.identifier });
+await speech.stop(); // Cancel current speech and clear the queue when leaving the screen.
+```
+
+Speech runs through the Rust core, using iOS AVSpeechSynthesizer through Objective-C bindings,
+Android TextToSpeech through JNI, and browser speechSynthesis through web-sys/WASM.
+It creates no audio files, needs no microphone permission or Expo Speech dependency,
+and plays independently of `audio` and its volume/mute settings. The web adapter automatically
+awaits engine warm-up before sending commands into WASM. Rebuild native apps after upgrading
+from an engine without speech support; `speech.supported` checks API availability.
+
+`speak` adds text to the system queue and returns a promise that resolves when queued, **not when
+playback ends**. Initialization, invalid voices, unsupported languages and Android's system text
+length limit can reject that promise. On Android, initialization times out after 15 seconds and a
+later request can retry. Stopping during initialization cancels pending speech immediately (those
+`speak` promises reject); it does not wait for a system callback. Empty/whitespace text is ignored. Options default to the
+system language/voice, rate 1, pitch 1 and volume 1. Rate accepts 0.1–2, pitch 0.5–2 and volume 0–1;
+the platform may clamp the effective rate. Voices and pronunciation depend on the installed system
+speech engine. `getAvailableVoicesAsync()` returns identifiers, names, BCP 47 languages and quality.
+Android lists installed voices that do not require a network connection.
+
+`isSpeakingAsync()` reports active speech (including paused speech on iOS/web). `pause()` and
+`resume()` work on iOS/web and reject on Android, whose system API has no pause/resume support.
+`stop()` resets paused browser state and ends the iOS synthesizer session so the next run starts cleanly.
+Browsers may require a user gesture before speaking, and voice discovery can initially be empty.
+As with [Expo Speech](https://docs.expo.dev/versions/latest/sdk/speech/), actual output depends on
+device settings such as silent mode. This API implements the options and methods above, not Expo's
+utterance event callbacks. System playback errors after an utterance is queued are not reported.
+
+For a muted iOS integration check, rebuild the core, boot an Apple Silicon simulator and run
+`bun test packages/engine/native/tests/speech-ios.test.ts` from the repository root. This checks the
+real Rust/native bridge, including stopping before playback begins and speaking again afterwards.
+
 ### Score and timers
 
 ```ts
@@ -236,12 +276,61 @@ Build a mesh once at module scope (after `warmUpEngine()`), then spawn it many t
 ```ts
 import { createShape, lathe } from '@nayan-ui/engine';
 
-const vase = createShape(lathe([[0, 0], [0.4, 0.1], [0.25, 0.8], [0.3, 1]], { segments: 24 }));
+const vase = createShape(
+  lathe(
+    [
+      [0, 0],
+      [0.4, 0.1],
+      [0.25, 0.8],
+      [0.3, 1]
+    ],
+    { segments: 24 }
+  )
+);
 world.spawn({ mesh: vase, color: '#C8763A' });
 ```
 
 Also available: `merge`, `tube`, `extrude`, `loft`, `block`, `ellipsoid`, `parametricSurface`, `Solid` and `shapeGeometry`.
 
+### Procedural worlds
+
+Describe terrain and placement rules as data; the native core generates the world on a background
+thread and answers walker queries, so none of that work runs in JavaScript.
+
+```ts
+import { FieldGraph, generateWorldAsync } from '@nayan-ui/engine';
+
+const f = new FieldGraph();
+const bank = f.sub(f.abs(f.sub(f.x, f.sines(f.x, f.z, 0, [[0, 0.04, 0, 12]]))), 4); // a winding river
+f.output('bank', bank);
+f.output('height', f.select(bank, -1, f.bumps(f.x, f.z, [[30, 20, 5, 15, 12, 0]])));
+f.output('clear', f.sub(bank, 1));
+
+const world = await generateWorldAsync({
+  seed: 7,
+  fields: f,
+  terrain: {
+    axis: [...Array(101).keys()].map((i) => i * 2 - 100),
+    height: 'height',
+    regions: [{ field: 'bank', surface: 2, material: 1 }],
+    fallback: { surface: 1, material: 0 },
+    materials: 2
+  },
+  walk: { boundary: 95, clearance: 'clear', height: 2 },
+  steps: [
+    { kind: 'spawn', near: [-30, 0], rings: 20, samples: 16, radius: 1 },
+    { kind: 'reach', cell: 3, steps: 6, radius: 0.6, extent: 100 },
+    { kind: 'pick', groups: [{ name: 'coins', count: 10, spacing: 8 }] }
+  ]
+});
+const land = createShape(world.terrain(0), { center: false }); // one mesh per material
+world.move(player, dx, dz, 0.5); // swept move-and-slide; also ground, walkable, canSee, tilt
+```
+
+Scatter steps place scenery with filters (fields, walkability, surfaces) and optional solids;
+`generateMesh` builds parametric surfaces and seeded cards. Pass `key` to save a world (tied to its
+exact recipe) and restore it on later visits.
+
 ### Flat boards and puzzles
 
 `frontLight` keeps camera-facing surfaces at their exact color.
@@ -276,7 +365,9 @@ The engine is built so that a game written the obvious way stays smooth on mid-r
 
 - **Display clock and render thread (iOS and Android).** The display's vsync (`CADisplayLink` on iOS, `Choreographer` on Android) asks for each frame at 60 Hz. `onUpdate` steps the game and hands a copy of the frame to a native render thread, which culls, submits and presents it. The JS thread never waits on the GPU, and a frame that is still waiting when a newer one arrives is replaced, not queued. The clock stops while the app is in the background or the view is off screen. On the web, `requestAnimationFrame` drives the same loop.
 - **Culling in Rust.** Everything outside the camera's view (and outside the light's box for shadows) is skipped every frame, so open levels and long tracks only pay for what is on screen. Don't cull scenery in JS.
-- **Automatic quality.** `quality="auto"` (the default) starts at `high` and steps down (shadow detail first, then anti-aliasing, resolution last) only while the device can't keep up. `onStats` reports fps, update and render time, the quality chosen and the graphics backend.
+- **Automatic quality.** `quality="auto"` (the default) starts at `high` and steps down (shadows off first, then anti-aliasing, resolution last) only while the device can't keep up. Shadows always come from a full-resolution map (soft at `high`, crisp at `medium`): `low` and `lowest` skip the shadow pass rather than show blurred low-resolution shadows. `lowest` smooths edges with FXAA (in the pass that stretches its reduced scene), and `lowest`'s pixel cap shrinks only the 3D scene (stretched to fill the view): the overlay, and so all HUD text, is always drawn at the screen's own resolution. With a `qualityKey` (games pass their id) the level it settles on is saved in the engine's durable store, so later visits, after app restarts too, start there. Pass `adaptQuality={false}` while what's on screen isn't the game being played (a menu, a results card): those frames then never change or save the level. `onStats` reports fps, update and render time, the quality chosen and the graphics backend.
+- **Cached backdrops.** Spawn scenery that never moves (a sky, distant hills, a board's background) with `still: true`, or a whole still scene into `world.backdropLayer(capacity)` (then `update(0)` it). `GameView` draws the world's backdrop layer once into an image behind the scene and draws that image each frame instead, redrawing it only after a still entity changes, the camera moves or the light changes. Live entities are always drawn in front of it and it receives no live shadows, so keep anything that moves, or that live pieces pass behind, in the world. A still entity takes `set` and `despawn` but can't be attached, animated, picked or given physics or text.
+- **Small things stay cheap.** Built-in spheres a few pixels across on screen (stars, pellets, beads) are drawn with 8- or 12-sided stand-ins, and instances scaled to nothing are never drawn, so pools of hidden pieces cost nothing on the GPU.
 - **Background loading.** `loadTexture`, `loadModel`, `loadFont` and `audio.load` decode on native threads in parallel, and meshes are registered with the renderer inside Rust.
 - **Work between frames.** `afterNextFrame(fn)` runs `fn` right after the next frame leaves, so you can spread long setup work (map generation, mesh building) over several frames behind a loading screen.
 - **Cached procedural assets.** `ProceduralCache` saves built geometry on disk keyed by a recipe, so later launches restore it instead of rebuilding; `peek(key)` returns a saved value without building anything.
@@ -307,8 +398,8 @@ Keep these habits:
 
 ## Learn more
 
-| Topic                                 | Guide                                                                                                          |
-| ------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| Topic                                 | Guide                                                                                                               |
+| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
 | Build a complete game step by step    | [First game](https://www.nayanui.com/game-engine/first-game)                                                        |
 | Copy-paste solutions                  | [Recipes](https://www.nayanui.com/game-engine/recipes)                                                              |
 | Worlds, entities, rotations, disposal | [World & entities](https://www.nayanui.com/game-engine/world-entities)                                              |

package/lib/module/assets/ProceduralCache.js

@@ -43,6 +43,11 @@ export class ProceduralCache {
     this.revision = revision;
     this.storage = storage;
   }
+
+  /** The engine storage key of `key` in this revision (for records the native core reads and writes itself). */
+  storageKey(key) {
+    return `procedural:${this.revision}:${key}`;
+  }
   get stats() {
     return {
       hits: this.hits,

package/lib/module/assets/loft.js

@@ -1,7 +1,7 @@
 "use strict";
 
-import { lathe, merge, recolor } from "./shape.js";
-import { parametricSurface } from "./surface.js";
+import { FieldFunction } from "./procedural.js";
+import { lathe, merge, nativeSweep, recolor } from "./shape.js";
 /**
  * Smooth closed body through rounded rectangular cross sections along Z. Useful for vehicle
  * shells, cabins, shoes and fairings. Caps have separate flat normals and planar UVs; sides have
@@ -15,72 +15,24 @@ export function loft(sections, options = {}) {
     steps = options.smoothness ?? 4;
   if (!Number.isInteger(n) || n < 6 || n > 512 || !Number.isInteger(steps) || steps < 1 || steps > 64) throw new Error('loft: invalid around/smoothness');
   const values = ordered.map(s => [s.z, s.bottom, s.top, s.width, s.topWidth ?? s.width, s.square ?? 4]);
-  const at = i => values[Math.max(0, Math.min(values.length - 1, i))];
-  const row = v => {
-    const cursor = v * (values.length - 1),
-      i = Math.min(values.length - 2, Math.floor(cursor)),
-      t = cursor - i;
-    const a = at(i - 1),
-      b = at(i),
-      c = at(i + 1),
-      d = at(i + 2);
-    const f = b.map((_, k) => 0.5 * (2 * b[k] + (-a[k] + c[k]) * t + (2 * a[k] - 5 * b[k] + 4 * c[k] - d[k]) * t * t + (-a[k] + 3 * b[k] - 3 * c[k] + d[k]) * t * t * t));
-    f[2] = Math.max(f[1] + 1e-6, f[2]);
-    f[3] = Math.max(0, f[3]);
-    f[4] = Math.max(0, f[4]);
-    f[5] = Math.max(1, f[5]);
-    return f;
-  };
-  const rowCount = (sections.length - 1) * steps;
-  const rows = Array.from({
-    length: rowCount + 1
-  }, (_, i) => row(i / rowCount));
-  const point = (u, v) => {
-    const [z, bottom, top, width, topWidth, square] = rows[Math.round(v * rowCount)],
-      angle = -Math.PI / 2 + u * Math.PI * 2;
-    const c = Math.cos(angle),
-      s = Math.sin(angle),
-      exponent = 2 / square;
-    const x = Math.sign(c) * Math.abs(c) ** exponent,
-      y = Math.sign(s) * Math.abs(s) ** exponent;
-    return [x * (y > 0 ? width + (topWidth - width) * y : width), (bottom + top) / 2 + y * (top - bottom) / 2, z];
-  };
-  const side = parametricSurface(point, {
-    uSegments: n,
-    vSegments: rowCount,
-    wrapU: true
+  const color = options.color;
+  const g = nativeSweep({
+    kind: 'loft',
+    sections: values,
+    around: n,
+    smoothness: steps,
+    color: typeof color === 'function' || color instanceof FieldFunction || !color ? undefined : [color[0], color[1], color[2]],
+    colorField: color instanceof FieldFunction ? color : undefined
   });
-  const parts = [{
-    geometry: side
-  }];
-  for (const [v, facing] of [[0, -1], [1, 1]]) {
-    const section = rows[v * rowCount],
-      cy = (section[1] + section[2]) / 2;
-    const vertices = new Float32Array((n + 1) * 11),
-      indices = [];
-    vertices.set([0, cy, section[0], 0, 0, facing, 1, 1, 1, 0.5, 0.5]);
-    for (let j = 0; j < n; j++) {
-      const p = point(j / n, v),
-        width = Math.max(section[3], section[4], 1e-6);
-      vertices.set([p[0], p[1], p[2], 0, 0, facing, 1, 1, 1, 0.5 + p[0] / (2 * width), (p[1] - section[1]) / (section[2] - section[1])], (j + 1) * 11);
-      const a = j + 1,
-        b = (j + 1) % n + 1;
-      if (facing === 1) indices.push(0, a, b);else indices.push(0, b, a);
-    }
-    parts.push({
-      geometry: {
-        vertices,
-        indices: new Uint32Array(indices)
-      }
-    });
-  }
-  return paint(merge(parts), options.color);
+  return typeof color === 'function' ? paint(g, color) : g;
 }
 function paint(geometry, color) {
-  return color ? recolor(geometry, typeof color === 'function' ? ({
+  if (!color) return geometry;
+  if (color instanceof FieldFunction) return recolor(geometry, color);
+  return recolor(geometry, typeof color === 'function' ? ({
     position,
     normal
-  }) => color(position, normal) : () => color) : geometry;
+  }) => color(position, normal) : () => color);
 }
 
 /** A rounded rectangular cross-section with flat front/back caps, centered at the origin. */