@pix3/cli 1.6.3 → 2.0.0-alpha.0

package/templates/recipe-arena-2d/files/scenes/menu.pix3scene

@@ -1,100 +0,0 @@
-# Pix3 Scene File (YAML)
-# Arena 2D — the MENU scene. This is the project's ENTRY / export scene
-# (Project Settings → Default Export Scene Path): a full build and "Play Game (Entry Scene)"
-# boot here. PLAY transitions to the game scene (main.pix3scene) via a fade.
-# Wired by scripts/MenuFlow.ts. Iterate on the GAME in main.pix3scene.
-version: 1.0.0
-metadata:
-  author: Pix3 Recipe
-  description: Menu scene — entry point; PLAY transitions to the game
-root:
-  - id: menu-root
-    type: Group2D
-    name: Menu Root
-    properties:
-      width: 1080
-      height: 1920
-      layout:
-        enabled: true
-        horizontalAlign: stretch
-        verticalAlign: stretch
-    components:
-      - id: menu-flow
-        type: user:MenuFlow
-        enabled: true
-        config:
-          gameScene: res://scenes/main.pix3scene
-          playButton: play-button
-    children:
-      - id: menu-background
-        type: ColorRect2D
-        name: Menu Background
-        properties:
-          width: 1080
-          height: 1920
-          color: "#141a2e"
-          transform:
-            position: [0, 0]
-            scale: [1, 1]
-            rotation: 0
-          layout:
-            enabled: true
-            horizontalAlign: stretch
-            verticalAlign: stretch
-        children: []
-      - id: title-label
-        type: Label2D
-        name: Title Label
-        properties:
-          label: "{{PROJECT_NAME}}"
-          labelFontSize: 96
-          labelColor: "#ffffff"
-          labelAlign: center
-          transform:
-            position: [0, 420]
-            scale: [1, 1]
-            rotation: 0
-          layout:
-            enabled: true
-            horizontalAlign: center
-            verticalAlign: center
-        children: []
-      - id: subtitle-label
-        type: Label2D
-        name: Subtitle Label
-        properties:
-          label: "COLLECT. DODGE. SURVIVE."
-          labelFontSize: 40
-          labelColor: "#93a3c9"
-          labelAlign: center
-          transform:
-            position: [0, 300]
-            scale: [1, 1]
-            rotation: 0
-          layout:
-            enabled: true
-            horizontalAlign: center
-            verticalAlign: center
-        children: []
-      - id: play-button
-        type: Button2D
-        name: Play Button
-        properties:
-          width: 480
-          height: 140
-          label: "PLAY"
-          labelFontSize: 56
-          labelColor: "#141a2e"
-          backgroundColor: "#f5ae39"
-          hoverColor: "#ffc862"
-          pressedColor: "#d4922a"
-          buttonAction: play
-          transform:
-            position: [0, -60]
-            scale: [1, 1]
-            rotation: 0
-          layout:
-            enabled: true
-            horizontalAlign: center
-            verticalAlign: center
-        children: []

package/templates/recipe-arena-2d/files/scenes/prefabs/hazard.pix3scene

@@ -1,42 +0,0 @@
-# Pix3 Prefab (a .pix3scene with exactly ONE root node).
-# Spawned by scripts/Spawner.ts. Same shape as pickup.pix3scene — only the
-# hitbox GROUP (and the art) differ, and that group is what turns contact into
-# damage instead of score (see TouchRules' `rules`).
-version: 1.0.0
-metadata:
-  author: Pix3 Recipe
-  description: Hazard — touching it costs a life
-root:
-  - id: hazard
-    type: Sprite2D
-    name: Hazard
-    properties:
-      texture: { type: 'texture', url: 'res://sprites/ph-hazard.png' }
-      width: 104
-      height: 104
-      effects:
-        - type: core:tint
-          params: { color: "#ff4d6d", amount: 1 }
-      transform:
-        position: [0, 0]
-        scale: [1, 1]
-        rotation: 0
-    components:
-      - id: hazard-hitbox
-        type: core:Hitbox2D
-        enabled: true
-        config:
-          shape: circle
-          radius: 44
-          group: hazard
-          debugDraw: false
-      - id: hazard-pop
-        type: core:PopIn
-        enabled: true
-        config:
-          from: 0.2
-          duration: 0.25
-          easing: backOut
-          playOnStart: true
-          triggerEvent: ""
-    children: []

package/templates/recipe-arena-2d/files/scenes/prefabs/pickup.pix3scene

@@ -1,45 +0,0 @@
-# Pix3 Prefab (a .pix3scene with exactly ONE root node).
-# Spawned by scripts/Spawner.ts via scene.instantiate().
-#
-# It carries only FIXED defaults — above all its `core:Hitbox2D` GROUP, which is
-# what TouchRules matches on. Component config on a prefab INSTANCE cannot be
-# edited (the editor locks it), so every tunable lives on a plain node in
-# main.pix3scene instead. Change the group here and in TouchRules' `rules`.
-version: 1.0.0
-metadata:
-  author: Pix3 Recipe
-  description: Pickup — touching it scores
-root:
-  - id: pickup
-    type: Sprite2D
-    name: Pickup
-    properties:
-      texture: { type: 'texture', url: 'res://sprites/ph-pickup.png' }
-      width: 96
-      height: 96
-      effects:
-        - type: core:tint
-          params: { color: "#7ee787", amount: 1 }
-      transform:
-        position: [0, 0]
-        scale: [1, 1]
-        rotation: 0
-    components:
-      - id: pickup-hitbox
-        type: core:Hitbox2D
-        enabled: true
-        config:
-          shape: circle
-          radius: 46
-          group: pickup
-          debugDraw: false
-      - id: pickup-pop
-        type: core:PopIn
-        enabled: true
-        config:
-          from: 0.2
-          duration: 0.25
-          easing: backOut
-          playOnStart: true
-          triggerEvent: ""
-    children: []

package/templates/recipe-arena-2d/files/scenes/ui/result.pix3scene

@@ -1,85 +0,0 @@
-# Pix3 Scene File (YAML)
-# Arena 2D — the RESULT overlay (win/lose), in its own file so the gameplay
-# scene opens clean. `main.pix3scene` carries it as a one-line
-# `instance:` reference marked `visible: false`, which hides it in the EDITOR
-# only; `user:GameRules` reveals it at run time by setting `visible`.
-#
-# Edit it here, full-screen, in its own tab. To preview it composited over the
-# game, tick the eye on `result-overlay` in main.pix3scene — just do not commit
-# that tick, or every iteration starts behind a GAME OVER screen again.
-#
-# Stable node ids (design/recipe.md is the contract — do not rename these):
-#   result-overlay, result-label, retry-button
-version: 1.0.0
-metadata:
-  author: Pix3 Recipe
-  description: Result overlay — dim, win/lose headline and a RETRY button
-root:
-  - id: result-overlay
-    type: Group2D
-    name: Result Overlay
-    properties:
-      width: 1080
-      height: 1920
-      initiallyVisible: false
-      layout:
-        enabled: true
-        horizontalAlign: stretch
-        verticalAlign: stretch
-    children:
-      - id: result-dim
-        type: ColorRect2D
-        name: Result Dim
-        properties:
-          width: 1080
-          height: 1920
-          color: "#000000"
-          opacity: 0.7
-          transform:
-            position: [0, 0]
-            scale: [1, 1]
-            rotation: 0
-          layout:
-            enabled: true
-            horizontalAlign: stretch
-            verticalAlign: stretch
-        children: []
-      - id: result-label
-        type: Label2D
-        name: Result Label
-        properties:
-          label: "GAME OVER"
-          labelFontSize: 88
-          labelColor: "#ffffff"
-          labelAlign: center
-          transform:
-            position: [0, 160]
-            scale: [1, 1]
-            rotation: 0
-          layout:
-            enabled: true
-            horizontalAlign: center
-            verticalAlign: center
-        children: []
-      - id: retry-button
-        type: Button2D
-        name: Retry Button
-        properties:
-          width: 420
-          height: 130
-          label: "RETRY"
-          labelFontSize: 50
-          labelColor: "#141a2e"
-          backgroundColor: "#f5ae39"
-          hoverColor: "#ffc862"
-          pressedColor: "#d4922a"
-          buttonAction: retry
-          transform:
-            position: [0, -60]
-            scale: [1, 1]
-            rotation: 0
-          layout:
-            enabled: true
-            horizontalAlign: center
-            verticalAlign: center
-        children: []

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

@@ -1,368 +0,0 @@
-/**
- * GameRules — score, lives, timer, win/lose and the end flow.
- *
- * Listens on its own node for the semantic signals `TouchRules` emits
- * (`touch-scored` / `touch-damaged`), keeps the run state, and re-broadcasts
- * `score-changed` / `lives-changed` / `time-changed` for the HUD. It is the only
- * script that decides when the run is over.
- *
- * Win modes:
- *   `score`   — reach `targetScore`; the time limit (if any) is a deadline.
- *   `time`    — play until the timer ends, then win if `targetScore` was reached.
- *   `survive` — stay alive until the timer ends; reaching it is the win.
- * In every mode, running out of lives loses.
- *
- * The end-screen buttons dispatch the commands `restart` and `return-to-menu`
- * (`scene.commands`) instead of calling their methods: a test replays the end
- * flow without hunting for buttons, the run's intents are journalled with the
- * frame they happened on, and one real tap proves each binding once.
- *
- * It also publishes the run's state through `registerGameDebug`: this script
- * owns everything a test needs to read (score, lives, clock, outcome), so tools
- * and agents can assert on values instead of guessing from pixels. Add your own
- * state to `snapshot()` as you extend the rules — keep every value JSON-safe.
- */
-import {
-  Button2D,
-  Label2D,
-  NodeBase,
-  Script,
-  registerGameDebug,
-  type PropertySchema,
-} from '@pix3/runtime';
-
-type WinMode = 'score' | 'time' | 'survive';
-
-/** Snapshot numbers are read by humans and diffed by tools — keep them short. */
-function roundHundredths(value: number): number {
-  return Math.round(value * 100) / 100;
-}
-
-export class GameRules extends Script {
-  private score = 0;
-  private lives = 3;
-  private elapsed = 0;
-  private over = false;
-  private won = false;
-  private disposeDebug: (() => void) | null = null;
-  private disposeCommands: (() => void)[] = [];
-  /** Components `finish()` switched off, so `resetRun()` revives exactly those. */
-  private frozen: { enabled: boolean }[] = [];
-
-  constructor(id: string, type: string) {
-    super(id, type);
-    this.config = {
-      winMode: 'score',
-      targetScore: 12,
-      timeLimitSec: 45,
-      startingLives: 3,
-      resultNode: 'result-overlay',
-      resultLabel: 'result-label',
-      winText: 'YOU WIN!',
-      loseText: 'GAME OVER',
-      retryButton: 'retry-button',
-      menuButton: 'menu-button',
-      menuScene: 'res://scenes/menu.pix3scene',
-      gameScene: 'res://scenes/main.pix3scene',
-      // Comma-separated node ids frozen on game over: every component on the node and
-      // on everything under it (spawned instances included) is disabled.
-      freezeNodes: 'spawner-pickups,spawner-hazards,player',
-    };
-  }
-
-  static getPropertySchema(): PropertySchema {
-    const num = (name: string, label: string, min: number, max: number, step: number) => ({
-      name,
-      type: 'number' as const,
-      ui: { label, group: 'Rules', min, max, step, slider: true },
-      getValue: (s: unknown) => (s as GameRules).config[name],
-      setValue: (s: unknown, v: unknown) => {
-        const n = Number(v);
-        (s as GameRules).config[name] = Math.min(max, Math.max(min, Number.isFinite(n) ? n : min));
-      },
-    });
-    const str = (name: string, label: string, group: string) => ({
-      name,
-      type: 'string' as const,
-      ui: { label, group },
-      getValue: (s: unknown) => (s as GameRules).config[name],
-      setValue: (s: unknown, v: unknown) => {
-        (s as GameRules).config[name] = typeof v === 'string' ? v : '';
-      },
-    });
-
-    return {
-      nodeType: 'GameRules',
-      properties: [
-        {
-          name: 'winMode',
-          type: 'select',
-          ui: { label: 'Win Mode', group: 'Rules', options: ['score', 'time', 'survive'] },
-          getValue: s => (s as GameRules).config.winMode,
-          setValue: (s, v) => {
-            (s as GameRules).config.winMode = v === 'time' || v === 'survive' ? v : 'score';
-          },
-        },
-        num('targetScore', 'Target Score', 1, 99999, 1),
-        num('timeLimitSec', 'Time Limit (s)', 0, 600, 1),
-        num('startingLives', 'Starting Lives', 1, 20, 1),
-        str('winText', 'Win Text', 'Result'),
-        str('loseText', 'Lose Text', 'Result'),
-        str('resultNode', 'Result Overlay', 'Result'),
-        str('resultLabel', 'Result Label', 'Result'),
-        str('retryButton', 'Retry Button', 'Flow'),
-        str('menuButton', 'Menu Button', 'Flow'),
-        str('menuScene', 'Menu Scene', 'Flow'),
-        str('gameScene', 'Game Scene', 'Flow'),
-        str('freezeNodes', 'Freeze Nodes', 'Flow'),
-      ],
-      groups: {
-        Rules: { label: 'Rules', expanded: true },
-        Result: { label: 'Result Screen', expanded: true },
-        Flow: { label: 'Flow', expanded: false },
-      },
-    };
-  }
-
-  onStart(): void {
-    this.lives = Math.max(1, Number(this.config.startingLives) || 1);
-    const commands = this.scene?.commands;
-    this.disposeCommands = [
-      commands?.register('restart', () => this.restart(), {
-        description: 'Reload the game scene for a fresh run.',
-      }),
-      commands?.register('return-to-menu', () => this.toMenu(), {
-        description: 'Leave the run and transition back to the menu 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) ?? [],
-      // What "the start" means for a run, so a test can put the game back without
-      // reloading the scene — a reload restores the scene graph but not what a
-      // script parked outside it, which is why tooling has to label the two
-      // differently. `seed` is accepted and ignored here: the recipe's spawners
-      // draw from `Math.random`, so this restores the same starting STATE, not the
-      // same SEQUENCE. Wire it to a seeded RNG if you need replayable runs.
-      reset: () => this.resetRun(),
-      snapshot: () => ({
-        scene: 'game',
-        phase: this.over ? (this.won ? 'won' : 'lost') : 'playing',
-        score: this.score,
-        lives: this.lives,
-        winMode: String(this.config.winMode ?? 'score'),
-        targetScore: Math.max(1, Number(this.config.targetScore) || 1),
-        elapsedSec: roundHundredths(this.elapsed),
-        // null when the mode has no clock at all.
-        timeLeftSec: this.timeLeftSec(),
-      }),
-    });
-
-    const owner = this.node;
-    owner?.connect('touch-scored', this, (...args: unknown[]) =>
-      this.addScore(Number(args[0]) || 0)
-    );
-    owner?.connect('touch-damaged', this, (...args: unknown[]) =>
-      this.takeDamage(Number(args[0]) || 0)
-    );
-    // The HUD announces itself once it is connected, so it never misses the
-    // opening values (its onStart runs after this one).
-    owner?.connect('hud-ready', this, () => this.broadcast());
-
-    this.setNodeVisible(String(this.config.resultNode ?? ''), false);
-    this.bindButton(
-      String(this.config.retryButton ?? ''),
-      () => this.scene?.commands.dispatch('restart'),
-      false
-    );
-    this.bindButton(
-      String(this.config.menuButton ?? ''),
-      () => this.scene?.commands.dispatch('return-to-menu'),
-      true
-    );
-    this.broadcast();
-  }
-
-  onUpdate(dt: number): void {
-    if (this.over) {
-      return;
-    }
-    this.elapsed += dt;
-    const limit = Math.max(0, Number(this.config.timeLimitSec) || 0);
-    this.node?.emit('time-changed', limit > 0 ? Math.max(0, limit - this.elapsed) : this.elapsed);
-
-    if (this.lives <= 0) {
-      this.finish(false);
-      return;
-    }
-    const raw = String(this.config.winMode ?? 'score');
-    const mode: WinMode = raw === 'time' ? 'time' : raw === 'survive' ? 'survive' : 'score';
-    const target = Math.max(1, Number(this.config.targetScore) || 1);
-    const timeUp = limit > 0 && this.elapsed >= limit;
-
-    if (mode === 'score') {
-      if (this.score >= target) this.finish(true);
-      else if (timeUp) this.finish(false);
-    } else if (mode === 'time') {
-      if (timeUp) this.finish(this.score >= target);
-    } else if (timeUp) {
-      this.finish(true);
-    }
-  }
-
-  onDetach(): void {
-    // Clearing is safe in any order: the disposer only clears the global when it
-    // still holds *this* provider, so a scene that already registered its own wins.
-    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 = [];
-    super.onDetach();
-  }
-
-  /** Seconds left on the clock, or `null` when this run has no time limit. */
-  private timeLeftSec(): number | null {
-    const limit = Math.max(0, Number(this.config.timeLimitSec) || 0);
-    return limit > 0 ? roundHundredths(Math.max(0, limit - this.elapsed)) : null;
-  }
-
-  private addScore(amount: number): void {
-    if (this.over) return;
-    this.score += amount;
-    this.node?.emit('score-changed', this.score);
-  }
-
-  private takeDamage(amount: number): void {
-    if (this.over) return;
-    this.lives = Math.max(0, this.lives - Math.max(1, amount));
-    this.node?.emit(
-      'lives-changed',
-      this.lives,
-      Math.max(1, Number(this.config.startingLives) || 1)
-    );
-  }
-
-  private broadcast(): void {
-    const owner = this.node;
-    owner?.emit('score-changed', this.score);
-    owner?.emit('lives-changed', this.lives, Math.max(1, Number(this.config.startingLives) || 1));
-    const limit = Math.max(0, Number(this.config.timeLimitSec) || 0);
-    owner?.emit('time-changed', limit > 0 ? Math.max(0, limit - this.elapsed) : this.elapsed);
-  }
-
-  /** End the run. Call this from your own code for a custom win/lose condition. */
-  finish(won: boolean): void {
-    if (this.over) return;
-    this.over = true;
-    this.won = won;
-
-    const label = this.findNode(String(this.config.resultLabel ?? ''));
-    if (label instanceof Label2D) {
-      label.setText(String((won ? this.config.winText : this.config.loseText) ?? ''));
-    }
-    this.setNodeVisible(String(this.config.resultNode ?? ''), true);
-    this.setButtonEnabled(String(this.config.retryButton ?? ''), true);
-
-    // A freeze node freezes its whole subtree: the spawners' own components AND
-    // every instance they spawned under themselves (a chaser's script, a pickup's
-    // pop-in), so nothing keeps moving over the result card.
-    for (const id of String(this.config.freezeNodes ?? '').split(',')) {
-      const root = this.findNode(id.trim());
-      if (!root) continue;
-      root.traverse(object => {
-        if (!(object instanceof NodeBase)) return;
-        for (const component of object.components) {
-          // Only remember what WE switched off: reviving everything on reset would
-          // silently enable a component the scene author had left disabled.
-          if (!component.enabled) continue;
-          component.enabled = false;
-          this.frozen.push(component);
-        }
-      });
-    }
-    this.node?.emit(won ? 'game-won' : 'game-lost', this.score);
-  }
-
-  private restart(): void {
-    void this.scene?.changeScene(String(this.config.gameScene ?? ''), { transition: 'fade' });
-  }
-
-  private toMenu(): void {
-    void this.scene?.changeScene(String(this.config.menuScene ?? ''), { transition: 'fade' });
-  }
-
-  /**
-   * Back to the state `onStart` left behind: score, lives, clock and outcome, the
-   * result overlay hidden, the freeze `finish()` applied lifted, and anything a
-   * spawner still has on the field despawned. Those leftovers are state too — a
-   * run that begins amid the previous run's targets did not begin from the start.
-   *
-   * Public because it is useful on its own (an in-run "try again" that skips the
-   * scene reload); the debug provider's `reset` is this method.
-   */
-  resetRun(): void {
-    for (const component of this.frozen) {
-      component.enabled = true;
-    }
-    this.frozen = [];
-    this.clearSpawned();
-
-    this.score = 0;
-    this.lives = Math.max(1, Number(this.config.startingLives) || 1);
-    this.elapsed = 0;
-    this.over = false;
-    this.won = false;
-
-    this.setNodeVisible(String(this.config.resultNode ?? ''), false);
-    this.setButtonEnabled(String(this.config.retryButton ?? ''), false);
-    this.broadcast();
-  }
-
-  /**
-   * Ask every component on a `freezeNodes` node that owns spawned instances to
-   * drop them. Duck-typed instead of importing `Spawner`: the freeze list is
-   * whatever the scene author wrote there, and a project may put its own spawner
-   * in it — one that also happens to offer `clear()`.
-   */
-  private clearSpawned(): void {
-    for (const id of String(this.config.freezeNodes ?? '').split(',')) {
-      const node = this.findNode(id.trim());
-      if (!node) continue;
-      for (const component of node.components) {
-        const clear = (component as { clear?: unknown }).clear;
-        if (typeof clear === 'function') {
-          (clear as () => void).call(component);
-        }
-      }
-    }
-  }
-
-  private bindButton(query: string, handler: () => void, enabled: boolean): void {
-    const button = this.findNode(query);
-    if (button instanceof Button2D) {
-      button.enabled = enabled;
-      button.connect('pressed', this, handler);
-    }
-  }
-
-  private setButtonEnabled(query: string, enabled: boolean): void {
-    const button = this.findNode(query);
-    if (button instanceof Button2D) {
-      button.enabled = enabled;
-    }
-  }
-
-  private setNodeVisible(query: string, visible: boolean): void {
-    const node = this.findNode(query);
-    if (node) {
-      node.visible = visible;
-    }
-  }
-}