@pix3/cli 1.6.0

package/templates/recipe-tapper-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-tapper-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-targets` + `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/target.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;
+    }
+  }
+}

package/templates/recipe-tapper-2d/files/scripts/TouchRules.ts

@@ -0,0 +1,192 @@
+/**
+ * TouchRules — turns a tap into meaning.
+ *
+ * Same role (and the same `rules` format) as in the other recipes; only the
+ * source of the contact differs. Here a pointer-down is hit-tested against the
+ * `core:Hitbox2D` groups listed in `rules` and the topmost match resolves.
+ *
+ * It emits the same semantic signals every recipe uses, on `game-root`:
+ *   `touch-scored`  (amount, x, y)
+ *   `touch-damaged` (amount, x, y)
+ *
+ * `rules` format: `group:outcome:amount`, entries separated by `;`.
+ * A tap that hits nothing can be punished too — see `missPenalty`.
+ */
+import { Script, type PropertySchema } from '@pix3/runtime';
+
+type TouchOutcome = 'score' | 'damage';
+
+interface TouchRule {
+  group: string;
+  outcome: TouchOutcome;
+  amount: number;
+}
+
+function parseRules(text: string): TouchRule[] {
+  const rules: TouchRule[] = [];
+  for (const entry of text.split(';')) {
+    const parts = entry.trim().split(':');
+    if (parts.length < 2 || !parts[0].trim()) {
+      continue;
+    }
+    const amount = Number(parts[2] ?? 1);
+    rules.push({
+      group: parts[0].trim(),
+      outcome: parts[1].trim() === 'damage' ? 'damage' : 'score',
+      amount: Number.isFinite(amount) && amount > 0 ? amount : 1,
+    });
+  }
+  return rules;
+}
+
+export class TouchRules extends Script {
+  constructor(id: string, type: string) {
+    super(id, type);
+    this.config = {
+      // group:outcome:amount pairs, separated by ';'.
+      rules: 'target:score:1;hazard:damage:1',
+      // 0 = exact point test; larger = a more forgiving finger.
+      tapRadius: 40,
+      // Free the tapped node after resolving it.
+      consume: true,
+      // Damage dealt by a tap that hits nothing (0 = free misses).
+      missPenalty: 0,
+      scoreSound: '',
+      damageSound: '',
+    };
+  }
+
+  static getPropertySchema(): PropertySchema {
+    const num = (name: string, label: string, min: number, max: number, step: number) => ({
+      name,
+      type: 'number' as const,
+      ui: { label, group: 'Contact', min, max, step, slider: true },
+      getValue: (s: unknown) => (s as TouchRules).config[name],
+      setValue: (s: unknown, v: unknown) => {
+        const n = Number(v);
+        (s as TouchRules).config[name] = Math.min(max, Math.max(min, Number.isFinite(n) ? n : min));
+      },
+    });
+    const str = (name: string, label: string, group: string, editor?: 'audio-resource') => ({
+      name,
+      type: 'string' as const,
+      ui: { label, group, editor },
+      getValue: (s: unknown) => (s as TouchRules).config[name],
+      setValue: (s: unknown, v: unknown) => {
+        (s as TouchRules).config[name] = typeof v === 'string' ? v : '';
+      },
+    });
+
+    return {
+      nodeType: 'TouchRules',
+      properties: [
+        str('rules', 'Rules', 'Contact'),
+        num('tapRadius', 'Tap Radius', 0, 400, 1),
+        num('missPenalty', 'Miss Penalty', 0, 10, 1),
+        {
+          name: 'consume',
+          type: 'boolean',
+          ui: { label: 'Consume On Tap', group: 'Contact' },
+          getValue: s => (s as TouchRules).config.consume,
+          setValue: (s, v) => {
+            (s as TouchRules).config.consume = Boolean(v);
+          },
+        },
+        str('scoreSound', 'Score Sound', 'Feedback', 'audio-resource'),
+        str('damageSound', 'Damage Sound', 'Feedback', 'audio-resource'),
+      ],
+      groups: {
+        Contact: { label: 'Contact', expanded: true },
+        Feedback: { label: 'Feedback', expanded: false },
+      },
+    };
+  }
+
+  /**
+   * Every finger that landed this frame resolves on its own.
+   *
+   * Both halves of that are addressed on purpose. The UI gate asks whether **this** finger is over
+   * a control, not whether *any* control is hovered — the aggregate meant a thumb parked on a HUD
+   * button silently swallowed taps made with the other hand. And the contact point comes from the
+   * finger that produced the event, not from the shared pointer position, which under multi-touch
+   * describes only the oldest finger.
+   */
+  onUpdate(): void {
+    const input = this.input;
+    if (!this.scene || !this.node || !input) {
+      return;
+    }
+    for (const event of input.pointerEvents) {
+      if (event.type !== 'down') {
+        continue;
+      }
+      // With nothing in the addressed map — a harness driving the game by assigning input fields —
+      // there is no per-pointer hover to read, so the aggregate is all there is.
+      const overUI =
+        input.pointerDownCount > 0 ? input.isPointerOverUI(event.pointerId) : input.isHoveringUI;
+      if (overUI) {
+        continue;
+      }
+      this.resolveTap(event.pointerId);
+    }
+  }
+
+  /**
+   * Resolve one contact: the topmost rule match wins, and a tap that hits nothing may be punished.
+   */
+  private resolveTap(pointerId: number): void {
+    const scene = this.scene;
+    const owner = this.node;
+    if (!scene || !owner) {
+      return;
+    }
+    // A tap that went down and up inside one frame is already out of the pointer map by the time
+    // scripts run, so the addressed lookup misses; the shared position still holds where it landed.
+    const pointer =
+      scene.getPointer2DWorldPosition(pointerId) ?? scene.getPointer2DWorldPosition();
+    if (!pointer) {
+      return;
+    }
+
+    const radius = Math.max(0, Number(this.config.tapRadius) || 0);
+    const consume = Boolean(this.config.consume);
+
+    for (const rule of parseRules(String(this.config.rules ?? ''))) {
+      const hits =
+        radius > 0
+          ? scene.collision2d.overlapCircle(pointer.x, pointer.y, radius, rule.group)
+          : scene.collision2d.overlapPoint(pointer.x, pointer.y, rule.group);
+      // Only the first match resolves: one tap is one action.
+      const hit = hits[0];
+      if (!hit) {
+        continue;
+      }
+      if (rule.outcome === 'damage') {
+        owner.emit('touch-damaged', rule.amount, hit.x, hit.y);
+        scene.juice.flash({ color: '#ff4d6d', intensity: 0.4, durationSec: 0.22 });
+        this.playSound(String(this.config.damageSound ?? ''));
+      } else {
+        owner.emit('touch-scored', rule.amount, hit.x, hit.y);
+        scene.juice.punchScale(hit.node, { amount: 0.3, duration: 0.18 });
+        this.playSound(String(this.config.scoreSound ?? ''));
+      }
+      if (consume) {
+        hit.node.queueFree();
+      }
+      return;
+    }
+
+    const penalty = Math.max(0, Number(this.config.missPenalty) || 0);
+    if (penalty > 0) {
+      owner.emit('touch-damaged', penalty, pointer.x, pointer.y);
+      this.playSound(String(this.config.damageSound ?? ''));
+    }
+  }
+
+  private playSound(path: string): void {
+    if (!path) {
+      return;
+    }
+    void this.scene?.audio.play(path, { bus: 'sfx', pitchVariation: 0.08 });
+  }
+}

package/templates/recipe-tapper-2d/template.yaml

@@ -0,0 +1,10 @@
+id: recipe-tapper-2d
+title: Tapper 2D
+description: Objects fall into the field and tapping them is the whole game — good ones score, one bad type costs a life, and a countdown ends the run. Whack-a-mole, catch-the-falling, clickers.
+projectType: 2d
+targetPlatform: universal
+viewport: { width: 1080, height: 1920 }
+# The build/full-run entry scene (Project Settings → Default Export Scene Path).
+# The menu boots first; PLAY transitions to main.pix3scene (the game).
+entryScene: scenes/menu.pix3scene
+order: 62