@combos-fun/plugin-renderer-tiling-sprite 0.0.6 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,27 @@
1
1
  # @combos-fun/plugin-renderer-tiling-sprite
2
2
 
3
- Internal workspace package (Combos Fun monorepo).
3
+ @combos-fun/plugin-renderer-tiling-sprite part of the Combos Fun engine monorepo.
4
+
5
+ Keywords: `tiling`, `background`, `parallax`, `scroll`, `tile`, `2d`.
6
+
7
+ ## Documentation
8
+
9
+ - Per-package agent / developer notes: [`agent-skill.md`](./agent-skill.md)
10
+ - Machine-readable manifest: [`combos-plugin.json`](./combos-plugin.json)
11
+ (validated against `schemas/combos-plugin.schema.json` in the repo
12
+ root)
13
+ - Entry skill (single source of truth for AI agents working with this
14
+ monorepo): `skills/combos-engine-development/SKILL.md`
15
+
16
+ When consumed from npm, the manifest and agent notes are exposed as
17
+ stable subpaths:
18
+
19
+ ```ts
20
+ import manifest from '@combos-fun/plugin-renderer-tiling-sprite/plugin-manifest';
21
+ // or fetch the markdown directly:
22
+ // require.resolve('@combos-fun/plugin-renderer-tiling-sprite/agent-skill')
23
+ ```
24
+
25
+ ## License
26
+
27
+ Internal workspace package, part of the Combos Fun engine monorepo.
package/agent-skill.md ADDED
@@ -0,0 +1,58 @@
1
+ # `@combos-fun/plugin-renderer-tiling-sprite` — Agent notes
2
+
3
+ Repeating tiled texture for the 2D pipeline. Wraps Pixi `TilingSprite`,
4
+ useful for backgrounds, parallax layers, scrolling floors.
5
+
6
+ ## When to read
7
+
8
+ Read for any tiling background, parallax layer, or scrolling pattern.
9
+
10
+ ## Public API
11
+
12
+ ```ts
13
+ import { TilingSprite, TilingSpriteSystem, type TilingSpriteParams } from '@combos-fun/plugin-renderer-tiling-sprite';
14
+ ```
15
+
16
+ `componentName = 'TilingSprite'`, `systemName = 'TilingSpriteSystem'`.
17
+
18
+ ### `TilingSpriteParams`
19
+
20
+ | Field | Type | Default | Notes |
21
+ |-------|------|---------|-------|
22
+ | `resource` | `string` | — | Engine resource name (`RESOURCE_TYPE.IMAGE`) |
23
+ | `tileScale` | `{ x, y }` | `{ x: 1, y: 1 }` | Per-tile scale |
24
+ | `tilePosition` | `{ x, y }` | `{ x: 0, y: 0 }` | Tile UV offset; animate this for scrolling effects |
25
+
26
+ Total tile area uses `Transform.size`.
27
+
28
+ ## Required setup
29
+
30
+ `RendererSystem` then `TilingSpriteSystem`. Resource must be registered
31
+ and loaded before the component is added.
32
+
33
+ ## Common pitfalls
34
+
35
+ | Symptom | Fix |
36
+ |---------|-----|
37
+ | Tiles cover entire canvas | Set `Transform.size` to the desired tile area |
38
+ | Visible seams | Use a seamless texture (POT / power-of-two), set `tileScale` to integer values |
39
+ | Scroll feels jumpy | Increment `tilePosition` by a per-frame `delta`, not a fixed amount per tick |
40
+
41
+ ## Minimal example
42
+
43
+ ```ts
44
+ const bg = new GameObject('bg');
45
+ bg.addComponent(new Transform({ position: { x: 0, y: 0 }, size: { x: 750, y: 1334 } }));
46
+ bg.addComponent(new TilingSprite({
47
+ resource: 'bg-tile',
48
+ tileScale: { x: 1, y: 1 },
49
+ tilePosition: { x: 0, y: 0 },
50
+ }));
51
+ ```
52
+
53
+ To animate scrolling, drive `tilePosition` from a custom Component's
54
+ `update(delta)`, not from bootstrap.
55
+
56
+ ## Verification
57
+
58
+ `pnpm --filter @combos-fun/plugin-renderer-tiling-sprite run build`.
@@ -0,0 +1,11 @@
1
+ {
2
+ "name": "@combos-fun/plugin-renderer-tiling-sprite",
3
+ "pluginId": "renderer-tiling-sprite",
4
+ "category": "rendering",
5
+ "dimension": "2d",
6
+ "isCore": false,
7
+ "keywords": ["tiling", "background", "parallax", "scroll", "tile", "2d"],
8
+ "agentSkill": "./agent-skill.md",
9
+ "requires": ["@combos-fun/engine", "@combos-fun/plugin-renderer"],
10
+ "exports": ["TilingSprite", "TilingSpriteSystem"]
11
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@combos-fun/plugin-renderer-tiling-sprite",
3
- "version": "0.0.6",
3
+ "version": "0.0.7",
4
4
  "description": "@combos-fun/plugin-renderer-tiling-sprite",
5
5
  "main": "index.js",
6
6
  "module": "dist/plugin-renderer-tiling-sprite.esm.js",
@@ -8,8 +8,22 @@
8
8
  "unpkg": "dist/CombosFun.plugin.renderer.tilingSprite.min.js",
9
9
  "files": [
10
10
  "index.js",
11
- "dist"
11
+ "dist",
12
+ "agent-skill.md",
13
+ "combos-plugin.json"
12
14
  ],
15
+ "exports": {
16
+ ".": {
17
+ "import": "./dist/plugin-renderer-tiling-sprite.esm.js",
18
+ "require": "./index.js",
19
+ "types": "./dist/plugin-renderer-tiling-sprite.d.ts"
20
+ },
21
+ "./plugin-manifest": "./combos-plugin.json",
22
+ "./agent-skill": "./agent-skill.md"
23
+ },
24
+ "combos": {
25
+ "pluginManifest": "./combos-plugin.json"
26
+ },
13
27
  "types": "dist/plugin-renderer-tiling-sprite.d.ts",
14
28
  "keywords": [
15
29
  "combos-fun",
@@ -18,10 +32,10 @@
18
32
  "author": "sun668 <q947692259@gmail.com>",
19
33
  "dependencies": {
20
34
  "pixi.js": "^8.18.1",
21
- "@combos-fun/plugin-renderer": "0.0.6",
22
- "@combos-fun/renderer-adapter": "0.0.6",
23
- "@combos-fun/inspector-decorator": "0.0.6",
24
- "@combos-fun/engine": "0.0.6"
35
+ "@combos-fun/plugin-renderer": "0.0.7",
36
+ "@combos-fun/renderer-adapter": "0.0.7",
37
+ "@combos-fun/engine": "0.0.7",
38
+ "@combos-fun/inspector-decorator": "0.0.7"
25
39
  },
26
40
  "scripts": {
27
41
  "build": "node ../../scripts/build-package.mjs"