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

package/agent-skill.md

@@ -1,56 +1,29 @@
 # `@combos-fun/plugin-renderer-text` — Agent notes
 
-Text rendering for the 2D pipeline. Wraps Pixi v8 `Text` and auto-syncs `Transform.size` so other components see the rendered text bounds.
-
-## When to read
-
-Read for any 2D text label, score display, dialog text, or HUD title.
-
-## Public API
+Read only for 2D text labels. This is not bitmap-atlas text.
 
 ```ts
-import { Text, TextSystem, type TextParams } from '@combos-fun/plugin-renderer-text';
+import {
+  Text,
+  TextSystem,
+  type TextParams,
+  type TextStyleInput,
+  parseTextColor,
+  splitTextStyle,
+} from '@combos-fun/plugin-renderer-text';
 ```
 
-`componentName = 'Text'`, `systemName = 'Text'` (class is `TextSystem` — use `game.getSystem(TextSystem)`, not the string).
-
-### `TextParams`
-
-| Field | Type | Default |
-|-------|------|---------|
-| `text` | `string` | — (required) |
-| `style` | `TextStyleInput` | `{ fontSize: 20 }` |
-
-`style` is Pixi **v8** `TextStyle` / `TextStyleOptions`. Common safe fields:
-
-- `fill`, `fontFamily`, `fontSize`, `fontWeight`, `fontStyle`
-- `align`, `wordWrap`, `wordWrapWidth`, `breakWords`, `lineHeight`, `letterSpacing`, `leading`, `padding`
-- `stroke`, `dropShadow`, `backgroundColor`
-
-Do not treat “full Pixi TextStyle” as “any CSS text property”.
-
-`Transform.size` is updated automatically after rendering so layout components downstream can position around the actual bounds.
-
-## Required setup
-
-`RendererSystem` then `TextSystem`.
-
-## Common pitfalls
-
-| Symptom | Fix |
-|---------|-----|
-| Text invisible on dark background | Set `style.fill: 0xffffff` (default fill is dark) |
-| Wrap not working | Set `style.wordWrap: true` AND `style.wordWrapWidth: <px>` |
-| Custom font not loading | Load the webfont before adding the component (e.g. `document.fonts.load(...)`) |
-| Updating `text` doesn't refresh | The system observes the Component — make sure you assign via the component instance, not via Pixi internals |
+`Text.componentName = 'Text'`; `TextSystem.systemName = 'Text'`.
 
-## Minimal example
+`TextParams.text` is required. `style` is optional and starts with `{ fontSize: 20 }`; supplied fields merge into that object. `TextStyleInput` accepts Pixi v8 `TextStyle` fields plus Combos-only `backgroundColor`.
 
 ```ts
-const score = new GameObject('score', { position: { x: 20, y: 20 } });
-score.addComponent(new Text({ text: 'Score: 0', style: { fontSize: 32, fill: 0xffffff } }));
+score.addComponent(new Text({
+  text: 'Score: 0',
+  style: { fontSize: 32, fill: 0xffffff },
+}));
 ```
 
-## Verification
+Useful style fields include `fill`, font fields, `align`, wrapping fields, spacing, `stroke`, `dropShadow`, and `backgroundColor`; arbitrary CSS properties are not supported. Wrapping requires both `wordWrap: true` and `wordWrapWidth`.
 
-`pnpm --filter @combos-fun/plugin-renderer-text run build`.
+Text or style changes update the Pixi object, and rendered bounds overwrite `Transform.size`. Load custom webfonts before adding the Component. `splitTextStyle` removes `backgroundColor` before Pixi construction; `parseTextColor` accepts numeric colors, `#rgb`, `#rrggbb`/`#rrggbbaa`, and `0x...` strings.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combos-fun/plugin-renderer-text",
-  "version": "0.0.45",
+  "version": "0.0.46",
   "description": "Text rendering",
   "main": "index.js",
   "module": "dist/plugin-renderer-text.esm.js",
@@ -36,10 +36,10 @@
   "author": "sun668 <q947692259@gmail.com>",
   "dependencies": {
     "pixi.js": "^8.18.1",
-    "@combos-fun/plugin-renderer": "0.0.45",
-    "@combos-fun/inspector-decorator": "0.0.45",
-    "@combos-fun/engine": "0.0.45",
-    "@combos-fun/renderer-adapter": "0.0.45"
+    "@combos-fun/plugin-renderer": "0.0.46",
+    "@combos-fun/inspector-decorator": "0.0.46",
+    "@combos-fun/engine": "0.0.46",
+    "@combos-fun/renderer-adapter": "0.0.46"
   },
   "devDependencies": {
     "tsx": "^4.20.3"