yuuna-engine 0.3.0 → 0.5.0

package/README.md

@@ -32,14 +32,19 @@ Then describe your game as state + render + nextState:
 ```ts
 import { runEngine } from "yuuna-engine";
 
+// The shape of your game's data — whatever it takes to fully describe
+// what's on screen and how it behaves
 type GameState = { cookies: number };
 
-runEngine<GameState>({
-  initialState: { cookies: 0 },
+// What that state looks like before anything has happened yet
+const initialState: GameState = { cookies: 0 };
 
-  // Optional — size and color the canvas from code instead of HTML/CSS
-  canvas: { width: 960, height: 540, backgroundColor: "#0d1831" },
+runEngine<GameState>({
+  initialState,
 
+  // Given the current state, what should be drawn this frame? Called
+  // every frame — always derive the picture from state, instead of
+  // reaching for the canvas directly.
   render: (state) => ({
     renderables: [
       {
@@ -59,6 +64,9 @@ runEngine<GameState>({
     ],
   }),
 
+  // Given the current state and something that just happened, what's the
+  // next state? Called once per event (a click, a frame tick, ...) — the
+  // only place game logic lives.
   nextState: ({ state, event }) => {
     if (event.tag === "CLICK" && event.id === "cookie") {
       return { cookies: state.cookies + 1 };
@@ -72,110 +80,42 @@ runEngine<GameState>({
 ## Concepts
 
 - **Renderables** — declarative shapes drawn each frame: `RECTANGLE`,
-  `CIRCLE`, `TEXT`, `SPRITE`, `LINE`, `GROUP`, and `ANIMATED_SPRITE`. Give
-  one an `id` plus `isClickable` / `isHoverable` / `trackMouseMovement` to
-  make it interactive. `TEXT` also takes a `fontSize` (defaults to `30`).
-  `GROUP` draws nothing itself — it's just a `position` (plus the usual
-  `scale`/`modulate`/`layer` below) for `children` to hang off of, for
-  grouping renderables that should move/scale/tint together without
-  needing a shape of its own; it's never interactable, since it has no
-  shape to hit-test. `ANIMATED_SPRITE` is `SPRITE` with an `animation`
-  (name of one defined on that resource — see Sprites below) and an
-  optional `timeScale` instead of a `frame` number; the engine picks the
-  frame for you based on how long it's been playing. Unlike every other
-  renderable, its `id` is required — that's how the engine recognizes
-  "this is the same sprite as last frame" across renders (and switches to
-  frame 0 if `animation` changes for that `id`), so reusing an id across
-  two different entities will make their animations bleed together.
-  Every renderable also takes:
-  - `layer` — higher values render later, i.e. in front of lower ones.
-    Defaults to `0`; renderables on the same layer keep `render()`'s order.
-  - `scale` — `{ x, y }` multiplier on the renderable's size, anchored at
-    its `position` (or `from`, for `LINE`). Defaults to `{ x: 1, y: 1 }`.
-    A `CIRCLE` scaled unevenly draws (and hit-tests) as an ellipse.
-  - `modulate` — a CSS color string that multiplies the renderable's color
-    channel-by-channel, the same way Godot's `modulate` works — e.g.
-    `"#808080"` halves brightness, `"#ff0000"` keeps only the red channel.
-  - `children` — nested renderables, positioned relative to this one, like
-    Godot's parent/child nodes. A child's `position` is added to its
-    parent's (scaled by the parent's own `scale`), and `scale` / `modulate`
-    / `layer` all compose down the tree — a child's effective scale is the
-    parent's times its own, `modulate` multiplies the same way, and
-    `layer` adds (relative to the parent's, matching Godot's default: a
-    deeply-nested child can still end up drawn in front of an unrelated
-    top-level renderable if its accumulated layer says so). A child is a
-    full `Renderable`, so it can have its own `id` / `isClickable` / even
-    its own `children`. `screenSpace: true` makes a renderable (and its
-    whole subtree) ignore the camera below and stay fixed to the screen —
-    for UI/HUD that shouldn't pan or zoom with the game world.
-- **Camera** — pass `camera: (state) => ({ x, y, zoom })` to `runEngine` to
-  pan/zoom every world-space renderable (anything without
-  `screenSpace: true`) as a group, the same way a `GROUP` parent works for
-  its children — `{ x, y }` is the world position mapped to canvas
-  `(0, 0)`, and `zoom` scales everything around that same point. It's a
-  function of state, so the camera can follow something or react to a
-  zoom level you're tracking yourself.
-- **Events** — your `nextState` function receives one `GameEvent` per call:
-  `TIME` (frame tick with `delta`), `CLICK`, `HOVER_IN`, `HOVER_OUT`, or
-  `MOUSE_MOVE`. The mouse-carrying ones include both `mouse` (raw canvas
-  pixels — use for `screenSpace`/UI logic) and `worldMouse` (that same
-  position run through the camera's inverse transform — use to
-  place/locate world-space things, e.g. build a turret where the player
-  clicked). With no `camera` set, `worldMouse` always equals `mouse`.
-- **Keyboard** — `nextState` also receives a `keyboard` map keyed by
-  `KeyCode`-style keys (e.g. `"KeyW"`, `"ArrowLeft"`, `"Space"`), each with
-  `isPressed` / `isJustPressed` / `isJustReleased`.
-- **Sprites** — pass a `resources` map of `{ src, size, slices }` to
-  `runEngine` to load spritesheets, then reference them by id with a
-  `SPRITE` renderable's `resourceId` and `frame`. Set `flipX: true` to
-  mirror a sprite horizontally — useful when the art is drawn facing one
-  direction but needs to move the other way. Add an `animations` map to a
-  resource — `{ frames: number[], frameDuration, loop }` each — to play
-  one with `ANIMATED_SPRITE` instead of managing `frame` by hand.
-- **Sound effects** — pass a `sounds` map of `{ src }` to `runEngine`, then
-  call the `playSound(id)` function `nextState` receives to play one, e.g.
-  `playSound("collect")` when a cookie is clicked. Calling it again while
-  a sound is still playing overlaps a new copy instead of cutting the
-  first one off.
-- **Music** — pass a `music` map of `{ src }` to `runEngine`, then use the
-  `playMusic(id)` / `pauseMusic()` functions `nextState` receives to
-  control a looping background track. Unlike `playSound`, only one track
-  plays at a time and it keeps running in the background across frames
-  instead of firing once; `pauseMusic()` leaves it where it stopped, so
-  calling `playMusic(id)` again resumes it instead of starting over.
-- **Canvas** — pass `canvas: { width, height, backgroundColor }` to
-  `runEngine` to size and color the canvas from code. All three are
-  optional; anything you don't set falls back to the canvas element's
-  existing HTML/CSS.
-- **Mechanics** — `nextState` can also be an array of small
-  `NextStateFunction`s instead of one big function. Each one is run in
-  order for every event, and can return:
-  - a new state, to update to
-  - `undefined` (or no `return` at all) — no change, but the rest of the
-    list still runs, so a guard can just be `if (...) return;`
-  - `STOP` (imported from `yuuna-engine`) — no change, and the rest of
-    the list is skipped for this event, so a shared rule (like "nothing
-    happens once the game is over") only needs to be written once
-
-  ```ts
-  import { runEngine, STOP, type NextStateFunction } from "yuuna-engine";
-
-  const freezeOnGameOver: NextStateFunction<GameState> = ({ state }) => {
-    if (state.lives <= 0) return STOP;
-  };
-
-  const moveEnemies: NextStateFunction<GameState> = ({ state, event }) => {
-    if (event.tag === "TIME") {
-      return { ...state, enemies: move(state.enemies, event.delta) };
-    }
-  };
+  `CIRCLE`, `TEXT`, `SPRITE`, `ANIMATED_SPRITE`, `LINE`, and `GROUP`. Give
+  one an `id` plus `isClickable`/`isHoverable` to make it interactive.
+- **Events** — `nextState` receives one `GameEvent` per call: `TIME`,
+  `CLICK`, `HOVER_IN`, `HOVER_OUT`, `MOUSE_MOVE`, `MOUSE_LEAVE`,
+  `MUSIC_END`, or a `CUSTOM` event of a type you define yourself, for
+  reporting things like an async `fetch()` resolving back into your
+  state machine.
+- **Keyboard, camera, sprites & animation, sound effects & music,
+  canvas config, and mechanics pipelines** all follow the same idea:
+  small, focused props and functions `runEngine`/`nextState` take, that
+  compose with everything above instead of replacing it.
+
+This README stays intentionally thin — the full concept-by-concept
+reference, with every option and example, lives on the
+[wiki](https://github.com/lucy-dot-exe/yuuna/wiki). The
+[playground](https://lucy-dot-exe.github.io/yuuna/#playground) also has a
+small, focused example for most of these you can run and edit directly.
+
+## Templates
+
+Prefer a working starting point over typing the quick start out by
+hand? Grab one from [`templates/`](templates):
+
+- **[blank](templates/blank)** — a single `index.html`, zero install —
+  open it in a browser and it runs.
+- **[npm](templates/npm)** — TypeScript + a dev server with hot reload
+  (via Vite), for a real local project.
+
+```sh
+npx degit lucy-dot-exe/yuuna/templates/blank my-game
+# or: npx degit lucy-dot-exe/yuuna/templates/npm my-game
+```
 
-  runEngine<GameState>({
-    initialState,
-    render,
-    nextState: [freezeOnGameOver, moveEnemies /* ... */],
-  });
-  ```
+[`degit`](https://github.com/Rich-Harris/degit) copies the folder without
+its git history — no cloning or forking the whole engine repo needed.
+Each template's own README has more on running it once copied.
 
 ## Development
 
@@ -189,6 +129,24 @@ yarn watch   # rebuild on change
 browser via a global `Yuuna` object and embeds a live Monaco editor so
 visitors can edit and run a game directly on the page.
 
+## Assets
+
+The examples' art/sound/music lives in `dist/resources/`, gitignored
+rather than committed — this repo being open source doesn't make every
+asset in it free to redistribute. `runEngine()` falls back to a
+generated placeholder for any image that isn't there (and simply plays
+nothing for missing audio) instead of failing, so the examples still
+run without them — just with placeholder art in place of the real
+thing. Drop the real files in locally (or restore them from wherever
+you got this repo from) to see them for real.
+
+Currently used:
+
+- **[Free Pixel Food!](https://henrysoftware.itch.io/pixel-food)** by
+  [Henry Software](https://henrysoftware.itch.io/) — the food icons in
+  the Food Clicker and Sprites examples. CC0; credited here by choice,
+  not requirement.
+
 ## License
 
 MIT © [lucy-dot-exe](https://github.com/lucy-dot-exe)

package/lib/engine/types.d.ts

@@ -57,6 +57,10 @@ export type SpriteRenderable = BaseRenderable & {
     frame: number;
     opacity?: number;
     flipX?: boolean;
+    swapColors?: {
+        from: string;
+        to: string;
+    }[];
 };
 export type LineRenderable = BaseRenderable & {
     type: "LINE";
@@ -83,6 +87,10 @@ export type AnimatedSpriteRenderable = BaseRenderable & {
     paused?: boolean;
     opacity?: number;
     flipX?: boolean;
+    swapColors?: {
+        from: string;
+        to: string;
+    }[];
     id: string;
 };
 export type GroupRenderable = BaseRenderable & {
@@ -145,10 +153,35 @@ export type MouseMoveEvent = {
         y: number;
     };
 };
-export type GameEvent = TimeEvent | ClickEvent | HoverInEvent | HoverOutEvent | MouseMoveEvent;
-export type NextStateProps<State> = {
+export type MouseLeaveEvent = {
+    tag: "MOUSE_LEAVE";
+    mouse: {
+        x: number;
+        y: number;
+    };
+    worldMouse: {
+        x: number;
+        y: number;
+    };
+};
+export type TabBlurEvent = {
+    tag: "TAB_BLUR";
+};
+export type TabFocusEvent = {
+    tag: "TAB_FOCUS";
+};
+export type MusicEndEvent = {
+    tag: "MUSIC_END";
+    id: string;
+};
+export type GameEvent = TimeEvent | ClickEvent | HoverInEvent | HoverOutEvent | MouseMoveEvent | MouseLeaveEvent | TabBlurEvent | TabFocusEvent | MusicEndEvent;
+export type CustomGameEvent<Custom> = {
+    tag: "CUSTOM";
+    event: Custom;
+};
+export type NextStateProps<State, Custom = never> = {
     state: State;
-    event: GameEvent;
+    event: GameEvent | CustomGameEvent<Custom>;
     keyboard: Record<KeyboardKeys, {
         isPressed: boolean;
         isJustPressed: boolean;
@@ -157,16 +190,18 @@ export type NextStateProps<State> = {
     playSound: (id: string) => void;
     playMusic: (id: string) => void;
     pauseMusic: () => void;
+    resumeMusic: () => void;
+    setMusicVolume: (volume: number) => void;
 };
 export declare const STOP: "Yuuna.STOP";
-export type NextStateFunction<State> = (props: NextStateProps<State>) => State | typeof STOP | undefined;
-export type RunEngineProps<State> = {
+export type NextStateFunction<State, Custom = never> = (props: NextStateProps<State, Custom>) => State | typeof STOP | undefined;
+export type RunEngineProps<State, Custom = never> = {
     initialState: State;
     render: (state: State) => {
-        cursor?: "default" | "pointer";
+        cursor?: "default" | "pointer" | "none";
         renderables: Renderable[];
     };
-    nextState: NextStateFunction<State> | NextStateFunction<State>[];
+    nextState: NextStateFunction<State, Custom> | NextStateFunction<State, Custom>[];
     resources?: Record<string, {
         src: string;
         size: {
@@ -188,6 +223,7 @@ export type RunEngineProps<State> = {
     }>;
     music?: Record<string, {
         src: string;
+        loop?: boolean;
     }>;
     canvas?: {
         width?: number;
@@ -200,7 +236,9 @@ export type RunEngineProps<State> = {
         zoom: number;
     };
 };
-export type RunEngineFunction = <State>(props: RunEngineProps<State>) => Promise<void>;
+export type RunEngineFunction = <State, Custom = never>(props: RunEngineProps<State, Custom>) => Promise<{
+    sendEvent: (event: Custom) => void;
+}>;
 export declare const keyboardKeys: readonly ["ControlLeft", "ControlRight", "AltLeft", "AltRight", "CapsLock", "End", "Delete", "Tab", "Space", "Enter", "ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown", "Numpad0", "Numpad1", "Numpad2", "Numpad3", "Numpad4", "Numpad5", "Numpad6", "Numpad7", "Numpad8", "Numpad9", "Digit0", "Digit1", "Digit2", "Digit3", "Digit4", "Digit5", "Digit6", "Digit7", "Digit8", "Digit9", "KeyA", "KeyB", "KeyC", "KeyD", "KeyE", "KeyF", "KeyG", "KeyH", "KeyI", "KeyJ", "KeyK", "KeyL", "KeyM", "KeyN", "KeyO", "KeyP", "KeyQ", "KeyR", "KeyS", "KeyT", "KeyU", "KeyV", "KeyW", "KeyX", "KeyY", "KeyZ"];
 export type KeyboardKeys = (typeof keyboardKeys)[number];
 export type KeyboardState = Record<KeyboardKeys, boolean>;

package/lib/index.cjs

@@ -120,6 +120,35 @@ const sortByLayer = (renderables) => [...renderables].sort((a, b) => (a.layer ??
 const anchorOf = (renderable) => renderable.type === "LINE" ? renderable.from : renderable.position;
 // No RunEngineProps.camera set is the same as one that doesn't pan or zoom.
 const DEFAULT_CAMERA = { x: 0, y: 0, zoom: 1 };
+// Stands in for a resources[id].src image that fails to load — most
+// often because it's a real, not-necessarily-open-source asset that
+// (correctly) isn't checked into a public repo, rather than a bug. Drawn
+// at the sheet's *declared* size (resources[id].size, not anything read
+// off the failed image), so every existing frame/slice/animation still
+// lines up exactly as if the real sheet had loaded — nothing about the
+// example's own code has to know or care that this happened.
+const createPlaceholderSheet = (size) => {
+    const canvas = window.document.createElement("canvas");
+    canvas.width = Math.max(1, size.width);
+    canvas.height = Math.max(1, size.height);
+    const context = canvas.getContext("2d");
+    if (context === null) {
+        return canvas;
+    }
+    // The old "missing texture" magenta/black checkerboard — deliberately
+    // eye-catching (rather than, say, a plain gray box) so a placeholder
+    // reads as "an asset is missing" at a glance instead of quietly
+    // passing for a real, if plain, sprite.
+    const cellSize = Math.max(4, Math.min(16, Math.round(Math.min(canvas.width, canvas.height) / 4)));
+    for (let y = 0; y < canvas.height; y += cellSize) {
+        for (let x = 0; x < canvas.width; x += cellSize) {
+            const isEvenCell = (x / cellSize + y / cellSize) % 2 === 0;
+            context.fillStyle = isEvenCell ? "#ff00ff" : "#000000";
+            context.fillRect(x, y, cellSize, cellSize);
+        }
+    }
+    return canvas;
+};
 const runEngine = async (props) => {
     const runId = ++latestRunId;
     resetCanvas?.();
@@ -147,13 +176,20 @@ const runEngine = async (props) => {
     // leaking to the rest of the page (e.g. arrow keys scrolling the window).
     canvas.tabIndex = 0;
     let state = props.initialState;
+    const events = [];
+    // Lets a caller report something that happened outside the render loop
+    // (e.g. a fetch().then() callback) back into it — the event is queued
+    // here and delivered to nextState as a CustomGameEvent on the next tick,
+    // the same as any built-in event.
+    const sendEvent = (event) => {
+        events.push({ tag: "CUSTOM", event });
+    };
     const resources = props.resources ?? {};
     const resourceById = await iterateRecordAsync(resources, async ({ value }) => new Promise((resolve) => {
         const image = new Image();
-        image.src = value.src;
-        image.onload = function () {
+        const settle = (loadedImage) => {
             resolve({
-                image,
+                image: loadedImage,
                 size: {
                     width: value.size.width / value.slices.horizontal,
                     height: value.size.height / value.slices.vertical,
@@ -162,12 +198,25 @@ const runEngine = async (props) => {
                 animations: value.animations ?? {},
             });
         };
+        image.src = value.src;
+        image.onload = () => settle(image);
+        // Missing/failed-to-load asset (see .gitignore's dist/resources/
+        // note) — a placeholder sheet, sized to match what this resource
+        // declared, keeps every frame/slice/animation index the example
+        // already computes valid instead of drawing nothing or throwing.
+        image.onerror = () => settle(createPlaceholderSheet(value.size));
     }));
     const loadAudio = (src) => new Promise((resolve) => {
         const audio = new Audio(src);
         audio.oncanplaythrough = function () {
             resolve(audio);
         };
+        // Missing/failed-to-load audio — resolve anyway instead of hanging
+        // this Promise (and every resource after it, via Promise.all)
+        // forever waiting for a "canplaythrough" that's never coming.
+        // playSound/playMusic below already no-op safely on an element
+        // that can't actually play.
+        audio.onerror = () => resolve(audio);
     });
     const sounds = props.sounds ?? {};
     const audioById = await iterateRecordAsync(sounds, ({ value }) => loadAudio(value.src));
@@ -180,15 +229,31 @@ const runEngine = async (props) => {
             return;
         }
         const instance = audio.cloneNode();
-        instance.play();
+        // A missing/failed-to-load sound (see loadAudio's onerror above)
+        // rejects here instead of playing — caught and dropped rather than
+        // left as an unhandled rejection, same as playMusic/resumeMusic below.
+        instance.play().catch(() => { });
     };
     const music = props.music ?? {};
     const musicById = await iterateRecordAsync(music, ({ value }) => loadAudio(value.src));
+    // Registered once per track at load time — fires only for a track
+    // whose `loop` is false, since a looping <audio> never reaches "ended"
+    // (the browser restarts it before the event would fire).
+    for (const id of getKeys(musicById)) {
+        musicById[id].addEventListener("ended", () => {
+            events.push({ tag: "MUSIC_END", id });
+        });
+    }
     // Unlike sounds, music reuses the same element instead of cloning it —
     // there's only ever one track playing, and reusing it is what lets
     // pauseMusic()/playMusic() resume from where playback left off instead
     // of starting over.
     let currentMusic = null;
+    // Volume is a property of each HTMLAudioElement, not global — tracked
+    // separately here and (re)applied on every playMusic() so switching
+    // tracks keeps the volume the game last set instead of resetting to
+    // each element's default of 1.
+    let musicVolume = 1;
     const playMusic = (id) => {
         const audio = musicById[id];
         if (audio === undefined) {
@@ -197,18 +262,28 @@ const runEngine = async (props) => {
         if (currentMusic !== null && currentMusic !== audio) {
             currentMusic.pause();
         }
-        audio.loop = true;
-        audio.play();
+        audio.loop = music[id]?.loop ?? true;
+        audio.volume = musicVolume;
+        audio.play().catch(() => { });
         currentMusic = audio;
     };
     const pauseMusic = () => {
         currentMusic?.pause();
     };
+    const resumeMusic = () => {
+        currentMusic?.play().catch(() => { });
+    };
+    const setMusicVolume = (volume) => {
+        musicVolume = Math.min(1, Math.max(0, volume));
+        if (currentMusic !== null) {
+            currentMusic.volume = musicVolume;
+        }
+    };
     // A newer runEngine() call started while this one was still loading
     // resources (e.g. a spritesheet) — abandon this run instead of setting
     // up a second, orphaned render loop alongside the newer one.
     if (runId !== latestRunId) {
-        return;
+        return { sendEvent };
     }
     context.imageSmoothingEnabled = false;
     // An offscreen 1x1 canvas used only to resolve a CSS color string (a
@@ -498,8 +573,7 @@ const runEngine = async (props) => {
     const nextStateFns = Array.isArray(props.nextState) ? props.nextState : [props.nextState];
     let lastFrame = Date.now();
     let hoveredId = null;
-    const events = [];
-    canvas.addEventListener("click", (ev) => {
+    const handleClick = (ev) => {
         const mouse = getCanvasPosition(ev);
         if (hoveredId === null)
             return;
@@ -508,7 +582,8 @@ const runEngine = async (props) => {
         if (hovered !== undefined && hovered.isClickable) {
             events.push({ tag: "CLICK", id: hovered.id, mouse, worldMouse: toWorldPosition(mouse, camera) });
         }
-    });
+    };
+    canvas.addEventListener("click", handleClick);
     const initialState = {
         keyboardState: createRecord(keyboardKeys, () => false),
     };
@@ -518,7 +593,7 @@ const runEngine = async (props) => {
     const currentState = {
         keyboardState: { ...initialState.keyboardState },
     };
-    canvas.addEventListener("keydown", (event) => {
+    const handleKeyDown = (event) => {
         const pressedKey = keyboardKeys.find((key) => key === event.code);
         if (pressedKey !== undefined) {
             // Stop tracked keys (arrows, space, ...) from also scrolling the
@@ -527,15 +602,17 @@ const runEngine = async (props) => {
             event.preventDefault();
             currentState.keyboardState[pressedKey] = true;
         }
-    });
-    canvas.addEventListener("keyup", (event) => {
+    };
+    canvas.addEventListener("keydown", handleKeyDown);
+    const handleKeyUp = (event) => {
         const releasedKey = keyboardKeys.find((key) => key === event.code);
         if (releasedKey !== undefined) {
             event.preventDefault();
             currentState.keyboardState[releasedKey] = false;
         }
-    });
-    canvas.addEventListener("mousemove", (ev) => {
+    };
+    canvas.addEventListener("keyup", handleKeyUp);
+    const handleMouseMoveHover = (ev) => {
         const mouse = getCanvasPosition(ev);
         const { renderables, camera } = renderState(state);
         const worldMouse = toWorldPosition(mouse, camera);
@@ -552,8 +629,9 @@ const runEngine = async (props) => {
             }
         }
         hoveredId = hovered === undefined ? null : hovered.id ?? null;
-    });
-    canvas.addEventListener("mousemove", (ev) => {
+    };
+    canvas.addEventListener("mousemove", handleMouseMoveHover);
+    const handleMouseMoveTracking = (ev) => {
         const mouse = getCanvasPosition(ev);
         if (hoveredId === null) {
             return;
@@ -563,7 +641,33 @@ const runEngine = async (props) => {
         if (hovered !== undefined && hovered.trackMouseMovement) {
             events.push({ tag: "MOUSE_MOVE", mouse, worldMouse: toWorldPosition(mouse, camera), id: hovered.id });
         }
-    });
+    };
+    canvas.addEventListener("mousemove", handleMouseMoveTracking);
+    // No further mousemove fires once the mouse is off the canvas, so this
+    // is also the only chance to report a HOVER_OUT for whatever was
+    // hovered when it left — otherwise that hover would just dangle,
+    // never explicitly ended.
+    const handleMouseLeave = (ev) => {
+        const mouse = getCanvasPosition(ev);
+        const { renderables, camera } = renderState(state);
+        const worldMouse = toWorldPosition(mouse, camera);
+        if (hoveredId !== null) {
+            const lastHovered = renderables.find((r) => r.id === hoveredId);
+            if (lastHovered !== undefined) {
+                events.push({ tag: "HOVER_OUT", id: lastHovered.id, mouse, worldMouse });
+            }
+        }
+        hoveredId = null;
+        events.push({ tag: "MOUSE_LEAVE", mouse, worldMouse });
+    };
+    canvas.addEventListener("mouseleave", handleMouseLeave);
+    // Tab switches are a document-level concern (visibilitychange), not
+    // something that ever reaches the canvas itself the way mouse/keyboard
+    // events do.
+    const handleVisibilityChange = () => {
+        events.push({ tag: window.document.hidden ? "TAB_BLUR" : "TAB_FOCUS" });
+    };
+    window.document.addEventListener("visibilitychange", handleVisibilityChange);
     context.imageSmoothingEnabled = false;
     // Scale is a canvas transform around the renderable's anchor, applied
     // before its type-specific drawing runs below — everything drawn under
@@ -614,6 +718,56 @@ const runEngine = async (props) => {
         tintBufferContext.globalCompositeOperation = "source-over";
         return tintBuffer;
     };
+    // Palette-swapped frames, keyed by resourceId + frame + the exact swap
+    // list — unlike tintedSpriteFrame's cheap multiply-blend (redone fresh
+    // every draw off one shared buffer), a swap needs real pixel work
+    // (getImageData over the whole frame), so each unique combination is
+    // computed once here and reused on every later draw instead. Grows for
+    // as long as new combinations keep showing up — fine for a fixed small
+    // set of recolors (e.g. team A/B/C), a bad fit for one that varies
+    // continuously (e.g. a randomized hue per instance), which would cache-
+    // miss every time and just accumulate.
+    const swappedFrameCache = new Map();
+    const swappedSpriteFrame = (resourceId, frame, image, source, swapColors) => {
+        const cacheKey = `${resourceId}:${frame}:${swapColors.map(({ from, to }) => `${from}>${to}`).join(",")}`;
+        const cached = swappedFrameCache.get(cacheKey);
+        if (cached !== undefined) {
+            return cached;
+        }
+        const canvas = window.document.createElement("canvas");
+        canvas.width = source.width;
+        canvas.height = source.height;
+        const swapContext = canvas.getContext("2d");
+        // No 2d context to work with (shouldn't happen in a real browser) —
+        // draw the untouched frame rather than crash.
+        if (swapContext === null) {
+            return image;
+        }
+        swapContext.drawImage(image, source.x, source.y, source.width, source.height, 0, 0, source.width, source.height);
+        // Resolved once per unique `from`/`to` pair (resolveColor caches by
+        // string), not per pixel — the pixel loop below only ever compares
+        // against these already-resolved bytes.
+        const resolvedSwaps = swapColors.map(({ from, to }) => ({
+            from: resolveColor(from),
+            to: resolveColor(to),
+        }));
+        const imageData = swapContext.getImageData(0, 0, canvas.width, canvas.height);
+        const pixels = imageData.data;
+        for (let i = 0; i < pixels.length; i += 4) {
+            for (const { from, to } of resolvedSwaps) {
+                if (pixels[i] === from[0] && pixels[i + 1] === from[1] && pixels[i + 2] === from[2] && pixels[i + 3] === from[3]) {
+                    pixels[i] = to[0];
+                    pixels[i + 1] = to[1];
+                    pixels[i + 2] = to[2];
+                    pixels[i + 3] = to[3];
+                    break;
+                }
+            }
+        }
+        swapContext.putImageData(imageData, 0, 0);
+        swappedFrameCache.set(cacheKey, canvas);
+        return canvas;
+    };
     const intervalId = setInterval(() => {
         const now = Date.now();
         const delta = now - lastFrame;
@@ -628,7 +782,16 @@ const runEngine = async (props) => {
                 };
             });
             for (const nextState of nextStateFns) {
-                const result = nextState({ state, event, keyboard, playSound, playMusic, pauseMusic });
+                const result = nextState({
+                    state,
+                    event,
+                    keyboard,
+                    playSound,
+                    playMusic,
+                    pauseMusic,
+                    resumeMusic,
+                    setMusicVolume,
+                });
                 // STOP stops the rest of the list from running for this event,
                 // instead of every later mechanic needing to repeat the same
                 // guard. undefined just means this mechanic made no change, so
@@ -675,7 +838,7 @@ const runEngine = async (props) => {
                 continue;
             }
             if (renderable.type === "SPRITE") {
-                const { opacity = 1, flipX = false, modulate } = renderable;
+                const { opacity = 1, flipX = false, modulate, swapColors } = renderable;
                 const resource = resourceById[renderable.resourceId];
                 const frame = {
                     x: renderable.frame % resource.slices.horizontal,
@@ -690,12 +853,23 @@ const runEngine = async (props) => {
                 };
                 const destWidth = resource.size.width;
                 const destHeight = resource.size.height;
-                // Tinting swaps in an already-tinted offscreen copy of this frame
-                // as the image to draw — everything past this point (flipX,
-                // positioning) treats it exactly like the untinted spritesheet,
-                // just drawn starting at (0, 0) instead of cropped from a sheet.
-                const image = modulate === undefined ? resource.image : tintedSpriteFrame(resource.image, source, modulate);
-                const imageSource = modulate === undefined ? source : { x: 0, y: 0, width: source.width, height: source.height };
+                // Swapping and tinting each swap in an already-processed offscreen
+                // copy of this frame as the image to draw from then on —
+                // everything past this point (flipX, positioning) treats it
+                // exactly like the untinted spritesheet, just drawn starting at
+                // (0, 0) instead of cropped from a sheet. Swap runs first (it's
+                // the sprite's "real" recolored identity), tint runs on top of
+                // that (e.g. a damage flash still applies over swapped colors).
+                let image = resource.image;
+                let imageSource = source;
+                if (swapColors !== undefined && swapColors.length > 0) {
+                    image = swappedSpriteFrame(renderable.resourceId, renderable.frame, image, imageSource, swapColors);
+                    imageSource = { x: 0, y: 0, width: source.width, height: source.height };
+                }
+                if (modulate !== undefined) {
+                    image = tintedSpriteFrame(image, imageSource, modulate);
+                    imageSource = { x: 0, y: 0, width: source.width, height: source.height };
+                }
                 context.globalAlpha = opacity;
                 const drawSprite = (destX, destY) => {
                     context.drawImage(image, imageSource.x, imageSource.y, imageSource.width, imageSource.height, destX, destY, destWidth, destHeight);
@@ -746,7 +920,34 @@ const runEngine = async (props) => {
     }, 0);
     resetCanvas = () => {
         clearInterval(intervalId);
+        // Otherwise a track started by this run keeps playing underneath
+        // whatever the next runEngine() call starts — currentMusic is a
+        // per-run element, not something the next run has any way to reach.
+        currentMusic?.pause();
+        currentMusic = null;
+        // The canvas element itself is only thrown away between runs if the
+        // caller replaces it — in the playground it's the same persistent
+        // <canvas id="yuuna"> across every example switch and every
+        // Auto-Reload keystroke, so its listeners have to be removed
+        // explicitly here too, or each run stacks its own click/mousemove/
+        // keyboard handlers on top of every previous run's. Those old
+        // handlers still fire (each still does its own hit-testing and
+        // renderState() call against its own now-frozen state) even though
+        // their interval is long since cleared, quietly costing more CPU per
+        // click/mousemove the more times a run's been replaced — and on a
+        // slow enough device or long enough playground session, that pile-up
+        // is what "clicks stop working" actually looks like.
+        canvas.removeEventListener("click", handleClick);
+        canvas.removeEventListener("keydown", handleKeyDown);
+        canvas.removeEventListener("keyup", handleKeyUp);
+        canvas.removeEventListener("mousemove", handleMouseMoveHover);
+        canvas.removeEventListener("mousemove", handleMouseMoveTracking);
+        canvas.removeEventListener("mouseleave", handleMouseLeave);
+        // This one's on `document`, not the canvas — same reasoning as above,
+        // just doubly true since `document` isn't even scoped to this canvas.
+        window.document.removeEventListener("visibilitychange", handleVisibilityChange);
     };
+    return { sendEvent };
 };
 
 exports.STOP = STOP;

package/lib/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/lib/index.d.ts

@@ -1,4 +1,4 @@
 import { runEngine } from "./engine/runEngine";
 import { STOP } from "./engine/types";
 export { runEngine, STOP };
-export type { NextStateFunction, NextStateProps, Renderable, GameEvent } from "./engine/types";
+export type { NextStateFunction, NextStateProps, Renderable, GameEvent, CustomGameEvent, } from "./engine/types";

package/lib/index.js

@@ -118,6 +118,35 @@ const sortByLayer = (renderables) => [...renderables].sort((a, b) => (a.layer ??
 const anchorOf = (renderable) => renderable.type === "LINE" ? renderable.from : renderable.position;
 // No RunEngineProps.camera set is the same as one that doesn't pan or zoom.
 const DEFAULT_CAMERA = { x: 0, y: 0, zoom: 1 };
+// Stands in for a resources[id].src image that fails to load — most
+// often because it's a real, not-necessarily-open-source asset that
+// (correctly) isn't checked into a public repo, rather than a bug. Drawn
+// at the sheet's *declared* size (resources[id].size, not anything read
+// off the failed image), so every existing frame/slice/animation still
+// lines up exactly as if the real sheet had loaded — nothing about the
+// example's own code has to know or care that this happened.
+const createPlaceholderSheet = (size) => {
+    const canvas = window.document.createElement("canvas");
+    canvas.width = Math.max(1, size.width);
+    canvas.height = Math.max(1, size.height);
+    const context = canvas.getContext("2d");
+    if (context === null) {
+        return canvas;
+    }
+    // The old "missing texture" magenta/black checkerboard — deliberately
+    // eye-catching (rather than, say, a plain gray box) so a placeholder
+    // reads as "an asset is missing" at a glance instead of quietly
+    // passing for a real, if plain, sprite.
+    const cellSize = Math.max(4, Math.min(16, Math.round(Math.min(canvas.width, canvas.height) / 4)));
+    for (let y = 0; y < canvas.height; y += cellSize) {
+        for (let x = 0; x < canvas.width; x += cellSize) {
+            const isEvenCell = (x / cellSize + y / cellSize) % 2 === 0;
+            context.fillStyle = isEvenCell ? "#ff00ff" : "#000000";
+            context.fillRect(x, y, cellSize, cellSize);
+        }
+    }
+    return canvas;
+};
 const runEngine = async (props) => {
     const runId = ++latestRunId;
     resetCanvas?.();
@@ -145,13 +174,20 @@ const runEngine = async (props) => {
     // leaking to the rest of the page (e.g. arrow keys scrolling the window).
     canvas.tabIndex = 0;
     let state = props.initialState;
+    const events = [];
+    // Lets a caller report something that happened outside the render loop
+    // (e.g. a fetch().then() callback) back into it — the event is queued
+    // here and delivered to nextState as a CustomGameEvent on the next tick,
+    // the same as any built-in event.
+    const sendEvent = (event) => {
+        events.push({ tag: "CUSTOM", event });
+    };
     const resources = props.resources ?? {};
     const resourceById = await iterateRecordAsync(resources, async ({ value }) => new Promise((resolve) => {
         const image = new Image();
-        image.src = value.src;
-        image.onload = function () {
+        const settle = (loadedImage) => {
             resolve({
-                image,
+                image: loadedImage,
                 size: {
                     width: value.size.width / value.slices.horizontal,
                     height: value.size.height / value.slices.vertical,
@@ -160,12 +196,25 @@ const runEngine = async (props) => {
                 animations: value.animations ?? {},
             });
         };
+        image.src = value.src;
+        image.onload = () => settle(image);
+        // Missing/failed-to-load asset (see .gitignore's dist/resources/
+        // note) — a placeholder sheet, sized to match what this resource
+        // declared, keeps every frame/slice/animation index the example
+        // already computes valid instead of drawing nothing or throwing.
+        image.onerror = () => settle(createPlaceholderSheet(value.size));
     }));
     const loadAudio = (src) => new Promise((resolve) => {
         const audio = new Audio(src);
         audio.oncanplaythrough = function () {
             resolve(audio);
         };
+        // Missing/failed-to-load audio — resolve anyway instead of hanging
+        // this Promise (and every resource after it, via Promise.all)
+        // forever waiting for a "canplaythrough" that's never coming.
+        // playSound/playMusic below already no-op safely on an element
+        // that can't actually play.
+        audio.onerror = () => resolve(audio);
     });
     const sounds = props.sounds ?? {};
     const audioById = await iterateRecordAsync(sounds, ({ value }) => loadAudio(value.src));
@@ -178,15 +227,31 @@ const runEngine = async (props) => {
             return;
         }
         const instance = audio.cloneNode();
-        instance.play();
+        // A missing/failed-to-load sound (see loadAudio's onerror above)
+        // rejects here instead of playing — caught and dropped rather than
+        // left as an unhandled rejection, same as playMusic/resumeMusic below.
+        instance.play().catch(() => { });
     };
     const music = props.music ?? {};
     const musicById = await iterateRecordAsync(music, ({ value }) => loadAudio(value.src));
+    // Registered once per track at load time — fires only for a track
+    // whose `loop` is false, since a looping <audio> never reaches "ended"
+    // (the browser restarts it before the event would fire).
+    for (const id of getKeys(musicById)) {
+        musicById[id].addEventListener("ended", () => {
+            events.push({ tag: "MUSIC_END", id });
+        });
+    }
     // Unlike sounds, music reuses the same element instead of cloning it —
     // there's only ever one track playing, and reusing it is what lets
     // pauseMusic()/playMusic() resume from where playback left off instead
     // of starting over.
     let currentMusic = null;
+    // Volume is a property of each HTMLAudioElement, not global — tracked
+    // separately here and (re)applied on every playMusic() so switching
+    // tracks keeps the volume the game last set instead of resetting to
+    // each element's default of 1.
+    let musicVolume = 1;
     const playMusic = (id) => {
         const audio = musicById[id];
         if (audio === undefined) {
@@ -195,18 +260,28 @@ const runEngine = async (props) => {
         if (currentMusic !== null && currentMusic !== audio) {
             currentMusic.pause();
         }
-        audio.loop = true;
-        audio.play();
+        audio.loop = music[id]?.loop ?? true;
+        audio.volume = musicVolume;
+        audio.play().catch(() => { });
         currentMusic = audio;
     };
     const pauseMusic = () => {
         currentMusic?.pause();
     };
+    const resumeMusic = () => {
+        currentMusic?.play().catch(() => { });
+    };
+    const setMusicVolume = (volume) => {
+        musicVolume = Math.min(1, Math.max(0, volume));
+        if (currentMusic !== null) {
+            currentMusic.volume = musicVolume;
+        }
+    };
     // A newer runEngine() call started while this one was still loading
     // resources (e.g. a spritesheet) — abandon this run instead of setting
     // up a second, orphaned render loop alongside the newer one.
     if (runId !== latestRunId) {
-        return;
+        return { sendEvent };
     }
     context.imageSmoothingEnabled = false;
     // An offscreen 1x1 canvas used only to resolve a CSS color string (a
@@ -496,8 +571,7 @@ const runEngine = async (props) => {
     const nextStateFns = Array.isArray(props.nextState) ? props.nextState : [props.nextState];
     let lastFrame = Date.now();
     let hoveredId = null;
-    const events = [];
-    canvas.addEventListener("click", (ev) => {
+    const handleClick = (ev) => {
         const mouse = getCanvasPosition(ev);
         if (hoveredId === null)
             return;
@@ -506,7 +580,8 @@ const runEngine = async (props) => {
         if (hovered !== undefined && hovered.isClickable) {
             events.push({ tag: "CLICK", id: hovered.id, mouse, worldMouse: toWorldPosition(mouse, camera) });
         }
-    });
+    };
+    canvas.addEventListener("click", handleClick);
     const initialState = {
         keyboardState: createRecord(keyboardKeys, () => false),
     };
@@ -516,7 +591,7 @@ const runEngine = async (props) => {
     const currentState = {
         keyboardState: { ...initialState.keyboardState },
     };
-    canvas.addEventListener("keydown", (event) => {
+    const handleKeyDown = (event) => {
         const pressedKey = keyboardKeys.find((key) => key === event.code);
         if (pressedKey !== undefined) {
             // Stop tracked keys (arrows, space, ...) from also scrolling the
@@ -525,15 +600,17 @@ const runEngine = async (props) => {
             event.preventDefault();
             currentState.keyboardState[pressedKey] = true;
         }
-    });
-    canvas.addEventListener("keyup", (event) => {
+    };
+    canvas.addEventListener("keydown", handleKeyDown);
+    const handleKeyUp = (event) => {
         const releasedKey = keyboardKeys.find((key) => key === event.code);
         if (releasedKey !== undefined) {
             event.preventDefault();
             currentState.keyboardState[releasedKey] = false;
         }
-    });
-    canvas.addEventListener("mousemove", (ev) => {
+    };
+    canvas.addEventListener("keyup", handleKeyUp);
+    const handleMouseMoveHover = (ev) => {
         const mouse = getCanvasPosition(ev);
         const { renderables, camera } = renderState(state);
         const worldMouse = toWorldPosition(mouse, camera);
@@ -550,8 +627,9 @@ const runEngine = async (props) => {
             }
         }
         hoveredId = hovered === undefined ? null : hovered.id ?? null;
-    });
-    canvas.addEventListener("mousemove", (ev) => {
+    };
+    canvas.addEventListener("mousemove", handleMouseMoveHover);
+    const handleMouseMoveTracking = (ev) => {
         const mouse = getCanvasPosition(ev);
         if (hoveredId === null) {
             return;
@@ -561,7 +639,33 @@ const runEngine = async (props) => {
         if (hovered !== undefined && hovered.trackMouseMovement) {
             events.push({ tag: "MOUSE_MOVE", mouse, worldMouse: toWorldPosition(mouse, camera), id: hovered.id });
         }
-    });
+    };
+    canvas.addEventListener("mousemove", handleMouseMoveTracking);
+    // No further mousemove fires once the mouse is off the canvas, so this
+    // is also the only chance to report a HOVER_OUT for whatever was
+    // hovered when it left — otherwise that hover would just dangle,
+    // never explicitly ended.
+    const handleMouseLeave = (ev) => {
+        const mouse = getCanvasPosition(ev);
+        const { renderables, camera } = renderState(state);
+        const worldMouse = toWorldPosition(mouse, camera);
+        if (hoveredId !== null) {
+            const lastHovered = renderables.find((r) => r.id === hoveredId);
+            if (lastHovered !== undefined) {
+                events.push({ tag: "HOVER_OUT", id: lastHovered.id, mouse, worldMouse });
+            }
+        }
+        hoveredId = null;
+        events.push({ tag: "MOUSE_LEAVE", mouse, worldMouse });
+    };
+    canvas.addEventListener("mouseleave", handleMouseLeave);
+    // Tab switches are a document-level concern (visibilitychange), not
+    // something that ever reaches the canvas itself the way mouse/keyboard
+    // events do.
+    const handleVisibilityChange = () => {
+        events.push({ tag: window.document.hidden ? "TAB_BLUR" : "TAB_FOCUS" });
+    };
+    window.document.addEventListener("visibilitychange", handleVisibilityChange);
     context.imageSmoothingEnabled = false;
     // Scale is a canvas transform around the renderable's anchor, applied
     // before its type-specific drawing runs below — everything drawn under
@@ -612,6 +716,56 @@ const runEngine = async (props) => {
         tintBufferContext.globalCompositeOperation = "source-over";
         return tintBuffer;
     };
+    // Palette-swapped frames, keyed by resourceId + frame + the exact swap
+    // list — unlike tintedSpriteFrame's cheap multiply-blend (redone fresh
+    // every draw off one shared buffer), a swap needs real pixel work
+    // (getImageData over the whole frame), so each unique combination is
+    // computed once here and reused on every later draw instead. Grows for
+    // as long as new combinations keep showing up — fine for a fixed small
+    // set of recolors (e.g. team A/B/C), a bad fit for one that varies
+    // continuously (e.g. a randomized hue per instance), which would cache-
+    // miss every time and just accumulate.
+    const swappedFrameCache = new Map();
+    const swappedSpriteFrame = (resourceId, frame, image, source, swapColors) => {
+        const cacheKey = `${resourceId}:${frame}:${swapColors.map(({ from, to }) => `${from}>${to}`).join(",")}`;
+        const cached = swappedFrameCache.get(cacheKey);
+        if (cached !== undefined) {
+            return cached;
+        }
+        const canvas = window.document.createElement("canvas");
+        canvas.width = source.width;
+        canvas.height = source.height;
+        const swapContext = canvas.getContext("2d");
+        // No 2d context to work with (shouldn't happen in a real browser) —
+        // draw the untouched frame rather than crash.
+        if (swapContext === null) {
+            return image;
+        }
+        swapContext.drawImage(image, source.x, source.y, source.width, source.height, 0, 0, source.width, source.height);
+        // Resolved once per unique `from`/`to` pair (resolveColor caches by
+        // string), not per pixel — the pixel loop below only ever compares
+        // against these already-resolved bytes.
+        const resolvedSwaps = swapColors.map(({ from, to }) => ({
+            from: resolveColor(from),
+            to: resolveColor(to),
+        }));
+        const imageData = swapContext.getImageData(0, 0, canvas.width, canvas.height);
+        const pixels = imageData.data;
+        for (let i = 0; i < pixels.length; i += 4) {
+            for (const { from, to } of resolvedSwaps) {
+                if (pixels[i] === from[0] && pixels[i + 1] === from[1] && pixels[i + 2] === from[2] && pixels[i + 3] === from[3]) {
+                    pixels[i] = to[0];
+                    pixels[i + 1] = to[1];
+                    pixels[i + 2] = to[2];
+                    pixels[i + 3] = to[3];
+                    break;
+                }
+            }
+        }
+        swapContext.putImageData(imageData, 0, 0);
+        swappedFrameCache.set(cacheKey, canvas);
+        return canvas;
+    };
     const intervalId = setInterval(() => {
         const now = Date.now();
         const delta = now - lastFrame;
@@ -626,7 +780,16 @@ const runEngine = async (props) => {
                 };
             });
             for (const nextState of nextStateFns) {
-                const result = nextState({ state, event, keyboard, playSound, playMusic, pauseMusic });
+                const result = nextState({
+                    state,
+                    event,
+                    keyboard,
+                    playSound,
+                    playMusic,
+                    pauseMusic,
+                    resumeMusic,
+                    setMusicVolume,
+                });
                 // STOP stops the rest of the list from running for this event,
                 // instead of every later mechanic needing to repeat the same
                 // guard. undefined just means this mechanic made no change, so
@@ -673,7 +836,7 @@ const runEngine = async (props) => {
                 continue;
             }
             if (renderable.type === "SPRITE") {
-                const { opacity = 1, flipX = false, modulate } = renderable;
+                const { opacity = 1, flipX = false, modulate, swapColors } = renderable;
                 const resource = resourceById[renderable.resourceId];
                 const frame = {
                     x: renderable.frame % resource.slices.horizontal,
@@ -688,12 +851,23 @@ const runEngine = async (props) => {
                 };
                 const destWidth = resource.size.width;
                 const destHeight = resource.size.height;
-                // Tinting swaps in an already-tinted offscreen copy of this frame
-                // as the image to draw — everything past this point (flipX,
-                // positioning) treats it exactly like the untinted spritesheet,
-                // just drawn starting at (0, 0) instead of cropped from a sheet.
-                const image = modulate === undefined ? resource.image : tintedSpriteFrame(resource.image, source, modulate);
-                const imageSource = modulate === undefined ? source : { x: 0, y: 0, width: source.width, height: source.height };
+                // Swapping and tinting each swap in an already-processed offscreen
+                // copy of this frame as the image to draw from then on —
+                // everything past this point (flipX, positioning) treats it
+                // exactly like the untinted spritesheet, just drawn starting at
+                // (0, 0) instead of cropped from a sheet. Swap runs first (it's
+                // the sprite's "real" recolored identity), tint runs on top of
+                // that (e.g. a damage flash still applies over swapped colors).
+                let image = resource.image;
+                let imageSource = source;
+                if (swapColors !== undefined && swapColors.length > 0) {
+                    image = swappedSpriteFrame(renderable.resourceId, renderable.frame, image, imageSource, swapColors);
+                    imageSource = { x: 0, y: 0, width: source.width, height: source.height };
+                }
+                if (modulate !== undefined) {
+                    image = tintedSpriteFrame(image, imageSource, modulate);
+                    imageSource = { x: 0, y: 0, width: source.width, height: source.height };
+                }
                 context.globalAlpha = opacity;
                 const drawSprite = (destX, destY) => {
                     context.drawImage(image, imageSource.x, imageSource.y, imageSource.width, imageSource.height, destX, destY, destWidth, destHeight);
@@ -744,7 +918,34 @@ const runEngine = async (props) => {
     }, 0);
     resetCanvas = () => {
         clearInterval(intervalId);
+        // Otherwise a track started by this run keeps playing underneath
+        // whatever the next runEngine() call starts — currentMusic is a
+        // per-run element, not something the next run has any way to reach.
+        currentMusic?.pause();
+        currentMusic = null;
+        // The canvas element itself is only thrown away between runs if the
+        // caller replaces it — in the playground it's the same persistent
+        // <canvas id="yuuna"> across every example switch and every
+        // Auto-Reload keystroke, so its listeners have to be removed
+        // explicitly here too, or each run stacks its own click/mousemove/
+        // keyboard handlers on top of every previous run's. Those old
+        // handlers still fire (each still does its own hit-testing and
+        // renderState() call against its own now-frozen state) even though
+        // their interval is long since cleared, quietly costing more CPU per
+        // click/mousemove the more times a run's been replaced — and on a
+        // slow enough device or long enough playground session, that pile-up
+        // is what "clicks stop working" actually looks like.
+        canvas.removeEventListener("click", handleClick);
+        canvas.removeEventListener("keydown", handleKeyDown);
+        canvas.removeEventListener("keyup", handleKeyUp);
+        canvas.removeEventListener("mousemove", handleMouseMoveHover);
+        canvas.removeEventListener("mousemove", handleMouseMoveTracking);
+        canvas.removeEventListener("mouseleave", handleMouseLeave);
+        // This one's on `document`, not the canvas — same reasoning as above,
+        // just doubly true since `document` isn't even scoped to this canvas.
+        window.document.removeEventListener("visibilitychange", handleVisibilityChange);
     };
+    return { sendEvent };
 };
 
 export { STOP, runEngine };

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yuuna-engine",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "A lightweight, state-machine-based TypeScript game engine for quick prototypes. Runs directly in the browser.",
   "type": "module",
   "main": "./lib/index.cjs",