@combos-fun/renderer-adapter 0.0.6 → 0.0.7

package/README.md

@@ -1,3 +1,27 @@
 # @combos-fun/renderer-adapter
 
-Internal workspace package (Combos Fun monorepo).
+@combos-fun/renderer-adapter — part of the Combos Fun engine monorepo.
+
+Keywords: `pixi`, `adapter`, `display-object`, `wrapper`, `rendering`.
+
+## Documentation
+
+- Per-package agent / developer notes: [`agent-skill.md`](./agent-skill.md)
+- Machine-readable manifest: [`combos-plugin.json`](./combos-plugin.json)
+  (validated against `schemas/combos-plugin.schema.json` in the repo
+  root)
+- Entry skill (single source of truth for AI agents working with this
+  monorepo): `skills/combos-engine-development/SKILL.md`
+
+When consumed from npm, the manifest and agent notes are exposed as
+stable subpaths:
+
+```ts
+import manifest from '@combos-fun/renderer-adapter/plugin-manifest';
+// or fetch the markdown directly:
+// require.resolve('@combos-fun/renderer-adapter/agent-skill')
+```
+
+## License
+
+Internal workspace package, part of the Combos Fun engine monorepo.

package/agent-skill.md

@@ -0,0 +1,84 @@
+# `@combos-fun/renderer-adapter` — Agent notes
+
+Pixi v8 display-object adapter layer used by `@combos-fun/plugin-renderer` and
+its 2D rendering sub-plugins. **Not** a game `System`. It exposes a stable
+shape over Pixi primitives so 2D rendering plugins are not coupled to a
+specific Pixi version.
+
+## When to read
+
+Read whenever a 2D rendering task touches `Container` parenting, low-level
+Pixi display object shape, or whenever the entry skill loads "Core" packages
+for any project.
+
+## Public API
+
+Wrappers re-exported from `@combos-fun/renderer-adapter`:
+
+| Export | Wraps | Used by |
+|--------|-------|---------|
+| `Application` | `pixi.js` Application | `RendererSystem` (plugin-renderer) bootstrap |
+| `Container` | `PIXI.Container` | All container parenting via `containerManager` |
+| `Graphics` | `PIXI.Graphics` | `plugin-renderer-graphics` |
+| `Sprite` | `PIXI.Sprite` | `plugin-renderer-sprite`, `plugin-renderer-img` |
+| `SpriteAnimation` | Pixi animated sprite | `plugin-renderer-sprite-animation` |
+| `NinePatch` | nine-slice sprite | `plugin-renderer-nine-patch` |
+| `TilingSprite` | `PIXI.TilingSprite` | `plugin-renderer-tiling-sprite` |
+| `Text` | `PIXI.Text` | `plugin-renderer-text` |
+
+These are **adapter classes** — plugins consume them, end users typically do
+not import them directly.
+
+## Required setup
+
+None on the user side. Adapter is a dependency of `@combos-fun/plugin-renderer`
+and is loaded transitively. End users install the plugin packages, not the
+adapter directly.
+
+## Runtime behaviour
+
+- Each wrapper instantiates a Pixi display object and exposes a thin API used
+  by the matching renderer plugin.
+- All 2D rendering plugins reach Pixi via these wrappers; if you are
+  authoring a custom 2D rendering plugin, prefer extending `Renderer` from
+  `plugin-renderer` and constructing display objects via the matching adapter
+  type. Do **not** import `pixi.js` directly in plugin code.
+
+## Common pitfalls
+
+- Coupling a custom 2D rendering plugin directly to `pixi.js` means a Pixi
+  major bump can break the plugin. Use the adapter types instead.
+- Mixing adapter `Container` and raw `PIXI.Container` in the same scene
+  graph is not supported — `containerManager.getContainer(gameObject.id)`
+  returns the adapter type.
+
+## Minimal example
+
+Inside a custom 2D rendering plugin's `Renderer` subclass:
+
+```ts
+import { Sprite } from '@combos-fun/renderer-adapter';
+import { Renderer, RendererSystem } from '@combos-fun/plugin-renderer';
+
+class MyRenderer extends Renderer {
+  init() {
+    this.rendererSystem = this.game.getSystem(RendererSystem);
+    this.rendererSystem.rendererManager.register(this);
+  }
+  componentChanged(changed) {
+    if (changed.type === OBSERVER_TYPE.ADD) {
+      const sprite = new Sprite(/* ... */);
+      const container = this.rendererSystem.containerManager.getContainer(
+        changed.gameObject.id,
+      );
+      container.addChild(sprite);
+    }
+  }
+}
+```
+
+## Verification
+
+- `pnpm --filter @combos-fun/renderer-adapter run build` should succeed.
+- After upgrading `pixi.js`, run any example app from `examples/` to verify
+  no rendering regression.

package/combos-plugin.json

@@ -0,0 +1,20 @@
+{
+  "name": "@combos-fun/renderer-adapter",
+  "pluginId": "renderer-adapter",
+  "category": "core",
+  "dimension": "shared",
+  "isCore": true,
+  "keywords": ["pixi", "adapter", "display-object", "wrapper", "rendering"],
+  "agentSkill": "./agent-skill.md",
+  "requires": [],
+  "exports": [
+    "Application",
+    "Container",
+    "Graphics",
+    "NinePatch",
+    "Sprite",
+    "SpriteAnimation",
+    "Text",
+    "TilingSprite"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combos-fun/renderer-adapter",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "@combos-fun/renderer-adapter",
   "main": "index.js",
   "module": "dist/renderer-adapter.esm.js",
@@ -8,8 +8,22 @@
   "unpkg": "dist/CombosFun.rendererAdapter.min.js",
   "files": [
     "index.js",
-    "dist"
+    "dist",
+    "agent-skill.md",
+    "combos-plugin.json"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/renderer-adapter.esm.js",
+      "require": "./index.js",
+      "types": "./dist/renderer-adapter.d.ts"
+    },
+    "./plugin-manifest": "./combos-plugin.json",
+    "./agent-skill": "./agent-skill.md"
+  },
+  "combos": {
+    "pluginManifest": "./combos-plugin.json"
+  },
   "types": "dist/renderer-adapter.d.ts",
   "keywords": [
     "combos-fun",