@funpixel/tools 0.0.0-stage → 0.1.1

package/plugins/codex/skills/funpixel-world-and-story/references/story-at-size.md

@@ -0,0 +1,159 @@
+# Story at the right size: 5 to 15 minutes
+
+Story was missing in nine of our GDK games, and the experience bar measured story as the widest
+gap to the top tier. The fix is rarely more words. Silt & Signal (research 19) tells a whole arc
+in 12–15 minutes with 7 chapters, 29 objectives and 61 short lines, most under ten words. This
+page sizes a story to a small game and shows how to prove play reaches it.
+
+Declining story is a real choice. An arcade round, a score attack or an abstract puzzle can say
+`Story: declined — the world and the score carry it` in the GDD, and every check below then
+reports "no story declared" as fine.
+
+## The shape
+
+| Piece | What it is | In Silt & Signal |
+|---|---|---|
+| An opening beat | who, where and what is wrong, in under 15 seconds, before or as control starts | a kneeling rider, a sick creature, "We'll find someone who knows" |
+| A goal said by a person | a character asks for it in a line; the HUD repeats it | the healer: "Her kind needs the old crossings" |
+| Chapters | one place and one new idea each, with a card and a line as it opens | `02 / THE BROKEN AQUEDUCT` and Mira's "The official road is closed" |
+| Lines that change as you go | the same person says something new each time, and remarks on what just happened | the rider's tone moves from "Hold on, little light" to "You don't have to stay" |
+| A turn | something the player did, or learned, changes what the goal means | sending the coordinates is the betrayal |
+| An ending worth reaching | the world visibly changed, a last line, an end card that names what happened | the lamps waking in the village, "The road belongs to her" |
+
+## Sized to the game
+
+| Length | Chapters or beats | Lines | Speakers | A turn? |
+|---|---|---|---|---|
+| 3–5 min (a short round, on purpose) | 3 beats: want, test, payoff | 8–12 | 1–2 | optional |
+| 5–10 min (a smaller scope, on purpose) | 3–5 chapters | 15–30 | 2–3 | one, near two thirds |
+| 15 min and more (the floor for a game) | 5–7 chapters | 30–60 | 3–5 | one, plus a quiet beat before the end |
+
+A line is one sentence a player reads in about two seconds. Past 60 lines the cost is not the
+words, it is the voice, the timing and the testing of each one.
+
+## The outer story, at 10 minutes and up
+
+A want inside the hero is not enough past ten minutes; the player needs something to point at.
+Five lines in the GDD, each something the player sees or does. One of our games lacked all five.
+
+| Line | What it is | From |
+|---|---|---|
+| Goal | a place on the map and a distance, said by a person, shown by the HUD | A Short Hike's summit; Silt & Signal's crossings |
+| Clock | one deadline for the whole game, visible in every play frame | Majora's Mask's moon; 80 Days |
+| Question | a mystery asked in minute one, one piece answered per chapter | Outer Wilds; "what happened here?" |
+| Antagonist | a plan that moves while you play, a reason that is almost right, marks in every chapter, seen in few; the turn is the player having helped it | Silt & Signal's Director; Cowboy Bebop's Syndicate |
+| Frame | in an episodic game, each episode also moves the spine one step | Edith Finch; Death Stranding's network |
+
+Make the core verb the plot (each delivery wakes the network), and let the hero's want be
+active and out in the world while the ending pays what she needs.
+
+## The GDD section
+
+The design's `## Story` section carries the beats as a table a check can read. `funtools depth`
+reads the story table and sets each beat beside what real play reached.
+
+```markdown
+## Story
+Want: <what the hero wants, in the words of the person who asks for it>
+Turn: <the moment the want changes meaning, and what the player does to cause it>
+Ending: <what the world looks like after, and the last line>
+
+| Beat | When | Who says it | The line | Seen in play |
+|---|---|---|---|---|
+| opening | 0:00, over the title pan | Narrator | "The city went under in one night." | |
+| goal | 0:15, at the first rooftop | Ada | "Get the medicine to the hospital before the tide turns." | |
+| ch2 | 2:00, the market district | Old Tomas | "You again? The bridge is gone, take the wires." | |
+| turn | 7:30, the hospital roof | Ada | "There's no hospital. There's only us." | |
+| ending | 10:00, dawn | Ada | "Look. The water's going down." | |
+```
+
+The first column is the beat's id. Expose the current id as `__FPX_STATE__.beat` when a beat
+plays (`state.beat = 'ch2'`), so a play log records which beats were really reached. The
+`Seen in play` column is filled from real play (`funtools depth --fill`), never by hand.
+
+## Lines as data
+
+Lines live in one file, keyed by what triggers them, so the writing can change without touching
+code and a voice pass can walk the same list. A trigger is a place entered, a deed done, or a
+count reached; a variant picks by how many times it has fired, so the second visit gets a new line.
+
+```ts
+// src/story/lines.ts: every line in the game, with its trigger and optional voice file.
+export interface Line { id: string; who: string; text: string; voice?: string }
+export interface Cue { trigger: string; lines: Line[][]; once?: boolean }
+
+export const CUES: Cue[] = [
+  { trigger: 'enter:market', lines: [
+    [{ id: 'm1', who: 'Tomas', text: 'A courier? In this weather?', voice: 'voice/m1.mp3' }],
+    [{ id: 'm2', who: 'Tomas', text: 'Back so soon. The wires still hold.', voice: 'voice/m2.mp3' }],
+  ] },
+  { trigger: 'deed:first-delivery', once: true, lines: [
+    [{ id: 'd1', who: 'Ada', text: 'One down. The hospital is past the bell tower.' }],
+  ] },
+];
+
+/** Picks the line for a trigger: the nth variant on the nth firing, the last one after that. */
+export class Script {
+  private fired = new Map<string, number>();
+  constructor(private cues: Cue[], private play: (lines: Line[]) => void, private busy: () => boolean = () => false) {}
+  private queue: Line[][] = [];
+  fire(trigger: string) {
+    const cue = this.cues.find((c) => c.trigger === trigger);
+    if (!cue) return;
+    const n = this.fired.get(trigger) ?? 0;
+    if (cue.once && n > 0) return;
+    this.fired.set(trigger, n + 1);
+    this.queue.push(cue.lines[Math.min(n, cue.lines.length - 1)]);
+  }
+  /** Each frame: play the next queued line when nothing else is being read (a fight, a card, a tutorial). */
+  update() { if (this.queue.length && !this.busy()) this.play(this.queue.shift()!); }
+  save() { return Object.fromEntries(this.fired); }
+  load(s: Record<string, number>) { this.fired = new Map(Object.entries(s)); }
+}
+```
+
+Wire `play` to `say()` from [opening-and-chapters.md](opening-and-chapters.md), or to the voiced
+version in [voice.md](voice.md). Save `script.save()` with `@funpixel/sdk/save` so a returning
+player does not hear the opening twice.
+
+## Craft notes
+
+- **The goal comes from a mouth.** "Deliver 5 parcels" in a HUD is a task; "Get the medicine to
+  the hospital before the tide turns", said by someone waiting for it, is a want. Put both on screen.
+- **Remark on what just happened.** Hades's trick: a line that names the last death, the new
+  weapon, the room you just cleared. Trigger lines on deeds, not timers, and the game feels like
+  it is watching.
+- **One new idea per chapter, said once.** The chapter card names the place; the first line names
+  the new rule in the world's words ("Point them down" for a jet under the bike).
+- **A quiet beat before the end.** A moment with no threat and one line ("Sleep. I'm right here.")
+  makes the ending land. On a pacing chart it is the long release before the last peak.
+- **The ending changes the world.** Go back to the first place and show it changed: the lamps
+  lit, the water down, the crowd on the rooftops cheering. The end card names what the player
+  did, not only "You win".
+- **Let a character come back.** Three to five speakers who each return beat a new face per
+  chapter; a returning face carries the arc.
+- **Keep lines short and in the player's thumb's way.** One sentence, a speaker name, bottom third,
+  clear of the controls (skill `funpixel-mobile-ui`), and never a line a fight has to wait behind.
+
+## Staged versus played
+
+A beat that exists only in a staged view is not in the game. One game's playtest caught a
+showcase frame play never reached; the same happens to story. Three places see it:
+
+- `funtools depth` reads the `## Story` table and the `beat` field in real play logs (blind
+  rounds, journeys) and lists each beat as seen or never seen. It warns about a declared beat
+  play never reached; it never blocks.
+- `funtools playtest` sets each planned moment beside the frame play reached, and flags a staged
+  frame the played route never saw.
+- The blind player's report: ask it who asked for what, and what happened at the end. If it
+  cannot say, the story is in the files, not in the game.
+
+## Common mistakes
+
+- A story told only on the title card, then never again.
+- The goal only in the HUD, with no one asking for it.
+- Lines on a timer that fire during a fight or over a tutorial caption.
+- An ending that is a text card over black, with the world gone.
+- A voice line that holds its caption until the file loads: advance on the clip's end or a timeout,
+  whichever comes first (Silt & Signal's first caption waited 30 s for a slow file).
+- Chapters that are only colour changes: each needs one idea the player uses there.

package/plugins/codex/skills/funpixel-world-and-story/references/voice.md

@@ -0,0 +1,175 @@
+# Voiced lines: what the platform can make, and the creator's own voice
+
+Silt & Signal voices all 61 of its lines, and the voice teaches as much as the text: the tutorial
+for the jets is a joke said aloud. A voice is worth having when a game is about people. This page
+is honest about what Funpixel's tools make today and gives a path for the rest.
+
+## What the platform makes today (1 Oct 2026)
+
+| Want | Funpixel tool | Works? |
+|---|---|---|
+| A spoken sentence with the exact words | `cast_voice`, then `voice_line` | yes: **the default offer for a story game** (below), with its price, made only when the creator picks it. `generate_sound` is the wrong tool: asked for speech it makes murmurs or the wrong words |
+| A murmur, a gasp, a laugh, a crowd | `generate_sound` | yes, 2 credits each: "a woman's short warm murmur, no words, 1.5 seconds" |
+| A voice-like blip per letter | none needed | yes, in code (below), free |
+| Music that swells under a line | `generate_music` + a duck | yes (skill `funpixel-audio`) |
+
+So for real words, four honest options: the platform's voice, then three cheaper ones.
+
+## Option 0: the platform's voice (the default offer for a story game, priced, picked by the creator)
+
+**A story game offers voice by default** (the Silt bar S3:
+at least one voiced line before first control, every line voiced and captioned, a line advancing on
+its clip's end). Silt voiced 57 lines heard by objective 33; one of our games typed its radio lines and
+lost on it. So for a game with a story, characters who speak or a cold open, the plan's Art budget
+lists the voiced lines with their price as the default, and the creator picks voice, one of the
+cheaper options below, or none: still priced, still the creator's choice, never made unasked. For an
+arcade round without people, voice stays an extra you mention once. An ordinary line is charged
+1 credit (each job holds a little more while it runs), so a cast of six with 40 lines each is about
+240 credits plus a sample per voice; `funtools estimate` or the tool's price list says the
+current numbers.
+
+1. **One voice per character, once.** `cast_voice` with the character's `name`, a `preset` (one of
+   30 voices: Kore firm, Puck upbeat, Charon informative, Algenib gravelly, Achernar soft, …) and up
+   to four delivery words as `tags` (`gruff`, `weary`, `whispering`). It answers `voice.json` and a
+   `sample.mp3`: play the sample to the creator before any line is made.
+2. **Every line in that voice.** `voice_line` with the line's `text` and voice.json's asset id as
+   `voice_asset_id`, so each line gets the same preset and tags; `emotion` adds up to three words
+   for that line only. Inside the text, `[sighs]`, `[laughs]` or `[pause]` steer the delivery and
+   are not spoken. Never write a direction as words ("Say it angrily: …"): it is read aloud.
+3. **The lines file stays the source of truth.** One job per line, named by the line's id
+   (`funtools gen line "<text>" --voice .funtools/voice/<who>.json`), saved under
+   `public/assets/voice/`, mastered for speech (trimmed, one loudness). Record each in the Art
+   budget with its credits.
+4. **A scene played as one piece (a cutscene, a cold open, a radio exchange): `dialogue`.** One call with the scene's lines (`{speaker, text, voice?, tags?, pause_after_ms?}`, the voices from `cast`) speaks each in its speaker's voice and lays them on tracks: `dialogue.mp3` (the scene mixed into one file at one loudness), each line also as `line-NN.mp3`, and `dialogue.json`, the timeline (each clip's track, start and length) to cue captions from. Priced as its lines; `funtools gen dialogue scene.json`. Lines the game plays one at a time stay `voice_line`.
+
+A local option, never the default: `funtools gen line "<text>" --voice <who>.json --model kokoro-82m` (or `gen dialogue scene.json --model kokoro-82m` for a scene) speaks the line with Kokoro on the creator's Apple Silicon Mac, once `funtools models install kokoro-82m` has set it up. Ours stays the recommended pick: Kokoro is free and offline, but slower and not checked by us, so offer it only when the creator asks for free or offline voice, and never run it unasked or in place of ours.
+
+No cloning: a real person's voice needs their consent recording, and the platform does not take
+one.
+
+## Option 1: a voice in code (free, always works)
+
+A pitched blip per letter, one pitch and waveform per speaker, the way Celeste and Animal
+Crossing give each character a voice without a single recorded word. It reads as speech because
+it follows the text's rhythm: a pause at commas, a longer one at full stops.
+
+```ts
+/** One voice per speaker: a short blip per letter, pitched and shaped by who is talking. */
+export interface Timbre { base: number; spread: number; wave: OscillatorType; gain: number }
+export const TIMBRES: Record<string, Timbre> = {
+  Ada: { base: 520, spread: 90, wave: 'triangle', gain: 0.12 },
+  Tomas: { base: 180, spread: 40, wave: 'square', gain: 0.06 },
+  Narrator: { base: 300, spread: 30, wave: 'sine', gain: 0.1 },
+};
+
+export function blipVoice(ctx: AudioContext, out: AudioNode, who: string) {
+  const v = TIMBRES[who] ?? TIMBRES.Narrator;
+  return (ch: string) => {
+    if (!/[a-z0-9]/i.test(ch) || Math.random() < 0.35) return;          // not every letter, not spaces
+    const o = ctx.createOscillator(), g = ctx.createGain(), t = ctx.currentTime;
+    o.type = v.wave;
+    o.frequency.value = v.base + ((ch.toLowerCase().charCodeAt(0) * 37) % v.spread);  // same letter, same pitch
+    g.gain.setValueAtTime(v.gain, t); g.gain.exponentialRampToValueAtTime(0.001, t + 0.06);
+    o.connect(g).connect(out); o.start(t); o.stop(t + 0.07);
+  };
+}
+```
+
+Call the returned function from `say()`'s typing tick with the character just shown.
+
+## Option 2: a platform murmur per speaker (a few credits)
+
+One or two `generate_sound` clips per speaker, a wordless sound with the character's feeling
+("an old man's amused grunt", "a young woman's worried breath, short"), played at the start of each
+of their lines under the typed text. Three speakers, two moods each, is 6 clips, about 12 credits.
+It gives presence without claiming words the clip does not say.
+
+## Option 3: the creator's own text-to-speech (an outside tool)
+
+The creator may own a voice tool: a text-to-speech subscription, an open local model such as
+Piper, or the system's voices. The kit can drive it and record what it made. This is the
+creator's tool on the creator's account: Funpixel neither bills nor meters it, and the licence of
+each voice is the creator's to check before publishing.
+
+| Tool | Where it runs | Licence to check |
+|---|---|---|
+| macOS `say` | the creator's Mac, free | Apple's licence allows the system voices for personal, non-commercial projects: fine for a prototype or a private proof, not for a published game |
+| Piper (open source) | local, free, CPU | each voice model has its own licence; many allow commercial use, some do not |
+| A hosted text-to-speech service on the creator's own key | their account | their plan's terms for games; the price is theirs (a 60-line script is about 3,500 characters) |
+
+The pipeline: the lines file is the source of truth, a script makes one file per line, then every
+file is trimmed and levelled to one loudness so no speaker is louder than another.
+
+```js
+// scripts/voice.mjs — run by the creator: node scripts/voice.mjs [say|piper]. Reads the lines the
+// game already uses (exported as JSON by the build or kept in src/story/lines.json) and writes
+// public/voice/<id>.mp3 plus public/voice/voice.json, the record of what made each file.
+import { execFileSync } from 'node:child_process';
+import { mkdirSync, readFileSync, writeFileSync, existsSync } from 'node:fs';
+
+const tool = process.argv[2] ?? 'say';
+const VOICES = { Ada: 'Samantha', Tomas: 'Daniel', Narrator: 'Moira' };   // per speaker; Piper: a model path
+const lines = JSON.parse(readFileSync('src/story/lines.json', 'utf8'));  // [{ id, who, text }]
+mkdirSync('public/voice', { recursive: true });
+const record = { tool, made_with: tool === 'say' ? 'macOS say (system voices)' : 'Piper', billed_by_funpixel: false, lines: [] };
+for (const l of lines) {
+  const raw = 'public/voice/' + l.id + (tool === 'say' ? '.aiff' : '.wav'), mp3 = 'public/voice/' + l.id + '.mp3';
+  if (tool === 'say') execFileSync('say', ['-v', VOICES[l.who] ?? 'Samantha', '-o', raw, l.text]);
+  else execFileSync('piper', ['--model', VOICES[l.who], '--output_file', raw], { input: l.text });
+  // Trim silence at both ends, level to -16 LUFS (dialogue), mono 64 kbps: about 10 KB a second.
+  execFileSync('ffmpeg', ['-y', '-loglevel', 'error', '-i', raw, '-af',
+    'silenceremove=start_periods=1:start_threshold=-50dB,areverse,silenceremove=start_periods=1:start_threshold=-50dB,areverse,loudnorm=I=-16:TP=-1.5',
+    '-ac', '1', '-b:a', '64k', mp3]);
+  execFileSync('rm', [raw]);
+  record.lines.push({ id: l.id, who: l.who, voice: VOICES[l.who] ?? null, file: mp3.replace('public/', '') });
+}
+writeFileSync('public/voice/voice.json', JSON.stringify(record, null, 2) + '\n');
+console.log(lines.length + ' lines voiced with ' + record.made_with + '; not billed by Funpixel');
+```
+
+Record it where the game's other assets are recorded: a row in the GDD's Art budget with
+`Made how: the creator's own TTS (macOS say)` and `Credits: 0 (outside tool)`, and the tool named
+in the hand-back. The credits screen names only what the game may name (the voice's owner if the
+licence asks for it), never the pipeline behind it.
+
+## Playing a voiced line
+
+The caption is the source of truth; the voice is a layer on it. A line advances when the clip ends
+or when a timeout passes, whichever comes first, so a slow or missing file never holds the game.
+Music dips under the voice and comes back.
+
+```ts
+/** Plays one voiced line under its caption. Resolves on the clip's end, a tap, or the timeout. */
+export async function speak(ctx: AudioContext, out: AudioNode, line: { text: string; voice?: string }, music?: GainNode, cache = new Map<string, AudioBuffer>()): Promise<void> {
+  const timeout = 1500 + line.text.length * 55;                       // reading time plus a margin
+  let buf: AudioBuffer | undefined;
+  if (line.voice) {
+    try {
+      buf = cache.get(line.voice) ?? await Promise.race([
+        fetch(line.voice).then((r) => r.arrayBuffer()).then((b) => ctx.decodeAudioData(b)),
+        new Promise<undefined>((r) => setTimeout(() => r(undefined), 800)),   // late file: go on unvoiced
+      ]);
+      if (buf) cache.set(line.voice, buf);
+    } catch { buf = undefined; }
+  }
+  if (music) music.gain.setTargetAtTime(0.35, ctx.currentTime, 0.08);
+  await new Promise<void>((done) => {
+    const end = () => { clearTimeout(t); removeEventListener('pointerup', end); done(); };
+    const t = setTimeout(end, buf ? Math.min(timeout, buf.duration * 1000 + 400) : timeout);
+    addEventListener('pointerup', end, { once: true });
+    if (buf) { const s = ctx.createBufferSource(); s.buffer = buf; s.connect(out); s.start(); }
+  });
+  if (music) music.gain.setTargetAtTime(1, ctx.currentTime, 0.4);
+}
+```
+
+Load the next chapter's lines while the current one plays, not all at once before the title
+(Silt & Signal fetched 3.9 MB of voice). A game with voice says "Sound on for voices" on the
+title, and keeps working with the phone on silent: captions carry every word.
+
+## Hooks for checks
+
+- `__FPX_STATE__.beat` names the line's beat as it plays (see [story-at-size.md](story-at-size.md)),
+  so `funtools depth` can say which lines play reached.
+- `funtools verify`'s audio check counts starts; a voiced game should show one per line played.
+- The blind player cannot hear. Say in the hand-back which lines are voiced and with what.

package/plugins/codex/skills/funpixel-world-and-story/references/world-kit.md

@@ -0,0 +1,154 @@
+# A world from a kit: scatter, landmarks, the route
+
+Working code, checked in a scratch scaffold on pixi.js 8.21 and three 0.170 (captured and profiled
+at 844×390). Take what helps; change the numbers to the place.
+
+## The kit
+
+Six to twelve pieces in one style carry a whole area. Ways to get them:
+
+| Piece | Tool | Note |
+|---|---|---|
+| 2D props (rock, bush, lamp, crate, fence) | `generate_sprite`, one call per piece with the same style words | a style lock keeps them one family (skill `funpixel-art`) |
+| A state variant (lamp lit/unlit, bridge broken/mended) | `edit_image` on the accepted sprite | the same drawing changed, so the swap reads as the world changing |
+| Ground and paths | `generate_image` texture or strip (`funtools gen texture`) | seamless tiles under the scatter; the scatter hides the grid |
+| Characters that move | `generate_spritesheet` | idle and walk from one base |
+| 3D props | code-built (below), `generate_3d_model`, or `find_material` type `model` (Poly Haven, CC0) | instance anything placed more than a few times |
+| Sky | `generate_skybox`, or a Poly Haven HDRI via `get_material` | the sky sets the time of day and the palette |
+| A set with a plan | `build_level` (skill `funpixel-3d`) | interiors, a village square, anything with doors |
+
+## Scatter by rule
+
+Seeded dart-throwing with spacing: denser at the edges, sparse in the open, a clear route and a
+ring around each landmark, jittered scale, flip and tint. Engine-free.
+
+```ts
+// Dress a place from a kit: seeded, spaced, denser at the edges, the path kept clear.
+// Engine-free: it returns placements; Pixi or Three draws them.
+
+export interface Piece { name: string; radius: number; weight: number; zones?: Zone[] }
+export type Zone = 'edge' | 'field' | 'path-side' | 'landmark';
+export interface Placement { piece: string; x: number; y: number; scale: number; flip: boolean; tint: number; zone: Zone }
+export interface Area {
+  w: number; h: number;
+  /** The walkable route as points; pieces keep `clear` away from it, `path-side` pieces hug it. */
+  path: Array<[number, number]>; clear: number;
+  /** Landmarks already placed (a tower, a tree): scatter leaves a ring around each. */
+  landmarks: Array<{ x: number; y: number; r: number }>;
+}
+
+export function rng(seed: number) {
+  return () => { seed = (seed + 0x6d2b79f5) | 0; let t = Math.imul(seed ^ (seed >>> 15), 1 | seed); t ^= t + Math.imul(t ^ (t >>> 7), 61 | t); return ((t ^ (t >>> 14)) >>> 0) / 4294967296; };
+}
+
+const distToPath = (x: number, y: number, path: Area['path']) => {
+  let best = Infinity;
+  for (let i = 1; i < path.length; i++) {
+    const [ax, ay] = path[i - 1], [bx, by] = path[i], dx = bx - ax, dy = by - ay;
+    const k = Math.max(0, Math.min(1, ((x - ax) * dx + (y - ay) * dy) / (dx * dx + dy * dy || 1)));
+    best = Math.min(best, Math.hypot(x - ax - k * dx, y - ay - k * dy));
+  }
+  return best;
+};
+
+/** Where a point sits: near an edge, beside the path, or in the open field. */
+function zoneOf(x: number, y: number, a: Area): Zone | null {
+  const d = distToPath(x, y, a.path);
+  if (d < a.clear) return null;                                  // the route stays readable
+  if (a.landmarks.some((l) => Math.hypot(x - l.x, y - l.y) < l.r)) return null; // landmarks breathe
+  if (d < a.clear * 1.8) return 'path-side';
+  const edge = Math.min(x, y, a.w - x, a.h - y);
+  return edge < Math.min(a.w, a.h) * 0.14 ? 'edge' : 'field';
+}
+
+/** Dart-throwing with spacing: `tries` candidates, each kept only if no neighbour is closer than the sum of radii. */
+export function scatter(kit: Piece[], a: Area, seed: number, tries = 1500, density: Record<Zone, number> = { edge: 1, 'path-side': 0.6, field: 0.25, landmark: 0 }): Placement[] {
+  const r = rng(seed), out: Placement[] = [], total = kit.reduce((s, p) => s + p.weight, 0);
+  for (let i = 0; i < tries; i++) {
+    const x = r() * a.w, y = r() * a.h, zone = zoneOf(x, y, a);
+    if (!zone || r() > density[zone]) continue;
+    let pick = r() * total, piece = kit[0];
+    for (const p of kit) { pick -= p.weight; if (pick <= 0) { piece = p; break; } }
+    if (piece.zones && !piece.zones.includes(zone)) continue;
+    const scale = 0.8 + r() * 0.45;
+    if (out.some((o) => Math.hypot(o.x - x, o.y - y) < (kit.find((k) => k.name === o.piece)!.radius * o.scale + piece.radius * scale) * 0.9)) continue;
+    const warm = Math.round(235 + r() * 20);                     // a small tint jitter breaks the copy-paste look
+    out.push({ piece: piece.name, x, y, scale, flip: r() < 0.5, tint: (warm << 16) | (Math.round(240 + r() * 15) << 8) | 235, zone });
+  }
+  return out.sort((p, q) => p.y - q.y);                          // back to front for a 2D side or top view
+}
+```
+
+Pixi: draw the placements back to front (they come sorted by y), with the flip and tint.
+
+```ts
+for (const p of scatter(KIT, { w, h, path, clear: 30, landmarks: [tower] }, 42)) {
+  const s = new Sprite({ texture: kitTextures[p.piece], anchor: { x: 0.5, y: 1 } });
+  s.position.set(p.x, p.y); s.scale.set(p.flip ? -p.scale : p.scale, p.scale); s.tint = p.tint;
+  world.addChild(s);
+}
+```
+
+Measured in the lab: about 280 pieces on an 844×390 view drew in 3 draw calls (Pixi batches
+sprites and graphics that share a texture), JS work under 0.5 ms a frame. Put every kit piece on
+one atlas (`npx @funpixel/tools optimize pack-atlas`) so they keep batching.
+
+Three: one `InstancedMesh` per piece kind, so a few hundred props cost a few draw calls.
+
+```ts
+/** Scatter on the XZ plane (area units = metres), one draw call per piece kind. */
+export function dressGround(scene: THREE.Scene, size: number, path: Array<[number, number]>, landmark: THREE.Vector3, seed: number) {
+  const toArea = (x: number, z: number): [number, number] => [x + size / 2, z + size / 2];
+  const placed = scatter(KIT, { w: size, h: size, path: path.map(([x, z]) => toArea(x, z)), clear: 1.6, landmarks: [{ x: landmark.x + size / 2, y: landmark.z + size / 2, r: 4 }] }, seed, 4000);
+  const m = new THREE.Matrix4(), q = new THREE.Quaternion();
+  for (const piece of KIT) {
+    const mine = placed.filter((p) => p.piece === piece.name);
+    const [geo, mat] = GEO[piece.name];
+    const mesh = new THREE.InstancedMesh(geo, mat, mine.length);
+    mesh.name = 'kit-' + piece.name;
+    mine.forEach((p, i) => {
+      q.setFromAxisAngle(new THREE.Vector3(0, 1, 0), (p.x * 13.7) % (Math.PI * 2));
+      mesh.setMatrixAt(i, m.compose(new THREE.Vector3(p.x - size / 2, 0, p.y - size / 2), q, new THREE.Vector3(p.scale, p.scale, p.scale)));
+      mesh.setColorAt(i, new THREE.Color(p.tint));
+    });
+    scene.add(mesh);
+  }
+  return placed.length;
+}
+```
+
+Measured in the lab: 621 instances across the kit and trees, 16 draw calls, 17,640 triangles.
+
+## Landmarks and the route
+
+- One landmark tall enough to see from most of the map, with its own silhouette and light (a
+  tower, a great tree). Place it first; the scatter leaves room around it.
+- The route is the brightest, least cluttered band. In 2D a path texture or a stroked spline
+  (`Graphics.stroke({ width, cap: 'round', join: 'round' })`); in 3D a lighter ground strip.
+- Two or three districts, each with one colour and one material: the orchard is warm and round,
+  the quarry grey and angular. A player should know where they are from one frame.
+- Depth in 2D: two or three parallax layers (far hills move at 0.2–0.4 of the camera, near props
+  at 1.0), the far ones lighter and bluer; in 3D, fog in the sky's colour (skill `funpixel-art`).
+
+## Contact and life
+
+- A soft shadow under anything standing on the ground (a blurred dark ellipse in 2D; a blob
+  texture or a shadow map in 3D) glues it to the place.
+- Small ambient motion sells a place: grass sway (a sine on rotation with a per-piece phase),
+  drifting particles (pollen, fireflies, dust), water shimmer, smoke. Keep it low contrast so the
+  player and threats stay the clearest things on screen. Respect `prefers-reduced-motion`.
+- Wildlife that reacts (birds that lift off as you pass) is cheap and reads as a living world.
+
+## A minimap, cheaply
+
+A round mask over a small render of the world's layout: in 2D, draw the route and landmarks into a
+`Graphics` in a corner at 1/20 scale with the player as an arrow; in 3D, a top-down orthographic
+camera into a small `WebGLRenderTarget` shown on a plane, or a 2D canvas that draws the same
+positions. Keep it off the thumbs' zones (skill `funpixel-mobile-ui`).
+
+## Checking a place
+
+- Capture the play view at phone size and ask: can I see the landmark, the route and the goal?
+- `npx @funpixel/tools look --read` for whether the player and threats stand out from the ground.
+- `npx @funpixel/tools profile --views playing` before and after dressing; the draw calls and
+  object count say what the kit costs.

package/plugins/cursor/.cursor-plugin/plugin.json

@@ -0,0 +1,26 @@
+{
+  "name": "fp",
+  "description": "Use Funpixel asset tools, game skills and optional studio workflows in your agent. Build, verify and publish browser games with advisory hooks and project-controlled review.",
+  "version": "0.1.0",
+  "license": "SEE LICENSE IN LICENSE",
+  "author": {
+    "name": "Funpixel"
+  },
+  "homepage": "https://funpixel.ai",
+  "keywords": [
+    "games",
+    "gamedev",
+    "pixi",
+    "threejs",
+    "funpixel"
+  ],
+  "variables": {
+    "type": "object",
+    "properties": {
+      "FUNPIXEL_API_KEY": {
+        "type": "string",
+        "title": "Funpixel API key (fp_live_…)"
+      }
+    }
+  }
+}

package/plugins/cursor/LICENSE

@@ -0,0 +1,115 @@
+Funpixel GDK and funtools (@funpixel/tools)
+
+Required Notice: Copyright 2026 Funpixel (https://funpixel.ai)
+
+These files are licensed under the PolyForm Shield License 1.0.0, below, together with the
+additional permission that follows.
+
+## Additional Permission: Making Games
+
+In addition to the permissions in the license below, the licensor grants you permission to use the
+software, and to make changes and new works based on it, to make, test, publish, sell and run your
+own games and other playable works, whether or not you charge for them. The games you make are yours:
+this license does not reach a game's own code, art, sound, text or other content, or what you earn
+from it, and a game you make is not a product that competes with the licensor's, wherever you
+publish it.
+
+This permission does not cover providing the software, or a product or service based on it, that
+lets others make games (a game-making tool, kit, platform or service). That remains subject to the
+Noncompete section of the license below.
+
+The parts of this package under other licenses keep them: see NOTICE (the bundled devtools, MIT)
+and bench/LICENSE (the Blender bench scripts, GPL-3.0-or-later) where present, and
+THIRD_PARTY_NOTICES.md for the GDK.
+
+---
+
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing any product that competes with the software or any product the licensor or any of its affiliates provides using the software.
+
+## Competition
+
+Goods and services compete even when they provide functionality through different kinds of interfaces or for different technical platforms.  Applications can compete with services, libraries with plugins, frameworks with development tools, and so on, even if they're written in different programming languages or for different computer architectures.  Goods and services compete even when provided free of charge.  If you market a product as a practical substitute for the software or another product, it definitely competes.
+
+## New Products
+
+If you are using the software to provide a product that does not compete, but the licensor or any of its affiliates brings your product into competition by providing a new version of the software or another product using the software, you may continue using versions of the software available under these terms beforehand to provide your competing product, but not any later versions.
+
+## Discontinued Products
+
+You may begin using the software to compete with a product or service that the licensor or any of its affiliates has stopped providing, unless the licensor includes a plain-text line beginning with `Licensor Line of Business:` with the software that mentions that line of business.  For example:
+
+> Licensor Line of Business: YoyodyneCMS Content Management System (http://example.com/cms)
+
+## Sales of Business
+
+If the licensor or any of its affiliates sells a line of business developing the software or using the software to provide a product, the buyer can also enforce [Noncompete](#noncompete) for that product.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+A **product** can be a good or service, or a combination of them.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all its affiliates.
+
+**Affiliates** means the other organizations than an organization has control over, is under the control of, or is under common control with.
+
+**Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/plugins/cursor/README.md

@@ -0,0 +1,13 @@
+# Funpixel GDK for Cursor
+
+Use Funpixel asset tools, game skills and optional studio workflows in your agent. Build, verify and publish browser games with advisory hooks and project-controlled review.
+
+Install from the Cursor marketplace, or copy this folder to `~/.cursor/plugins/local/fp`. Set the `FUNPIXEL_API_KEY` plugin variable.
+
+MCP only, one click: [Add Funpixel MCP to Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=funpixel&config=eyJ1cmwiOiJodHRwczovL2FwaS5mdW5waXhlbC5haS9tY3AiLCJoZWFkZXJzIjp7IkF1dGhvcml6YXRpb24iOiJCZWFyZXIgJHtlbnY6RlVOUElYRUxfQVBJX0tFWX0ifX0=) (reads `FUNPIXEL_API_KEY` from your environment).
+
+Needs funtools: `npm i -g @funpixel/tools` (the kit's CLI; `npx @funpixel/tools …` works too). Then start a game with `/new` "<the game in one line>": the agent briefs it back, makes the key art and a first playable you steer in the chat, plans the whole game around it with you, and builds it round after round with the game open beside the chat.
+
+Commands: `/first-look`, `/flow`, `/lanes`, `/mobile-qa`, `/new`, `/playtest`, `/publish`, `/smoke-build`, `/verify`.
+
+This folder is built from Funpixel's source and published as is: changes made here are replaced by the next release.