pixi-effects 0.1.0 → 0.3.0

package/llms.txt

@@ -0,0 +1,30 @@
+# pixi-effects
+
+> Declarative motion graphics and video for the web. Describe a video as plain objects (text, shapes, images, video, audio, nested compositions, a 2.5D camera, optional three.js), play it in a canvas, export MP4 / WebM / MOV. Built on PixiJS v8, GSAP and mediabunny. Written to be authored by AI: no per-frame code.
+
+Rules that cause most failures (details in the skill and pitfalls):
+
+- Keyframe `at` is measured from the start of its own layer (negative = back from the layer's end). A layer's `at` and a transition's `at` are composition time.
+- Layers are hidden, not removed, after their lifespan; z-order is array order (later = on top).
+- Angles are degrees; +z is toward the viewer; any number can be an expression such as 'GW/2 - w/2'.
+- Anchors: rect/circle/ellipse are centred, text and image are top-left, compositions use pivotX/pivotY.
+- Verify by looking: seek with `await movie.gotoFrame(n, true)`, check at least 5 timestamps, and read `window.__logs` (library warnings are instructions).
+
+## Start here
+
+- [Skill: workflow and rules](https://raw.githubusercontent.com/yjmtmtk/pixi-effects/main/ai/SKILL.md): how to build, check and export a video; read first
+- [Cheatsheet](https://raw.githubusercontent.com/yjmtmtk/pixi-effects/main/ai/reference/cheatsheet.md): every layer type, prop, default and convention on one page
+- [Recipes](https://raw.githubusercontent.com/yjmtmtk/pixi-effects/main/ai/reference/recipes.md): tested building blocks (kinetic type, lower-third, count-up, bar chart, 2.5D title, camera orbit, slideshow with transitions, three.js)
+- [Pitfalls](https://raw.githubusercontent.com/yjmtmtk/pixi-effects/main/ai/reference/pitfalls.md): real mistakes made by AI authors, with fixes
+- [Starter template](https://raw.githubusercontent.com/yjmtmtk/pixi-effects/main/ai/template.html): copy this file to begin
+
+## Reference
+
+- [DSL reference](https://raw.githubusercontent.com/yjmtmtk/pixi-effects/main/docs/dsl.md): composition, sequences, 3D layers and camera, keyframes, expressions, filters, transitions, presets
+- [API reference](https://raw.githubusercontent.com/yjmtmtk/pixi-effects/main/docs/api.md): Movie, Controller, events, render options, pixi-effects/three
+- [README](https://raw.githubusercontent.com/yjmtmtk/pixi-effects/main/README.md): install, CDN import map, quickstart
+
+## Optional
+
+- [Everything above in one file](https://raw.githubusercontent.com/yjmtmtk/pixi-effects/main/llms-full.txt)
+- [Live demos and playground](https://yjmtmtk.github.io/pixi-effects/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pixi-effects",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Declarative composition and video rendering for the web. Built on PixiJS v8.",
   "type": "module",
   "exports": {
@@ -11,15 +11,20 @@
     "./controller": {
       "import": { "types": "./dist/Controller.d.ts", "default": "./dist/Controller.js" },
       "require": { "types": "./dist/Controller.d.cts", "default": "./dist/Controller.cjs" }
+    },
+    "./three": {
+      "import": { "types": "./dist/three.d.ts", "default": "./dist/three.js" },
+      "require": { "types": "./dist/three.d.cts", "default": "./dist/three.cjs" }
     }
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "files": ["dist", "README.md", "LICENSE"],
+  "files": ["dist", "ai", "docs/dsl.md", "docs/api.md", "llms.txt", "llms-full.txt", "CHANGELOG.md", "README.md", "LICENSE"],
   "keywords": [
     "pixi", "pixijs", "video", "composition", "compositing", "rendering",
-    "after-effects", "motion-graphics", "timeline", "webgl", "gsap", "keyframe", "typescript"
+    "after-effects", "motion-graphics", "timeline", "webgl", "gsap", "keyframe", "typescript",
+    "three", "threejs"
   ],
   "license": "MIT",
   "author": "tefista <tefista.dev@gmail.com>",
@@ -33,14 +38,19 @@
     "test": "vitest run",
     "test:watch": "vitest",
     "typecheck": "tsc --noEmit",
-    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+    "build:ai": "node scripts/build-llms.mjs",
+    "prepublishOnly": "npm run build:ai && npm run typecheck && npm test && npm run build"
   },
   "dependencies": {
-    "mediabunny": "^1.43.0"
+    "mediabunny": "^1.61.3"
   },
   "peerDependencies": {
     "gsap": "^3.12.0",
-    "pixi.js": "^8.0.0"
+    "pixi.js": "^8.0.0",
+    "three": ">=0.150.0"
+  },
+  "peerDependenciesMeta": {
+    "three": { "optional": true }
   },
   "devDependencies": {
     "tsup": "^8.0.0",
@@ -48,7 +58,9 @@
     "vitest": "^2.1.0",
     "happy-dom": "^15.0.0",
     "gsap": "^3.12.0",
-    "pixi.js": "^8.16.0"
+    "pixi.js": "^8.22.0",
+    "three": "^0.185.1",
+    "@types/three": "^0.185.0"
   },
   "engines": { "node": ">=18" }
 }