@combos-fun/plugin-renderer-img 0.0.6 → 0.0.8

package/README.md

@@ -1,3 +1,27 @@
 # @combos-fun/plugin-renderer-img
 
-Internal workspace package (Combos Fun monorepo).
+@combos-fun/plugin-renderer-img — part of the Combos Fun engine monorepo.
+
+Keywords: `image`, `sprite`, `static`, `2d`.
+
+## 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/plugin-renderer-img/plugin-manifest';
+// or fetch the markdown directly:
+// require.resolve('@combos-fun/plugin-renderer-img/agent-skill')
+```
+
+## License
+
+Internal workspace package, part of the Combos Fun engine monorepo.

package/agent-skill.md

@@ -0,0 +1,53 @@
+# `@combos-fun/plugin-renderer-img` — Agent notes
+
+Static image rendering for the 2D pipeline. Loads an `IMAGE` resource and draws it as a Pixi `Sprite` under the GameObject's `Container`.
+
+## When to read
+
+Read whenever you need a single static image: icons, backgrounds, single-frame foregrounds.
+
+## Public API
+
+```ts
+import { Img, ImgSystem, type ImgParams } from '@combos-fun/plugin-renderer-img';
+import { resource, RESOURCE_TYPE } from '@combos-fun/engine';
+```
+
+`componentName = 'Img'`, `systemName = 'ImgSystem'`.
+
+### `ImgParams`
+
+| Field | Type | Notes |
+|-------|------|-------|
+| `resource` | `string` | Engine resource name registered with `RESOURCE_TYPE.IMAGE` |
+
+Side effect: importing the package registers `IMAGE` resource handlers on the engine `resource` singleton.
+
+## Required setup
+
+1. `RendererSystem` and `ImgSystem` registered in that order.
+2. `resource.addResource([{ name, src: '...png', preload: true }])` and
+   `name` matches the component's `resource`.
+
+## Common pitfalls
+
+| Symptom | Fix |
+|---------|-----|
+| Resource name not found | Ensure name matches `resource.addResource` and that loading completed (`preload: true` or wait `LOAD_EVENT.COMPLETE`) |
+| Image at origin (0,0) | Set `Transform.position` |
+| Wrong anchor | Set `Transform.origin: { x: 0.5, y: 0.5 }` for center anchoring |
+| Multiple drawables on same GO | Don't stack `Img` + `Sprite` — split GOs |
+
+## Minimal example
+
+```ts
+resource.addResource([{ name: 'logo', src: 'logo.png', preload: true }]);
+
+const go = new GameObject('logo');
+go.addComponent(new Transform({ position: { x: 100, y: 100 } }));
+go.addComponent(new Img({ resource: 'logo' }));
+```
+
+## Verification
+
+`pnpm --filter @combos-fun/plugin-renderer-img run build`.

package/combos-plugin.json

@@ -0,0 +1,11 @@
+{
+  "name": "@combos-fun/plugin-renderer-img",
+  "pluginId": "renderer-img",
+  "category": "rendering",
+  "dimension": "2d",
+  "isCore": false,
+  "keywords": ["image", "sprite", "static", "2d"],
+  "agentSkill": "./agent-skill.md",
+  "requires": ["@combos-fun/engine", "@combos-fun/plugin-renderer"],
+  "exports": ["Img", "ImgSystem"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combos-fun/plugin-renderer-img",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "@combos-fun/plugin-renderer-img",
   "main": "index.js",
   "module": "dist/plugin-renderer-img.esm.js",
@@ -8,8 +8,22 @@
   "unpkg": "dist/CombosFun.plugin.renderer.img.min.js",
   "files": [
     "index.js",
-    "dist"
+    "dist",
+    "agent-skill.md",
+    "combos-plugin.json"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/plugin-renderer-img.esm.js",
+      "require": "./index.js",
+      "types": "./dist/plugin-renderer-img.d.ts"
+    },
+    "./plugin-manifest": "./combos-plugin.json",
+    "./agent-skill": "./agent-skill.md"
+  },
+  "combos": {
+    "pluginManifest": "./combos-plugin.json"
+  },
   "types": "dist/plugin-renderer-img.d.ts",
   "keywords": [
     "combos-fun",
@@ -18,10 +32,10 @@
   "author": "sun668 <q947692259@gmail.com>",
   "dependencies": {
     "pixi.js": "^8.18.1",
-    "@combos-fun/renderer-adapter": "0.0.6",
-    "@combos-fun/engine": "0.0.6",
-    "@combos-fun/plugin-renderer": "0.0.6",
-    "@combos-fun/inspector-decorator": "0.0.6"
+    "@combos-fun/plugin-renderer": "0.0.8",
+    "@combos-fun/renderer-adapter": "0.0.8",
+    "@combos-fun/engine": "0.0.8",
+    "@combos-fun/inspector-decorator": "0.0.8"
   },
   "scripts": {
     "build": "node ../../scripts/build-package.mjs"