@yagejs-addons/dialogue 0.1.0

package/README.md

@@ -0,0 +1,77 @@
+# @yagejs-addons/dialogue
+
+The first **YAGE addon** — an installable, opinionated dialogue system: a
+headless branching runner plus swappable, themeable presenters. Drop it into a
+scene, point it at a dialogue script, and get a working typewriter box (or
+speech bubble) with branching choices and inline markup — then re-theme or
+replace any piece without forking.
+
+Addons are the layer between engine plugins (`@yagejs/core`, `@yagejs/renderer`,
+…) and your game: real implementations of common gameplay patterns, opinionated
+enough to be worth installing, layered so the opinions stay overridable. See
+`packages/addons/AGENTS.md` for the authoring model.
+
+## Install
+
+```bash
+npm install @yagejs-addons/dialogue
+```
+
+The addon declares the engine packages as **peer dependencies**, so it reuses
+your single engine install rather than duplicating it. Install the engine
+yourself:
+
+```bash
+npm install @yagejs/core @yagejs/input @yagejs/renderer
+```
+
+- `@yagejs/core` and `@yagejs/input` are **required** peers — the headless
+  runner and the `DialogueController` use them.
+- `@yagejs/renderer` is the **optional** peer — only the `./presenters` subpath
+  needs it (and it brings `pixi.js` transitively, so you never install pixi
+  yourself). If you consume only the headless runner you can skip it.
+
+## Two entry points
+
+The package is split so the headless path never pulls a renderer:
+
+```ts
+// Headless + input only — no pixi, fully unit-testable.
+import { DialogueRunner, DialogueController } from "@yagejs-addons/dialogue";
+
+// Pixi presentation — Graphics chrome + canvas text, themes, factories.
+import { defaultTheme, createBoxDialogue } from "@yagejs-addons/dialogue/presenters";
+```
+
+| Entry          | Imports                          | Contains                                                                 |
+| -------------- | -------------------------------- | ----------------------------------------------------------------------- |
+| `.`            | `@yagejs/core`, `@yagejs/input`  | runner, session, types, markup, i18n, canonical format, events, `DialogueController`, input bindings |
+| `./presenters` | + `@yagejs/renderer` (brings pixi)  | chrome, text views, composites, avatars, factories, `defaultTheme()`, textured nine-slice variants, radial (experimental) |
+
+## Defaults & opt-ins
+
+- **Default presenters are zero-asset**: Graphics objects for chrome plus canvas
+  `SplitText`/`Text` for the typewriter, with native bold/italic and per-glyph
+  effects. `defaultTheme()` gives you a working look with no bundled files.
+- **Bitmap fonts** (baked variant atlases via `bakeBitmapFont`) are an **opt-in**
+  theme path, not the default.
+- **Textured chrome/bubble** (nine-slice from your own textures) is an **opt-in**
+  variant; pass texture fields on the theme.
+- **Radial choice presenter** is exported under `./presenters` as
+  **`@experimental`** — not polished, opt-in only.
+
+## Save / load
+
+Snapshot/restore is **deferred to v1.1**. The runner keeps its cursor reachable
+through read-only getters so a `SnapshotContributor` (`@yagejs/save`) can be
+added later without a breaking change.
+
+## Publishing caveat (`@yagejs-addons` scope)
+
+Addons live under the **`@yagejs-addons` npm scope** — a separate org from the
+engine's `@yagejs` scope. The scope is the only category marker (no
+`-toolkit`/`-system` suffixes). Addons are **independently versioned**: they are
+deliberately kept out of the engine's `fixed` changeset group, so engine
+releases never force an addon bump and vice-versa. Publishing requires
+membership in the `@yagejs-addons` org and `publishConfig.access: "public"`
+(already set here).

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@yagejs-addons/dialogue",
+  "version": "0.1.0",
+  "description": "Dialogue runner, branching, and swappable presenters for YAGE — the first YAGE addon",
+  "keywords": [
+    "yage",
+    "yage-addon",
+    "game-engine",
+    "2d",
+    "typescript",
+    "dialogue",
+    "narrative",
+    "branching",
+    "visual-novel"
+  ],
+  "license": "MIT",
+  "author": "Marco Lepore",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marco-lepore/yage.git",
+    "directory": "packages/addons/dialogue"
+  },
+  "homepage": "https://yage.dev",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./presenters": {
+      "import": {
+        "types": "./dist/presenters.d.ts",
+        "default": "./dist/presenters.js"
+      },
+      "require": {
+        "types": "./dist/presenters.d.cts",
+        "default": "./dist/presenters.cjs"
+      }
+    },
+    "./yaml": {
+      "import": {
+        "types": "./dist/yaml.d.ts",
+        "default": "./dist/yaml.js"
+      },
+      "require": {
+        "types": "./dist/yaml.d.cts",
+        "default": "./dist/yaml.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/",
+    "test": "vitest run",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "yaml": "^2.8.3"
+  },
+  "peerDependencies": {
+    "@yagejs/core": ">=0.8.0 <0.9.0",
+    "@yagejs/input": ">=0.8.0 <0.9.0",
+    "@yagejs/renderer": ">=0.8.0 <0.9.0"
+  },
+  "peerDependenciesMeta": {
+    "@yagejs/renderer": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.0.18",
+    "@yagejs/core": ">=0.7.0 <0.9.0",
+    "@yagejs/input": ">=0.7.0 <0.9.0",
+    "@yagejs/renderer": ">=0.7.0 <0.9.0",
+    "pixi.js": "^8.5.0"
+  }
+}