@combos-fun/plugin-renderer-render 0.0.5 → 0.0.7

package/README.md

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

package/agent-skill.md

@@ -0,0 +1,48 @@
+# `@combos-fun/plugin-renderer-render` — Agent notes
+
+Per-`GameObject` visibility / alpha / zIndex / sortable-children control
+for the 2D pipeline. Without this plugin, every drawable is fully visible
+at alpha 1 and zIndex 0.
+
+## When to read
+
+Read whenever you need to hide / fade an object, change draw order, or
+turn on z-sorted children inside a container.
+
+## Public API
+
+```ts
+import { Render, RenderSystem, type RenderParams } from '@combos-fun/plugin-renderer-render';
+```
+
+`componentName = 'Render'`, `systemName = 'Render'`.
+
+| Field | Type | Default |
+|-------|------|---------|
+| `visible` | `boolean` | `true` |
+| `alpha` | `number` | `1` |
+| `zIndex` | `number` | `0` |
+| `sortableChildren` | `boolean` | `false` |
+
+## Required setup
+
+`RendererSystem` (from `plugin-renderer`) must be added before
+`RenderSystem`.
+
+## Common pitfalls
+
+| Symptom | Fix |
+|---------|-----|
+| Wrong stacking order | Set `sortableChildren: true` on the parent's `Render` and `zIndex` on children |
+| Object visible despite `visible: false` | Confirm `RenderSystem` is registered |
+| Fade has no effect | Confirm `alpha` is between 0 and 1 |
+
+## Minimal example
+
+```ts
+go.addComponent(new Render({ visible: true, alpha: 1, zIndex: 5 }));
+```
+
+## Verification
+
+`pnpm --filter @combos-fun/plugin-renderer-render run build`.

package/combos-plugin.json

@@ -0,0 +1,11 @@
+{
+  "name": "@combos-fun/plugin-renderer-render",
+  "pluginId": "renderer-render",
+  "category": "rendering",
+  "dimension": "2d",
+  "isCore": false,
+  "keywords": ["visibility", "alpha", "z-index", "sortable", "2d"],
+  "agentSkill": "./agent-skill.md",
+  "requires": ["@combos-fun/engine", "@combos-fun/plugin-renderer"],
+  "exports": ["Render", "RenderSystem"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combos-fun/plugin-renderer-render",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "@combos-fun/plugin-renderer-render",
   "main": "index.js",
   "module": "dist/plugin-renderer-render.esm.js",
@@ -8,8 +8,22 @@
   "unpkg": "dist/CombosFun.plugin.renderer.render.min.js",
   "files": [
     "index.js",
-    "dist"
+    "dist",
+    "agent-skill.md",
+    "combos-plugin.json"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/plugin-renderer-render.esm.js",
+      "require": "./index.js",
+      "types": "./dist/plugin-renderer-render.d.ts"
+    },
+    "./plugin-manifest": "./combos-plugin.json",
+    "./agent-skill": "./agent-skill.md"
+  },
+  "combos": {
+    "pluginManifest": "./combos-plugin.json"
+  },
   "types": "dist/plugin-renderer-render.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.5",
-    "@combos-fun/inspector-decorator": "0.0.5",
-    "@combos-fun/engine": "0.0.5",
-    "@combos-fun/plugin-renderer": "0.0.5"
+    "@combos-fun/plugin-renderer": "0.0.7",
+    "@combos-fun/renderer-adapter": "0.0.7",
+    "@combos-fun/engine": "0.0.7",
+    "@combos-fun/inspector-decorator": "0.0.7"
   },
   "scripts": {
     "build": "node ../../scripts/build-package.mjs"