babylon.quarks 0.26.0 → 0.28.0

package/README.md

@@ -16,13 +16,15 @@ High-performance particle system for [Babylon.js](https://www.babylonjs.com/). B
 ## Features
 
 - **Batched rendering** — heterogeneous particle systems share draw calls via `BatchedRenderer`.
-- **Render modes** — billboard, vertical/horizontal billboard, stretched billboard, mesh particles, and **trails** (not available in Babylon's built-in particle systems).
-- **Sub-emitters** and a rich set of composable behaviors (color/size/speed over life, noise turbulence, forces, and more from `quarks.core`).
-- **Soft particles**, texture tile animation with blending, custom blend functions.
+- **Render modes** — billboard, vertical/horizontal billboard, stretched billboard, mesh particles, **trails** and **beams** (not available in Babylon's built-in particle systems).
+- **Sub-emitters** and a rich set of composable behaviors (color/size/speed over life, noise turbulence, forces, attractors, collision, and more from `quarks.core`).
+- **Texture effects** — per-texture UV layout (UV channel, tiling, offset, scroll), gradient maps, alpha erosion, UV distortion, flip, texture tile animation with blending, soft particles, custom blend functions, rim lighting on mesh particles, smoothed trails with curve tension.
+- **Trails** — texture modes (stretch, tile, per segment) with a texture scale, a minimum vertex distance and a lifetime (Unity's TrailRenderer settings), swept weapon trails along an emitter axis, world-space recording behind a moving emitter, and `clearTrails()` for teleports.
+- **Scene integration** — render order and rendering groups, layer masks, fog, bounds and frustum culling with Unity's culling modes, sort modes, screen-size limits, and an `EffectPool` that plays one-shot effects without allocating.
 - **Visual authoring** — design effects in our own [effect editor](https://soullnik.github.io/babylon.quarks-standalone/editor.html) or export them from Unity, then load with `QuarksLoader` (quarks.art-exported JSON also works — same format).
 - **Cross-engine format** — the same effect JSON runs in three.js (three.quarks) and Babylon.js.
 - **Adaptive performance** — optional frame-budget quality scaling built into `BatchedRenderer`.
-- **WebGL and WebGPU** — runs on both Babylon engines; shaders are transpiled to WGSL automatically.
+- **WebGL and WebGPU** — runs on both Babylon engines with native GLSL and WGSL shaders; nothing is transpiled or downloaded at run time.
 
 ## Install
 
@@ -30,7 +32,9 @@ High-performance particle system for [Babylon.js](https://www.babylonjs.com/). B
 npm install babylon.quarks @babylonjs/core
 ```
 
-Peer dependency: `@babylonjs/core` >= 9.
+Peer dependency: `@babylonjs/core` 9.x. The package ships ES module and CommonJS builds;
+`@babylonjs/core` is ES modules only, so `require('babylon.quarks')` needs a Node that can
+`require` ES modules (20.19 or 22.12 and later). Bundlers and `import` work everywhere.
 
 ## Quick start
 
@@ -121,7 +125,7 @@ The same bundle works in any plain `<script>` setup alongside the global `babylo
 
 ## WebGPU
 
-The library runs on Babylon's `WebGPUEngine` — its GLSL shaders are transpiled to WGSL automatically by Babylon (glslang/twgsl are fetched by Babylon on engine init). Everything except engine creation stays the same:
+The library runs on Babylon's `WebGPUEngine` with its own WGSL shaders: every GLSL shader has a WGSL twin that is picked when the engine is WebGPU, so Babylon never fetches a GLSL-to-WGSL transpiler (glslang/twgsl) for it, and a Content-Security-Policy that blocks `cdn.babylonjs.com` is no obstacle. Everything except engine creation stays the same:
 
 ```ts
 import {WebGPUEngine} from '@babylonjs/core/Engines/webgpuEngine';
@@ -132,7 +136,7 @@ await engine.initAsync();
 // Scene + BatchedRenderer setup is identical to WebGL.
 ```
 
-All render modes (billboard, stretched billboard, mesh, trail) are validated to create WebGPU pipelines with zero validation errors. The [live demos](https://soullnik.github.io/babylon.quarks-standalone/) and the [benchmark page](https://soullnik.github.io/babylon.quarks-standalone/benchmark.html) accept `?engine=webgpu` in the URL to switch engines.
+Every render mode (billboard, stretched billboard, mesh, trail, beam) and every shader variant (`shaderVariants()`) compiles under a real GLSL and a real WGSL compiler with zero errors (`npm run validate:shaders` in the monorepo, run in CI). The [live demos](https://soullnik.github.io/babylon.quarks-standalone/) and the [benchmark page](https://soullnik.github.io/babylon.quarks-standalone/benchmark.html) accept `?engine=webgpu` in the URL to switch engines.
 
 ## Unity-style emitter options
 
@@ -140,7 +144,7 @@ A few optional settings mirror Shuriken so Unity exports look the same; all are
 only written to the effect JSON when set.
 
 ```ts
-import {ConeEmitter, Quaternion, ShapeTransform, Vector2, Vector3} from 'quarks.core';
+import {ConeEmitter, Quaternion, ShapeTransform, Vector2, Vector3} from 'babylon.quarks';
 
 const system = new ParticleSystem({
     // Shape module Position / Rotation / Scale: spawn points and start directions go through it.
@@ -176,7 +180,7 @@ QuarksUtil.addToBatchRenderer(effect, batchRenderer);
 QuarksUtil.play(effect);
 ```
 
-See the [examples app](https://github.com/Soullnik/babylon.quarks-standalone/tree/main/examples) in the monorepo for 18 interactive demos and usage patterns.
+See the [examples app](https://github.com/Soullnik/babylon.quarks-standalone/tree/main/examples) in the monorepo for 24 interactive demos and usage patterns.
 
 ## Links