yuuna-engine 0.2.1 → 0.4.0

package/README.md

@@ -1,135 +1,133 @@
-<p align="center">
-  <img src="dist/resources/yuuna.png" alt="Yuuna" width="120" height="120" />
-</p>
-
-# Yuuna
-
-A lightweight, state-machine-based TypeScript game engine built for quick
-prototypes — drop it into a page and it's running, no editor or build step
-required. You describe your game as a `state`, a `render(state)` function,
-and a `nextState({ state, event, keyboard })` function — Yuuna owns the
-render loop, input handling, and canvas drawing. It's scratch paper for game
-ideas, not a replacement for Godot or Unity.
-
-## Install
-
-```sh
-npm install yuuna-engine
-```
-
-## Quick start
-
-Add a canvas with `id="yuuna"` to your page:
-
-```html
-<canvas id="yuuna"></canvas>
-```
-
-Then describe your game as state + render + nextState:
-
-```ts
-import { runEngine } from "yuuna-engine";
-
-type GameState = { cookies: number };
-
-runEngine<GameState>({
-  initialState: { cookies: 0 },
-
-  // Optional — size and color the canvas from code instead of HTML/CSS
-  canvas: { width: 960, height: 540, backgroundColor: "#0d1831" },
-
-  render: (state) => ({
-    renderables: [
-      {
-        type: "TEXT",
-        text: `${state.cookies} cookies`,
-        color: "black",
-        position: { x: 100, y: 50 },
-      },
-      {
-        type: "CIRCLE",
-        id: "cookie",
-        isClickable: true,
-        color: "brown",
-        position: { x: 50, y: 50 },
-        radius: 25,
-      },
-    ],
-  }),
-
-  nextState: ({ state, event }) => {
-    if (event.tag === "CLICK" && event.id === "cookie") {
-      return { cookies: state.cookies + 1 };
-    }
-
-    return state;
-  },
-});
-```
-
-## Concepts
-
-- **Renderables** — declarative shapes drawn each frame: `RECTANGLE`,
-  `CIRCLE`, `TEXT`, `SPRITE`, and `LINE`. Give one an `id` plus
-  `isClickable` / `isHoverable` / `trackMouseMovement` to make it
-  interactive.
-- **Events** — your `nextState` function receives one `GameEvent` per call:
-  `TIME` (frame tick with `delta`), `CLICK`, `HOVER_IN`, `HOVER_OUT`, or
-  `MOUSE_MOVE`.
-- **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.
-- **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) };
-    }
-  };
-
-  runEngine<GameState>({
-    initialState,
-    render,
-    nextState: [freezeOnGameOver, moveEnemies /* ... */],
-  });
-  ```
-
-## Development
-
-```sh
-yarn install
-yarn build   # builds lib/ (npm package) and dist/bundle.js (landing page)
-yarn watch   # rebuild on change
-```
-
-`dist/index.html` is the landing page — it loads `dist/bundle.js` in the
-browser via a global `Yuuna` object and embeds a live Monaco editor so
-visitors can edit and run a game directly on the page.
-
-## License
-
-MIT © [lucy-dot-exe](https://github.com/lucy-dot-exe)
+<p align="center">
+  <img src="dist/resources/yuuna.png" alt="Yuuna" width="120" height="120" />
+</p>
+
+# Yuuna
+
+[Live demo & playground](https://lucy-dot-exe.github.io/yuuna/) · [GitHub](https://github.com/lucy-dot-exe/yuuna)
+
+A lightweight, state-machine-based TypeScript game engine built for quick
+prototypes — drop it into a page and it's running, no editor or build step
+required. You describe your game as a `state`, a `render(state)` function,
+and a `nextState({ state, event, keyboard })` function — Yuuna owns the
+render loop, input handling, and canvas drawing. It's scratch paper for game
+ideas, not a replacement for Godot or Unity.
+
+## Install
+
+```sh
+npm install yuuna-engine
+```
+
+## Quick start
+
+Add a canvas with `id="yuuna"` to your page:
+
+```html
+<canvas id="yuuna"></canvas>
+```
+
+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 };
+
+// What that state looks like before anything has happened yet
+const initialState: GameState = { cookies: 0 };
+
+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: [
+      {
+        type: "TEXT",
+        text: `${state.cookies} cookies`,
+        color: "black",
+        position: { x: 100, y: 50 },
+      },
+      {
+        type: "CIRCLE",
+        id: "cookie",
+        isClickable: true,
+        color: "brown",
+        position: { x: 50, y: 50 },
+        radius: 25,
+      },
+    ],
+  }),
+
+  // 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 };
+    }
+
+    return state;
+  },
+});
+```
+
+## Concepts
+
+- **Renderables** — declarative shapes drawn each frame: `RECTANGLE`,
+  `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`, `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
+```
+
+[`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
+
+```sh
+yarn install
+yarn build   # builds lib/ (npm package) and dist/bundle.js (landing page)
+yarn watch   # rebuild on change
+```
+
+`dist/index.html` is the landing page — it loads `dist/bundle.js` in the
+browser via a global `Yuuna` object and embeds a live Monaco editor so
+visitors can edit and run a game directly on the page.
+
+## License
+
+MIT © [lucy-dot-exe](https://github.com/lucy-dot-exe)

package/lib/engine/types.d.ts

@@ -1,4 +1,18 @@
-export type RectangleRenderable = {
+type BaseRenderable = {
+    layer?: number;
+    scale?: {
+        x: number;
+        y: number;
+    };
+    modulate?: string;
+    children?: Renderable[];
+    screenSpace?: boolean;
+    id?: string;
+    isClickable?: boolean;
+    isHoverable?: boolean;
+    trackMouseMovement?: boolean;
+};
+export type RectangleRenderable = BaseRenderable & {
     type: "RECTANGLE";
     position: {
         x: number;
@@ -9,12 +23,8 @@ export type RectangleRenderable = {
         height: number;
     };
     color: string;
-    id?: string;
-    isClickable?: boolean;
-    isHoverable?: boolean;
-    trackMouseMovement?: boolean;
 };
-export type CircleRenderable = {
+export type CircleRenderable = BaseRenderable & {
     type: "CIRCLE";
     position: {
         x: number;
@@ -22,12 +32,8 @@ export type CircleRenderable = {
     };
     radius: number;
     color: string;
-    id?: string;
-    isClickable?: boolean;
-    isHoverable?: boolean;
-    trackMouseMovement?: boolean;
 };
-export type TextRenderable = {
+export type TextRenderable = BaseRenderable & {
     type: "TEXT";
     text: string;
     color: string;
@@ -39,12 +45,9 @@ export type TextRenderable = {
         x: "left" | "center" | "right";
         y: "bottom" | "middle" | "top";
     };
-    id?: string;
-    isClickable?: boolean;
-    isHoverable?: boolean;
-    trackMouseMovement?: boolean;
+    fontSize?: number;
 };
-export type SpriteRenderable = {
+export type SpriteRenderable = BaseRenderable & {
     type: "SPRITE";
     position: {
         x: number;
@@ -52,15 +55,10 @@ export type SpriteRenderable = {
     };
     resourceId: string;
     frame: number;
-    scale?: number;
     opacity?: number;
     flipX?: boolean;
-    id?: string;
-    isClickable?: boolean;
-    isHoverable?: boolean;
-    trackMouseMovement?: boolean;
 };
-export type LineRenderable = {
+export type LineRenderable = BaseRenderable & {
     type: "LINE";
     from: {
         x: number;
@@ -72,12 +70,29 @@ export type LineRenderable = {
     };
     color: string;
     width?: number;
-    id?: string;
-    isClickable?: boolean;
-    isHoverable?: boolean;
-    trackMouseMovement?: boolean;
 };
-export type Renderable = RectangleRenderable | CircleRenderable | SpriteRenderable | TextRenderable | LineRenderable;
+export type AnimatedSpriteRenderable = BaseRenderable & {
+    type: "ANIMATED_SPRITE";
+    position: {
+        x: number;
+        y: number;
+    };
+    resourceId: string;
+    animation: string;
+    timeScale?: number;
+    paused?: boolean;
+    opacity?: number;
+    flipX?: boolean;
+    id: string;
+};
+export type GroupRenderable = BaseRenderable & {
+    type: "GROUP";
+    position: {
+        x: number;
+        y: number;
+    };
+};
+export type Renderable = RectangleRenderable | CircleRenderable | SpriteRenderable | TextRenderable | LineRenderable | GroupRenderable | AnimatedSpriteRenderable;
 export type TimeEvent = {
     tag: "TIME";
     delta: number;
@@ -89,6 +104,10 @@ export type ClickEvent = {
         x: number;
         y: number;
     };
+    worldMouse: {
+        x: number;
+        y: number;
+    };
 };
 export type HoverInEvent = {
     tag: "HOVER_IN";
@@ -97,6 +116,10 @@ export type HoverInEvent = {
         x: number;
         y: number;
     };
+    worldMouse: {
+        x: number;
+        y: number;
+    };
 };
 export type HoverOutEvent = {
     tag: "HOVER_OUT";
@@ -105,6 +128,10 @@ export type HoverOutEvent = {
         x: number;
         y: number;
     };
+    worldMouse: {
+        x: number;
+        y: number;
+    };
 };
 export type MouseMoveEvent = {
     tag: "MOUSE_MOVE";
@@ -113,26 +140,43 @@ export type MouseMoveEvent = {
         x: number;
         y: number;
     };
+    worldMouse: {
+        x: number;
+        y: number;
+    };
+};
+export type MusicEndEvent = {
+    tag: "MUSIC_END";
+    id: string;
+};
+export type GameEvent = TimeEvent | ClickEvent | HoverInEvent | HoverOutEvent | MouseMoveEvent | MusicEndEvent;
+export type CustomGameEvent<Custom> = {
+    tag: "CUSTOM";
+    event: Custom;
 };
-export type GameEvent = TimeEvent | ClickEvent | HoverInEvent | HoverOutEvent | MouseMoveEvent;
-export type NextStateProps<State> = {
+export type NextStateProps<State, Custom = never> = {
     state: State;
-    event: GameEvent;
+    event: GameEvent | CustomGameEvent<Custom>;
     keyboard: Record<KeyboardKeys, {
         isPressed: boolean;
         isJustPressed: boolean;
         isJustReleased: boolean;
     }>;
+    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";
         renderables: Renderable[];
     };
-    nextState: NextStateFunction<State> | NextStateFunction<State>[];
+    nextState: NextStateFunction<State, Custom> | NextStateFunction<State, Custom>[];
     resources?: Record<string, {
         src: string;
         size: {
@@ -143,14 +187,33 @@ export type RunEngineProps<State> = {
             vertical: number;
             horizontal: number;
         };
+        animations?: Record<string, {
+            frames: number[];
+            frameDuration: number;
+            loop: boolean;
+        }>;
+    }>;
+    sounds?: Record<string, {
+        src: string;
+    }>;
+    music?: Record<string, {
+        src: string;
+        loop?: boolean;
     }>;
     canvas?: {
         width?: number;
         height?: number;
         backgroundColor?: string;
     };
+    camera?: (state: State) => {
+        x: number;
+        y: number;
+        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>;
@@ -158,3 +221,4 @@ export declare var Yuuna: {
     runEngine: RunEngineFunction;
     STOP: typeof STOP;
 };
+export {};