@pix3/cli 1.6.0

package/templates/recipe-arena-2d/files/scripts/MenuFlow.ts

@@ -0,0 +1,106 @@
+/**
+ * MenuFlow — drives the menu scene (the project's entry/export scene).
+ *
+ * PLAY transitions to the game scene with a fade. That is all it does: keep the
+ * menu dumb so the game scene stays directly playable on its own (agents and
+ * the editor open `main.pix3scene` and press play without going through here).
+ *
+ * PLAY does not call `startGame()` directly: it dispatches the command
+ * `start-game` (`scene.commands`). A test can then leave the menu without a tap,
+ * every raised intent lands in `scene.commands.log` with its frame, and one real
+ * tap is enough to prove the button is still wired to the intent it claims.
+ *
+ * It registers a debug provider too. `registerGameDebug` is global and
+ * last-wins, and only the running scene's flow script registers one — so
+ * without this, everything a tool reads while the menu is up would come back
+ * empty (or, worse, stale from the previous scene).
+ */
+import { Script, registerGameDebug, type PropertySchema } from '@pix3/runtime';
+
+export class MenuFlow extends Script {
+  private playButtonReady = false;
+  private disposeDebug: (() => void) | null = null;
+  private disposeCommands: (() => void)[] = [];
+
+  constructor(id: string, type: string) {
+    super(id, type);
+    this.config = {
+      gameScene: 'res://scenes/main.pix3scene',
+      playButton: 'play-button',
+    };
+  }
+
+  static getPropertySchema(): PropertySchema {
+    const str = (name: string, label: string) => ({
+      name,
+      type: 'string' as const,
+      ui: { label, group: 'Menu' },
+      getValue: (s: unknown) => (s as MenuFlow).config[name],
+      setValue: (s: unknown, v: unknown) => {
+        (s as MenuFlow).config[name] = typeof v === 'string' ? v : '';
+      },
+    });
+
+    return {
+      nodeType: 'MenuFlow',
+      properties: [str('gameScene', 'Game Scene'), str('playButton', 'Play Button')],
+      groups: { Menu: { label: 'Menu Flow', expanded: true } },
+    };
+  }
+
+  onStart(): void {
+    const commands = this.scene?.commands;
+    this.disposeCommands = [
+      commands?.register('start-game', () => this.startGame(), {
+        description: 'Leave the menu and transition into the game scene.',
+      }),
+    ].filter((dispose): dispose is () => void => dispose !== undefined);
+
+    this.disposeDebug = registerGameDebug({
+      name: 'recipe-arena-2d',
+      version: 1,
+      // The registry IS the action list — never a second, hand-kept copy.
+      actions: () => this.scene?.commands.list().map(command => command.name) ?? [],
+      // `scene` is what tells a reader which flow answered: the game scene's
+      // GameRules publishes under the same name.
+      snapshot: () => ({
+        scene: 'menu',
+        gameScene: String(this.config.gameScene ?? ''),
+        playButtonReady: this.playButtonReady,
+      }),
+    });
+
+    const button = this.findNode(String(this.config.playButton ?? ''));
+    if (!button) {
+      console.warn(`[MenuFlow] Button "${this.config.playButton}" not found.`);
+      return;
+    }
+    this.playButtonReady = true;
+    button.connect('pressed', this, () => {
+      this.scene?.commands.dispatch('start-game');
+    });
+  }
+
+  onDetach(): void {
+    // Safe in any order: the disposer clears the global only while it still
+    // holds *this* provider, so the next scene's registration is never wiped.
+    this.disposeDebug?.();
+    this.disposeDebug = null;
+    // The scene's registry is cleared on stop anyway; this covers the other
+    // case — this script being detached while the scene keeps running.
+    for (const dispose of this.disposeCommands) {
+      dispose();
+    }
+    this.disposeCommands = [];
+    this.playButtonReady = false;
+    super.onDetach();
+  }
+
+  /** Transition into the game scene. */
+  startGame(): void {
+    void this.scene?.changeScene(String(this.config.gameScene ?? ''), {
+      transition: 'fade',
+      durationSec: 0.3,
+    });
+  }
+}

package/templates/recipe-arena-2d/files/scripts/PlayerController.ts

@@ -0,0 +1,151 @@
+/**
+ * PlayerController — steers the avatar inside a bounded field.
+ *
+ * Two locomotion modes, chosen in the inspector:
+ *  - `pointer` — the avatar chases the pointer/finger at `speed` px/s.
+ *  - `keys`    — 8-direction WASD / arrow movement at `speed` px/s.
+ *
+ * The avatar is clamped to `boundsNode` (a Group2D — normally the node it is
+ * parented to) inset by `radius`, so it can never leave the field.
+ *
+ * This file is deliberately the ONLY thing that decides how the avatar moves:
+ * swap it wholesale for a grid stepper, a jumper or an auto-runner and the rest
+ * of the recipe (spawners, touch rules, HUD, win/lose) keeps working unchanged.
+ */
+import { Group2D, Script, type PropertySchema } from '@pix3/runtime';
+
+type LocomotionMode = 'pointer' | 'keys';
+
+export class PlayerController extends Script {
+  constructor(id: string, type: string) {
+    super(id, type);
+    this.config = {
+      // 'pointer' = follow the finger/mouse, 'keys' = 8-direction WASD/arrows.
+      mode: 'pointer',
+      // Movement speed in logical pixels per second.
+      speed: 620,
+      // Collision/inset radius: keeps the avatar fully inside the field.
+      radius: 56,
+      // Node id/name of the Group2D whose rect bounds the avatar.
+      boundsNode: 'board',
+      // Pointer mode only: stop chasing once this close (px) to avoid jitter.
+      deadZone: 4,
+    };
+  }
+
+  static getPropertySchema(): PropertySchema {
+    const numberProp = (name: string, label: string, min: number, max: number, step = 1) => ({
+      name,
+      type: 'number' as const,
+      ui: { label, group: 'Movement', min, max, step, slider: true },
+      getValue: (s: unknown) => (s as PlayerController).config[name],
+      setValue: (s: unknown, v: unknown) => {
+        const n = Number(v);
+        (s as PlayerController).config[name] = Math.min(max, Math.max(min, Number.isFinite(n) ? n : min));
+      },
+    });
+
+    return {
+      nodeType: 'PlayerController',
+      properties: [
+        {
+          name: 'mode',
+          type: 'select',
+          ui: {
+            label: 'Mode',
+            description: 'pointer = follow the finger, keys = 8-direction WASD/arrows',
+            group: 'Movement',
+            options: ['pointer', 'keys'],
+          },
+          getValue: s => (s as PlayerController).config.mode,
+          setValue: (s, v) => {
+            (s as PlayerController).config.mode = v === 'keys' ? 'keys' : 'pointer';
+          },
+        },
+        numberProp('speed', 'Speed (px/s)', 60, 2000, 10),
+        numberProp('radius', 'Radius', 4, 400, 1),
+        numberProp('deadZone', 'Dead Zone', 0, 60, 1),
+        {
+          name: 'boundsNode',
+          type: 'string',
+          ui: { label: 'Bounds Node', group: 'Movement' },
+          getValue: s => (s as PlayerController).config.boundsNode,
+          setValue: (s, v) => {
+            (s as PlayerController).config.boundsNode = typeof v === 'string' ? v : '';
+          },
+        },
+      ],
+      groups: { Movement: { label: 'Movement', expanded: true } },
+    };
+  }
+
+  onUpdate(dt: number): void {
+    const node = this.node;
+    if (!node || dt <= 0) {
+      return;
+    }
+    const speed = Math.max(0, Number(this.config.speed) || 0);
+    const mode: LocomotionMode = this.config.mode === 'keys' ? 'keys' : 'pointer';
+
+    if (mode === 'keys') {
+      const ax = (this.held('Key_ArrowRight', 'Key_D') ? 1 : 0) - (this.held('Key_ArrowLeft', 'Key_A') ? 1 : 0);
+      const ay = (this.held('Key_ArrowUp', 'Key_W') ? 1 : 0) - (this.held('Key_ArrowDown', 'Key_S') ? 1 : 0);
+      const len = Math.hypot(ax, ay);
+      if (len > 0) {
+        node.position.x += (ax / len) * speed * dt;
+        node.position.y += (ay / len) * speed * dt;
+      }
+    } else {
+      const pointer = this.scene?.getPointer2DWorldPosition() ?? null;
+      if (pointer) {
+        const target = this.worldToParent(pointer.x, pointer.y);
+        const dx = target.x - node.position.x;
+        const dy = target.y - node.position.y;
+        const dist = Math.hypot(dx, dy);
+        const deadZone = Math.max(0, Number(this.config.deadZone) || 0);
+        if (dist > deadZone) {
+          const step = Math.min(dist, speed * dt);
+          node.position.x += (dx / dist) * step;
+          node.position.y += (dy / dist) * step;
+        }
+      }
+    }
+
+    this.clampToBounds();
+  }
+
+  private held(...buttons: string[]): boolean {
+    return buttons.some(name => this.input?.getButton(name) ?? false);
+  }
+
+  /** Convert a 2D world point into the coordinate space of this node's parent. */
+  private worldToParent(wx: number, wy: number): { x: number; y: number } {
+    const parent = this.node?.parentNode ?? null;
+    if (!parent) {
+      return { x: wx, y: wy };
+    }
+    parent.updateWorldMatrix(true, false);
+    const e = parent.matrixWorld.elements;
+    const dx = wx - e[12];
+    const dy = wy - e[13];
+    const det = e[0] * e[5] - e[1] * e[4];
+    if (Math.abs(det) < 1e-8) {
+      return { x: dx, y: dy };
+    }
+    return { x: (e[5] * dx - e[4] * dy) / det, y: (e[0] * dy - e[1] * dx) / det };
+  }
+
+  /** Keep the avatar inside the bounds node's rect, inset by `radius`. */
+  private clampToBounds(): void {
+    const node = this.node;
+    const bounds = this.findNode(String(this.config.boundsNode ?? ''));
+    if (!node || !(bounds instanceof Group2D)) {
+      return;
+    }
+    const radius = Math.max(0, Number(this.config.radius) || 0);
+    const halfW = Math.max(0, bounds.width / 2 - radius);
+    const halfH = Math.max(0, bounds.height / 2 - radius);
+    node.position.x = Math.min(halfW, Math.max(-halfW, node.position.x));
+    node.position.y = Math.min(halfH, Math.max(-halfH, node.position.y));
+  }
+}

package/templates/recipe-arena-2d/files/scripts/ScoreHud.ts

@@ -0,0 +1,94 @@
+/**
+ * ScoreHud — signal-driven HUD. Display only, no game logic.
+ *
+ * Listens on `sourceNode` (the node carrying `GameRules`) for:
+ *   `score-changed` (score)
+ *   `lives-changed` (lives, maxLives)
+ *   `time-changed`  (seconds)
+ *
+ * If a HUD widget is missing from the scene it is quietly skipped, so you can
+ * delete the timer or the lives bar without touching any script.
+ */
+import { Bar2D, Label2D, Script, type PropertySchema } from '@pix3/runtime';
+
+export class ScoreHud extends Script {
+  constructor(id: string, type: string) {
+    super(id, type);
+    this.config = {
+      // Node that emits the HUD signals (the GameRules host).
+      sourceNode: 'game-root',
+      scoreLabel: 'score-label',
+      scoreFormat: 'SCORE {value}',
+      timeLabel: 'time-label',
+      timeFormat: '{value}',
+      livesBar: 'lives-bar',
+    };
+  }
+
+  static getPropertySchema(): PropertySchema {
+    const str = (name: string, label: string, description?: string) => ({
+      name,
+      type: 'string' as const,
+      ui: { label, group: 'HUD', description },
+      getValue: (s: unknown) => (s as ScoreHud).config[name],
+      setValue: (s: unknown, v: unknown) => {
+        (s as ScoreHud).config[name] = typeof v === 'string' ? v : '';
+      },
+    });
+
+    return {
+      nodeType: 'ScoreHud',
+      properties: [
+        str('sourceNode', 'Source Node', 'Node that emits score-changed / lives-changed / time-changed'),
+        str('scoreLabel', 'Score Label'),
+        str('scoreFormat', 'Score Format', '{value} is replaced by the score'),
+        str('timeLabel', 'Time Label'),
+        str('timeFormat', 'Time Format', '{value} is replaced by whole seconds'),
+        str('livesBar', 'Lives Bar'),
+      ],
+      groups: { HUD: { label: 'HUD', expanded: true } },
+    };
+  }
+
+  onStart(): void {
+    const source = this.findNode(String(this.config.sourceNode ?? ''));
+    if (!source) {
+      console.warn(`[ScoreHud] Source node "${this.config.sourceNode}" not found.`);
+      return;
+    }
+    source.connect('score-changed', this, (...args: unknown[]) => this.setScore(Number(args[0]) || 0));
+    source.connect('time-changed', this, (...args: unknown[]) => this.setTime(Number(args[0]) || 0));
+    source.connect('lives-changed', this, (...args: unknown[]) =>
+      this.setLives(Number(args[0]) || 0, Number(args[1]) || 0)
+    );
+    // Ask for the opening values now that the listeners are live: GameRules
+    // starts before this HUD (parent components tick before children).
+    source.emit('hud-ready');
+  }
+
+  private setScore(score: number): void {
+    const label = this.findNode(String(this.config.scoreLabel ?? ''));
+    if (label instanceof Label2D) {
+      label.setText(String(this.config.scoreFormat ?? '{value}').replace('{value}', String(Math.round(score))));
+    }
+  }
+
+  private setTime(seconds: number): void {
+    const label = this.findNode(String(this.config.timeLabel ?? ''));
+    if (label instanceof Label2D) {
+      label.setText(
+        String(this.config.timeFormat ?? '{value}').replace('{value}', String(Math.max(0, Math.ceil(seconds))))
+      );
+    }
+  }
+
+  private setLives(lives: number, maxLives: number): void {
+    const bar = this.findNode(String(this.config.livesBar ?? ''));
+    if (bar instanceof Bar2D) {
+      if (maxLives > 0) {
+        bar.maxValue = maxLives;
+      }
+      bar.setValue(lives);
+    }
+  }
+}

package/templates/recipe-arena-2d/files/scripts/Spawner.ts

@@ -0,0 +1,214 @@
+/**
+ * Spawner — drops prefab instances into the field on a timer.
+ *
+ * One spawner = one kind of thing. Put a second Spawner on a second node for a
+ * second kind (the recipe ships `spawner-pickups` + `spawner-hazards`).
+ *
+ * It owns the whole life of what it spawns: pick a random point in the spawn
+ * rect (optionally grid-snapped), instantiate the prefab under `parentNode`,
+ * drift it every frame, and `queueFree` it when its lifetime runs out or it
+ * leaves `despawnRadius`. What a spawned thing DOES on contact is not its
+ * business — that is `TouchRules` reading the prefab's `core:Hitbox2D` group.
+ */
+import { Script, type NodeBase, type PropertySchema } from '@pix3/runtime';
+
+interface SpawnedEntry {
+  node: NodeBase;
+  ttl: number;
+}
+
+/** World point → the coordinate space of `node` (2×2 inverse of its world basis). */
+function worldToLocal2D(node: NodeBase, wx: number, wy: number): { x: number; y: number } {
+  node.updateWorldMatrix(true, false);
+  const e = node.matrixWorld.elements;
+  const dx = wx - e[12];
+  const dy = wy - e[13];
+  const det = e[0] * e[5] - e[1] * e[4];
+  if (Math.abs(det) < 1e-8) {
+    return { x: dx, y: dy };
+  }
+  return { x: (e[5] * dx - e[4] * dy) / det, y: (e[0] * dy - e[1] * dx) / det };
+}
+
+/** Local point in `node`'s space → 2D world. */
+function localToWorld2D(node: NodeBase, lx: number, ly: number): { x: number; y: number } {
+  node.updateWorldMatrix(true, false);
+  const e = node.matrixWorld.elements;
+  return { x: e[0] * lx + e[4] * ly + e[12], y: e[1] * lx + e[5] * ly + e[13] };
+}
+
+export class Spawner extends Script {
+  private alive: SpawnedEntry[] = [];
+  private cooldown = 0;
+  private pending = 0;
+
+  constructor(id: string, type: string) {
+    super(id, type);
+    this.config = {
+      // Prefab (.pix3scene with exactly one root node) to instantiate.
+      prefab: 'res://scenes/prefabs/pickup.pix3scene',
+      // Node id/name the instances are parented to. Empty = this spawner node.
+      parentNode: '',
+      // Seconds between spawns, plus a random 0..jitter extra.
+      intervalSec: 1.1,
+      intervalJitter: 0.35,
+      // Hard cap on simultaneously alive instances from THIS spawner.
+      maxAlive: 10,
+      // Spawn rect (centred on this node), in logical pixels.
+      spawnWidth: 860,
+      spawnHeight: 60,
+      // Snap spawn coordinates to a grid of this size (0 = free placement).
+      gridSnap: 0,
+      // Constant per-second drift applied to every live instance.
+      driftX: 0,
+      driftY: -300,
+      // Seconds an instance lives (0 = until it leaves despawnRadius).
+      lifetimeSec: 7,
+      // Distance from this node beyond which an instance is freed.
+      despawnRadius: 1800,
+      // Delay before the first spawn.
+      startDelaySec: 0.4,
+    };
+  }
+
+  static getPropertySchema(): PropertySchema {
+    const num = (name: string, label: string, min: number, max: number, step: number, group: string) => ({
+      name,
+      type: 'number' as const,
+      ui: { label, group, min, max, step, slider: true },
+      getValue: (s: unknown) => (s as Spawner).config[name],
+      setValue: (s: unknown, v: unknown) => {
+        const n = Number(v);
+        (s as Spawner).config[name] = Math.min(max, Math.max(min, Number.isFinite(n) ? n : min));
+      },
+    });
+    const str = (name: string, label: string) => ({
+      name,
+      type: 'string' as const,
+      ui: { label, group: 'Source' },
+      getValue: (s: unknown) => (s as Spawner).config[name],
+      setValue: (s: unknown, v: unknown) => {
+        (s as Spawner).config[name] = typeof v === 'string' ? v : '';
+      },
+    });
+
+    return {
+      nodeType: 'Spawner',
+      properties: [
+        str('prefab', 'Prefab'),
+        str('parentNode', 'Parent Node'),
+        num('intervalSec', 'Interval (s)', 0.05, 20, 0.05, 'Rate'),
+        num('intervalJitter', 'Interval Jitter (s)', 0, 10, 0.05, 'Rate'),
+        num('maxAlive', 'Max Alive', 1, 200, 1, 'Rate'),
+        num('startDelaySec', 'Start Delay (s)', 0, 20, 0.1, 'Rate'),
+        num('spawnWidth', 'Spawn Width', 0, 4000, 10, 'Placement'),
+        num('spawnHeight', 'Spawn Height', 0, 4000, 10, 'Placement'),
+        num('gridSnap', 'Grid Snap', 0, 500, 1, 'Placement'),
+        num('driftX', 'Drift X (px/s)', -3000, 3000, 10, 'Motion'),
+        num('driftY', 'Drift Y (px/s)', -3000, 3000, 10, 'Motion'),
+        num('lifetimeSec', 'Lifetime (s)', 0, 120, 0.5, 'Motion'),
+        num('despawnRadius', 'Despawn Radius', 100, 8000, 50, 'Motion'),
+      ],
+      groups: {
+        Source: { label: 'Source', expanded: true },
+        Rate: { label: 'Rate', expanded: true },
+        Placement: { label: 'Placement', expanded: true },
+        Motion: { label: 'Motion', expanded: true },
+      },
+    };
+  }
+
+  onStart(): void {
+    this.cooldown = Math.max(0, Number(this.config.startDelaySec) || 0);
+  }
+
+  onUpdate(dt: number): void {
+    this.driftAndExpire(dt);
+
+    this.cooldown -= dt;
+    if (this.cooldown > 0) {
+      return;
+    }
+    const interval = Math.max(0.05, Number(this.config.intervalSec) || 0.05);
+    const jitter = Math.max(0, Number(this.config.intervalJitter) || 0);
+    this.cooldown = interval + Math.random() * jitter;
+
+    const maxAlive = Math.max(1, Number(this.config.maxAlive) || 1);
+    if (this.alive.length + this.pending < maxAlive) {
+      void this.spawnOne();
+    }
+  }
+
+  /** Free everything this spawner currently owns (e.g. on a restart). */
+  clear(): void {
+    for (const entry of this.alive) {
+      entry.node.queueFree();
+    }
+    this.alive = [];
+  }
+
+  private driftAndExpire(dt: number): void {
+    const dx = (Number(this.config.driftX) || 0) * dt;
+    const dy = (Number(this.config.driftY) || 0) * dt;
+    const lifetime = Math.max(0, Number(this.config.lifetimeSec) || 0);
+    const despawn = Math.max(1, Number(this.config.despawnRadius) || 1);
+    const survivors: SpawnedEntry[] = [];
+
+    for (const entry of this.alive) {
+      if (!entry.node.parent) {
+        continue; // already freed elsewhere (TouchRules consumed it)
+      }
+      entry.node.position.x += dx;
+      entry.node.position.y += dy;
+      entry.ttl -= dt;
+
+      const world = localToWorld2D(entry.node, 0, 0);
+      const here = worldToLocal2D(this.node ?? entry.node, world.x, world.y);
+      const outOfRange = Math.abs(here.x) > despawn || Math.abs(here.y) > despawn;
+      if (outOfRange || (lifetime > 0 && entry.ttl <= 0)) {
+        entry.node.queueFree();
+        continue;
+      }
+      survivors.push(entry);
+    }
+    this.alive = survivors;
+  }
+
+  private async spawnOne(): Promise<void> {
+    const scene = this.scene;
+    const owner = this.node;
+    const prefab = String(this.config.prefab ?? '');
+    if (!scene || !owner || !prefab) {
+      return;
+    }
+    const parentQuery = String(this.config.parentNode ?? '');
+    const parent = parentQuery ? this.findNode(parentQuery) : owner;
+    if (!parent) {
+      console.warn(`[Spawner] Parent "${parentQuery}" not found.`);
+      return;
+    }
+
+    const snap = Math.max(0, Number(this.config.gridSnap) || 0);
+    const halfW = Math.max(0, Number(this.config.spawnWidth) || 0) / 2;
+    const halfH = Math.max(0, Number(this.config.spawnHeight) || 0) / 2;
+    let localX = (Math.random() * 2 - 1) * halfW;
+    let localY = (Math.random() * 2 - 1) * halfH;
+    if (snap > 0) {
+      localX = Math.round(localX / snap) * snap;
+      localY = Math.round(localY / snap) * snap;
+    }
+    const world = localToWorld2D(owner, localX, localY);
+
+    this.pending += 1;
+    try {
+      const node = await scene.instantiate(prefab, { parent });
+      const local = worldToLocal2D(parent, world.x, world.y);
+      node.position.set(local.x, local.y, node.position.z);
+      this.alive.push({ node, ttl: Math.max(0, Number(this.config.lifetimeSec) || 0) });
+    } catch (error) {
+      console.warn(`[Spawner] Failed to spawn "${prefab}":`, error);
+    } finally {
+      this.pending -= 1;
+    }
+  }
+}