hz-particles 1.3.0 → 1.4.0

package/README.md

@@ -19,10 +19,9 @@ export function Scene() {
 }
 ```
 
-<!-- TODO: fill in the real public URLs (see PR / message) -->
-- **Prompt FX generator / editor:** https://YOUR-SITE
-- **Live demo:** https://YOUR-SITE/demo
-- **Docs:** https://YOUR-SITE/docs
+- **Prompt FX generator / editor:** https://particles.hole.zone/editor
+- **Gallery (live WebGPU previews):** https://particles.hole.zone/discover
+- **Docs:** https://particles.hole.zone/docs
 - **NPM:** https://www.npmjs.com/package/hz-particles
 
 ## Why hz-particles?
@@ -59,6 +58,10 @@ HZ editor (manual or prompt)  →  preset (JSON / .hzfx)  →  faithful WebGPU r
   frustum, hemisphere, disc, annulus, arc, spiral, polygon, `cubeSurface`, `sphereSurface`,
   `boxFrame`, and more
 - **Real-time physics** — gravity, attractors, drag, velocity, lifetime
+- **Particle orientation modes** — `billboard` (fixed/random/velocity-aligned), `oriented` (a fixed
+  world angle via Euler `orientX/Y/Z`), and `cylindrical` (upright, faces the camera horizontally)
+- **Keyframe animation** — animate per-system parameters over time with curves + easing
+  (`keyframes` + `keyframesEnabled`), driven by the unified clock; per-emitter `startAt` sequencing
 - **Serialized presets** — self-contained `.hzfx` binary package (textures + GLB inlined) or plain JSON
 - **3D object support** — static 3D objects alongside particle systems
 
@@ -296,6 +299,11 @@ Presets are plain `SceneData`. A few key per-system fields:
 | `bloom` | `boolean` | Enable bloom glow on particles |
 | `gravity` | `number` | Gravity strength applied to particles |
 | `damping` | `number` | Velocity damping factor (0 = no drag, 1 = full stop) |
+| `rotationMode` | `string` | Particle orientation: `fixed` / `random` / `velocity` (billboard), `oriented` (fixed world angle), `cylindrical` (upright, camera-facing) |
+| `orientX` / `orientY` / `orientZ` | `number` | Euler angles (radians) for `rotationMode: 'oriented'` |
+| `keyframesEnabled` | `boolean` | Enable keyframe animation of system parameters over time |
+| `keyframes` | `object` | Per-parameter keyframe tracks (value + curve/easing) applied via the clock |
+| `startAt` | `number` | Delay (seconds) before this emitter starts, for relative sequencing |
 | `emissionTrailEnabled` | `boolean` | Enable particle trail rendering |
 | `emissionTrailDuration` | `number` | How long trail segments persist (seconds) |
 | `emissionTrailWidth` | `number` | Width of the emission trail |
@@ -469,9 +477,8 @@ Also exported for advanced usage:
 Generate effects from a prompt — or build them by hand — in the HZ editor, then export a preset and
 render it with this package.
 
-<!-- TODO: replace with the public editor URL -->
-- Hosted editor & prompt FX generator: https://YOUR-SITE
-- Local: `http://localhost:8110/editor` (run `docker-compose up` from the repo root)
+- Hosted editor & prompt FX generator: https://particles.hole.zone/editor
+- Browse the community gallery (live previews): https://particles.hole.zone/discover
 
 The editor provides real-time configuration, emitter-shape tuning, GLB import + animation control, a
 preset library, and `JSON` / `.hzfx` export.
@@ -487,4 +494,4 @@ preset library, and `JSON` / `.hzfx` export.
 
 MIT License — see [LICENSE](LICENSE).
 
-Copyright (c) 2025 HZ
+Copyright (c) 2025-2026 HZ