@jayf0x/fluidity-js 0.2.4 → 0.2.6

package/llms.txt

@@ -6,7 +6,6 @@
 - GitHub: https://github.com/jayf0x/fluidity
 - Live demo: https://jayf0x.github.io/fluidity
 - License: MIT
-- Version: 0.2.2
 
 ## Install
 
@@ -35,8 +34,8 @@ import { FluidText, FluidImage } from '@jayf0x/fluidity-js';
 // Fluid image with aurora algorithm
 <FluidImage src="/hero.jpg" algorithm="aurora" />
 
-// With preset and custom config
-<FluidText text="Wicked" preset="neon" algorithm="glass" config={{ curl: 0.4 }} />
+// With preset and per-prop config (all FluidConfig fields are flat props)
+<FluidText text="Wicked" preset="neon" algorithm="glass" curl={0.4} />
 ```
 
 ## FluidText props
@@ -61,30 +60,33 @@ import { FluidText, FluidImage } from '@jayf0x/fluidity-js';
 
 | Prop | Type | Default |
 |------|------|---------|
-| config | Partial<FluidConfig> | — |
 | preset | PresetKey | — |
 | algorithm | FluidAlgorithm | 'standard' |
-| quality | FluidQuality | { dpr: 1, sim: 0.5 } |
+| pixelRatio | number | 1 |
+| simResolution | number | 0.5 |
 | backgroundColor | string | '#0a0a0a' |
 | backgroundSrc | string | — |
 | backgroundSize | string\|number | 'cover' |
-| isMouseEnabled | boolean | true |
-| isWorkerEnabled | boolean | true |
-| useWebGPU | boolean | true |
+| mouseEnabled | boolean | true |
+| workerEnabled | boolean | true |
+| webGPUEnabled | boolean | true |
 | className | string | — |
 | style | CSSProperties | — |
 
+All `FluidConfig` fields (e.g. `curl`, `splatRadius`, `waterColor`) are also valid flat props on both components.
+
 ## FluidHandle ref API
 
-Access via `useRef<FluidHandle>()` and `ref` prop:
+Access via `useRef<FluidHandle>()` and the `ref` prop:
 
 ```tsx
 const fluid = useRef<FluidHandle>(null);
 <FluidText ref={fluid} text="Touch me" />
+
 fluid.current?.splat(200, 200, 8, -4);
 fluid.current?.updateConfig({ curl: 0.5 });
 fluid.current?.reset();
-fluid.current?.move({ x: 100, y: 100, strength: 2 });
+fluid.current?.move(100, 100, 2);   // x, y, strength?
 ```
 
 ## Algorithms
@@ -101,43 +103,35 @@ fluid.current?.move({ x: 100, y: 100, strength: 2 });
 
 `calm` · `sand` · `wave` · `neon` · `smoke`
 
-## FluidConfig options
-
-| Key | Default | Description |
-|-----|---------|-------------|
-| densityDissipation | 0.992 | Ink persistence (0–1) |
-| velocityDissipation | 0.93 | Velocity decay (0–1) |
-| pressureIterations | 1 | Jacobi iterations |
-| curl | 0.0001 | Vorticity / swirl strength |
-| splatRadius | 0.004 | Brush radius |
-| splatForce | 0.91 | Brush force |
-| refraction | 0.25 | Background warp strength |
-| specularExp | 1.01 | Specular sharpness |
-| shine | 0.01 | Highlight intensity |
-| waterColor | [0,0,0] | Base fluid RGB (0–1 each) |
-| glowColor | [0.7,0.85,1.0] | Specular/glow RGB (0–1 each) |
-| warpStrength | 0.015 | UV warp (aurora algorithm) |
-
-## Quality control
+## FluidConfig options (normalized 0–1 space)
 
-```tsx
-// dpr: canvas backing resolution fraction (0.1–1)
-// sim: simulation FBO size fraction (0.1–1)
-<FluidText text="hello" quality={{ dpr: 0.75, sim: 0.25 }} />
-```
+Seven props accept normalized `0–1` values; `normalizeConfig` converts them to physics before the shader sees them. Values outside `[0, 1]` pass through as raw physics overrides.
+
+| Key | Description |
+|-----|-------------|
+| densityDissipation | Ink persistence |
+| velocityDissipation | Velocity decay |
+| pressureIterations | Jacobi iterations (integer) |
+| curl | Vorticity / swirl strength |
+| splatRadius | Brush radius |
+| splatForce | Brush force |
+| refraction | Background warp strength |
+| specularExp | Specular sharpness |
+| shine | Highlight intensity |
+| waterColor | Base fluid colour (CSS hex) |
+| glowColor | Specular/glow colour (CSS hex) |
+| warpStrength | UV warp (aurora algorithm) |
 
-Both axes are independent and reactive at runtime.
+See `src/core/config.ts` for exact defaults, preset values, and `PROP_RANGES`.
 
 ## TypeScript types
 
-All types are globally ambient — no import needed:
+All types are globally ambient — no import needed after installing the package:
 
 ```ts
-// Available globally after installing the package:
 FluidConfig
 FluidHandle
 FluidAlgorithm    // 'standard'|'glass'|'ink'|'aurora'|'ripple'
-FluidQuality      // { dpr: number; sim: number }
 PresetKey         // 'calm'|'sand'|'wave'|'neon'|'smoke'
 ```
 
@@ -149,7 +143,7 @@ React component (FluidText / FluidImage)
         └── FluidController
               ├── [worker mode]  Web Worker → FluidSimulation (OffscreenCanvas)
               └── [main mode]    FluidSimulation directly
-                    └── WebGPU path (FluidSimulation.create())
+                    ├── WebGPU path (FluidSimulation.create())
                     └── WebGL2 / WebGL1 fallback
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayf0x/fluidity-js",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "WebGPU-first real-time Navier-Stokes fluid simulation for React — interactive water, ink, glass, aurora, and ripple effects on text and images. Falls back to WebGL2/WebGL1. Runs in a Web Worker.",
   "type": "module",
   "module": "./dist/index.js",