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

package/README.md

@@ -0,0 +1,27 @@
+# @combos-fun/plugin-renderer-3d-text
+
+@combos-fun/plugin-renderer-3d-text — part of the Combos Fun engine monorepo.
+
+Keywords: `3d`, `text`, `label`, `troika`, `font`.
+
+## 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-text/plugin-manifest';
+// or fetch the markdown directly:
+// require.resolve('@combos-fun/plugin-renderer-3d-text/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-text` — Agent notes
+
+3D text rendering for the 3D pipeline, backed by `troika-three-text`.
+Suitable for in-world labels, dialogue text, scoreboards.
+
+## When to read
+
+Read for any 3D text label: signs, score displays, floating tooltips.
+
+## Public API
+
+```ts
+import { Text3D, Text3DSystem, type Text3DParams } from '@combos-fun/plugin-renderer-3d-text';
+```
+
+`componentName = 'Text3D'`, `systemName = 'Text3DSystem'`.
+
+### `Text3DParams`
+
+| Field | Type | Default |
+|-------|------|---------|
+| `text` | `string` | `''` |
+| `fontSize` | `number` | `0.5` |
+| `color` | `number` | `0xffffff` |
+| `anchorX` | `string` | `'center'` |
+| `anchorY` | `string` | `'middle'` |
+| `maxWidth` | `number` | `0` (only applied when `> 0`) |
+| `font` | `string` | `''` (custom font URL when non-empty) |
+| `positionX` / `Y` / `Z` | `number` | `0` |
+| `rotationX` / `Y` / `Z` | `number` | `0` |
+
+There are **no scale fields**. Use `fontSize` to control size.
+
+## Required setup
+
+`Renderer3DSystem` then `Text3DSystem`. Custom fonts must be reachable
+via the URL specified in `font`.
+
+## Common pitfalls
+
+| Symptom | Fix |
+|---------|-----|
+| Text invisible | Empty `text` field, or `color` matching the background |
+| Text not sized | Use `fontSize`, not `scale*` (no scale fields exist) |
+| Wrap not applied | Set `maxWidth > 0` |
+| Custom font not loading | Wait for `troika-three-text` font load before relying on glyph metrics |
+
+## Minimal example
+
+```ts
+const sign = new GameObject('sign');
+sign.addComponent(new Text3D({
+  text: 'Welcome',
+  fontSize: 0.6,
+  color: 0xffffff,
+  positionY: 1.5,
+  positionZ: -2,
+}));
+```
+
+## Verification
+
+`pnpm --filter @combos-fun/plugin-renderer-3d-text run build`.

package/combos-plugin.json

@@ -0,0 +1,11 @@
+{
+  "name": "@combos-fun/plugin-renderer-3d-text",
+  "pluginId": "renderer-3d-text",
+  "category": "rendering",
+  "dimension": "3d",
+  "isCore": false,
+  "keywords": ["3d", "text", "label", "troika", "font"],
+  "agentSkill": "./agent-skill.md",
+  "requires": ["@combos-fun/engine", "@combos-fun/plugin-renderer-3d"],
+  "exports": ["Text3D", "Text3DSystem"]
+}

package/package.json

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