@combos-fun/plugin-renderer-3d-sprite-animation 0.0.6 → 0.0.7

package/README.md

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

package/agent-skill.md

@@ -0,0 +1,63 @@
+# `@combos-fun/plugin-renderer-3d-sprite-animation` — Agent notes
+
+Spritesheet animation projected onto a `PlaneGeometry` in 3D space.
+Animates UV offsets each frame to flip through frames from a Texture Packer
+JSON sheet.
+
+## When to read
+
+Read for any 2D-styled animation in a 3D scene: power-up effects, FX
+sprites, animated billboards, decals.
+
+## Public API
+
+```ts
+import { SpriteAnimation3D, SpriteAnimation3DSystem, type SpriteAnimation3DParams } from '@combos-fun/plugin-renderer-3d-sprite-animation';
+```
+
+`componentName = 'SpriteAnimation3D'`,
+`systemName = 'SpriteAnimation3DSystem'`.
+
+### `SpriteAnimation3DParams`
+
+| Field | Type | Default |
+|-------|------|---------|
+| `resource` | `string` | `''` (Texture Packer JSON URL — direct) |
+| `autoPlay` | `boolean` | `true` |
+| `speed` | `number` | `100` (ms per frame) |
+| `positionX` / `Y` / `Z` | `number` | `0` |
+| `rotationX` / `Y` / `Z` | `number` | `0` |
+| `scaleX` / `Y` | `number` | `1` (no `scaleZ` — plane is 2D) |
+
+The system loads the spritesheet JSON (array or hash format) and resolves
+the image URL **relative to the JSON path**.
+
+## Required setup
+
+`Renderer3DSystem` then `SpriteAnimation3DSystem`. The JSON must reference
+a co-located image file.
+
+## Common pitfalls
+
+| Symptom | Fix |
+|---------|-----|
+| Animation never starts | `autoPlay` defaults to `true`; if you set `false`, drive `play()` from a Component lifecycle hook |
+| Black plane | Image not loaded — verify the JSON's `image`/`meta.image` field resolves correctly relative to the JSON URL |
+| Frames in wrong order | Texture Packer hash format may not preserve order; export as array format |
+| Stuck on first frame | Single-frame sheet; verify the JSON contains multiple frame entries |
+
+## Minimal example
+
+```ts
+const fx = new GameObject('explosion');
+fx.addComponent(new SpriteAnimation3D({
+  resource: '/assets/explosion.json',
+  autoPlay: true,
+  speed: 80,
+  positionZ: -1,
+}));
+```
+
+## Verification
+
+`pnpm --filter @combos-fun/plugin-renderer-3d-sprite-animation run build`.

package/combos-plugin.json

@@ -0,0 +1,11 @@
+{
+  "name": "@combos-fun/plugin-renderer-3d-sprite-animation",
+  "pluginId": "renderer-3d-sprite-animation",
+  "category": "rendering",
+  "dimension": "3d",
+  "isCore": false,
+  "keywords": ["3d", "sprite", "animation", "spritesheet", "uv", "billboard"],
+  "agentSkill": "./agent-skill.md",
+  "requires": ["@combos-fun/engine", "@combos-fun/plugin-renderer-3d"],
+  "exports": ["SpriteAnimation3D", "SpriteAnimation3DSystem"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combos-fun/plugin-renderer-3d-sprite-animation",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "@combos-fun/plugin-renderer-3d-sprite-animation",
   "main": "index.js",
   "module": "dist/plugin-renderer-3d-sprite-animation.esm.js",
@@ -9,13 +9,27 @@
   "types": "dist/plugin-renderer-3d-sprite-animation.d.ts",
   "files": [
     "index.js",
-    "dist"
+    "dist",
+    "agent-skill.md",
+    "combos-plugin.json"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/plugin-renderer-3d-sprite-animation.esm.js",
+      "require": "./index.js",
+      "types": "./dist/plugin-renderer-3d-sprite-animation.d.ts"
+    },
+    "./plugin-manifest": "./combos-plugin.json",
+    "./agent-skill": "./agent-skill.md"
+  },
+  "combos": {
+    "pluginManifest": "./combos-plugin.json"
+  },
   "dependencies": {
     "three": "^0.172.0",
-    "@combos-fun/inspector-decorator": "0.0.6",
-    "@combos-fun/plugin-renderer-3d": "0.0.6",
-    "@combos-fun/engine": "0.0.6"
+    "@combos-fun/engine": "0.0.7",
+    "@combos-fun/inspector-decorator": "0.0.7",
+    "@combos-fun/plugin-renderer-3d": "0.0.7"
   },
   "scripts": {
     "build": "node ../../scripts/build-package.mjs"