@combos-fun/plugin-renderer-sprite 0.0.45 → 0.0.46

package/agent-skill.md

@@ -1,63 +1,31 @@
 # `@combos-fun/plugin-renderer-sprite` — Agent notes
 
-Sprite atlas rendering for the 2D pipeline. Renders a single named sprite out of a packed atlas (Texture Packer JSON + image sheet).
-
-## When to read
-
-Read when you have a packed sprite atlas and need to draw a single named frame (UI icons grouped in a sheet, character portraits, item icons).
-
-## Public API
+Read only for one named frame from a packed atlas. Use `Img` for a standalone image and `SpriteAnimation` to play atlas frames.
 
 ```ts
 import { Sprite, SpriteSystem, type SpriteParams } from '@combos-fun/plugin-renderer-sprite';
 ```
 
-`componentName = 'Sprite'`, `systemName = 'Sprite'` (class is `SpriteSystem` — use `game.getSystem(SpriteSystem)`, not the string).
-
-### `SpriteParams`
-
-| Field | Type | Notes |
-|-------|------|-------|
-| `resource` | `string` | Engine resource name registered with `RESOURCE_TYPE.SPRITE`. Source must include both `image` and `json`. |
-| `spriteName` | `string` | Frame name from the atlas JSON |
-
-Side effect: importing this package registers `SPRITE` resource handlers on the engine `resource` singleton.
-
-Internal cache key: `resource + '_s|r|c_' + spriteName`.
-
-## Required setup
-
-`RendererSystem` then `SpriteSystem`. Resource must be registered with both `image` and `json` URLs:
+`Sprite.componentName = 'Sprite'`; `SpriteSystem.systemName = 'Sprite'`.
 
 ```ts
-import { RESOURCE_TYPE, resource } from '@combos-fun/engine';
-
-resource.addResource([{
-  name: 'icons',
-  type: RESOURCE_TYPE.SPRITE,
-  src: {
-    image: { type: 'png', url: 'https://cdn.example/icons.png' },
-    json: { type: 'json', url: 'https://cdn.example/icons.json' },
-  },
-  preload: true,
-}]);
+interface SpriteParams {
+  resource: string;   // RESOURCE_TYPE.SPRITE name
+  spriteName: string; // exact atlas frames key
+}
 ```
 
-## Common pitfalls
+Importing the package registers the SPRITE instance and destroy handlers. The resource must supply atlas image and JSON data. Frame keys are prefixed as:
 
-| Symptom | Fix |
-|---------|-----|
-| Resource not found | Both `image` and `json` are required for `RESOURCE_TYPE.SPRITE` |
-| Wrong frame | `spriteName` must exactly match a key in the atlas JSON |
-| Tearing / wrong size | Atlas frame may have padding; trim padding in the export tool |
+```ts
+resource + RESOURCE_KEY_SPLIT + spriteName
+```
 
-## Minimal example
+Pixi `Spritesheet.parse()` also registers these keys in the Texture cache, so
+`Texture.from(cacheKey)` consumers such as NinePatch can resolve them.
 
 ```ts
-const icon = new GameObject('coin-icon', { position: { x: 50, y: 50 }, size: { width: 64, height: 64 } });
 icon.addComponent(new Sprite({ resource: 'icons', spriteName: 'coin' }));
 ```
 
-## Verification
-
-`pnpm --filter @combos-fun/plugin-renderer-sprite run build`.
+Display dimensions follow `Transform.size`, not the source frame. The system observes `spriteName`, not `resource`; treat `resource` as construction-time configuration rather than expecting assignment to it alone to redraw.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combos-fun/plugin-renderer-sprite",
-  "version": "0.0.45",
+  "version": "0.0.46",
   "description": "Sprite atlas rendering",
   "main": "index.js",
   "module": "dist/plugin-renderer-sprite.esm.js",
@@ -36,10 +36,10 @@
   "author": "sun668 <q947692259@gmail.com>",
   "dependencies": {
     "pixi.js": "^8.18.1",
-    "@combos-fun/renderer-adapter": "0.0.45",
-    "@combos-fun/plugin-renderer": "0.0.45",
-    "@combos-fun/engine": "0.0.45",
-    "@combos-fun/inspector-decorator": "0.0.45"
+    "@combos-fun/renderer-adapter": "0.0.46",
+    "@combos-fun/plugin-renderer": "0.0.46",
+    "@combos-fun/inspector-decorator": "0.0.46",
+    "@combos-fun/engine": "0.0.46"
   },
   "scripts": {
     "build": "node ../../scripts/build-package.mjs"