@wolffo/three-fire 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 typeWolffo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,194 @@
+# Three fire
+
+[![CI](https://github.com/username/threeFire/workflows/CI/badge.svg)](https://github.com/username/threeFire/actions)
+[![npm version](https://badge.fury.io/js/@wolffo%2Fthree-fire.svg)](https://badge.fury.io/js/@wolffo%2Fthree-fire)
+
+Modern TypeScript volumetric fire effect for Three.js and React Three Fiber.
+
+![fire](https://raw.githubusercontent.com/mattatz/THREE.Fire/master/Captures/fire.gif)
+
+## Features
+
+- 🔥 Volumetric fire effect using ray marching
+- 📦 TypeScript support with full type definitions
+- ⚛️ React Three Fiber component
+- 🎛️ Configurable parameters (iterations, octaves, noise scale, etc.)
+- 🚀 Modern Three.js compatibility (r150+)
+- 📱 Optimized for performance
+
+## Installation
+
+```bash
+npm install @wolffo/three-fire
+```
+
+## Usage
+
+### React Three Fiber (Recommended)
+
+```tsx
+import { Canvas } from '@react-three/fiber'
+import { Fire } from '@wolffo/three-fire'
+
+function App() {
+  return (
+    <Canvas>
+      <Fire
+        texture="/fire-texture.png"
+        color={0xff4400}
+        scale={[2, 3, 2]}
+        position={[0, 0, 0]}
+      />
+    </Canvas>
+  )
+}
+```
+
+### With custom parameters
+
+```tsx
+import { Fire, useFire } from '@wolffo/three-fire'
+
+function CustomFire() {
+  const fireRef = useFire()
+
+  return (
+    <Fire
+      ref={fireRef.ref}
+      texture="/fire-texture.png"
+      color={0xff6600}
+      magnitude={1.5}
+      lacunarity={2.5}
+      gain={0.7}
+      iterations={25}
+      octaves={4}
+      onUpdate={(fire, time) => {
+        // Custom update logic
+        fire.fireColor.setHSL((time * 0.1) % 1, 1, 0.5)
+      }}
+    />
+  )
+}
+```
+
+### Vanilla Three.js
+
+```ts
+import { FireMesh } from '@wolffo/three-fire'
+import { Scene, TextureLoader } from 'three'
+
+const scene = new Scene()
+const textureLoader = new TextureLoader()
+
+// Load fire texture
+const fireTexture = textureLoader.load('/fire-texture.png')
+
+// Create fire effect
+const fire = new FireMesh({
+  fireTex: fireTexture,
+  color: 0xff4400,
+  magnitude: 1.3,
+  iterations: 20,
+  octaves: 3
+})
+
+scene.add(fire)
+
+// Animation loop
+function animate() {
+  requestAnimationFrame(animate)
+
+  fire.update(performance.now() / 1000)
+  renderer.render(scene, camera)
+}
+animate()
+```
+
+## API Reference
+
+### FireComponent Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `texture` | `string \| Texture` | - | Fire texture URL or Three.js Texture object |
+| `color` | `Color \| string \| number` | `0xeeeeee` | Fire color |
+| `iterations` | `number` | `20` | Ray marching iterations (higher = better quality, lower performance) |
+| `octaves` | `number` | `3` | Noise octaves for turbulence |
+| `noiseScale` | `[number, number, number, number]` | `[1, 2, 1, 0.3]` | Noise scaling factors |
+| `magnitude` | `number` | `1.3` | Fire shape intensity |
+| `lacunarity` | `number` | `2.0` | Noise lacunarity |
+| `gain` | `number` | `0.5` | Noise gain |
+| `autoUpdate` | `boolean` | `true` | Auto-update time from useFrame |
+| `onUpdate` | `(fire, time) => void` | - | Custom update callback |
+
+### FireMesh Class
+
+```ts
+class FireMesh extends Mesh {
+  constructor(props: FireMeshProps)
+
+  // Methods
+  update(time?: number): void
+
+  // Properties
+  time: number
+  fireColor: Color
+  magnitude: number
+  lacunarity: number
+  gain: number
+}
+```
+
+## Fire Texture
+
+You need to provide a fire texture similar to the one shown below:
+
+![firetex](./src/Fire.png "Fire texture")
+
+The texture should be a grayscale gradient that defines the fire's density distribution.
+
+## Performance Tips
+
+- Lower `iterations` for better performance (try 10-15 for mobile)
+- Reduce `octaves` to 2 for simpler noise
+- Use texture compression for the fire texture
+- Consider using LOD (Level of Detail) for distant fires
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build the package
+npm run build
+
+# Type checking
+npm run typecheck
+
+# Run tests
+npm test
+```
+
+## Publishing
+
+This package uses automated GitHub Actions for publishing. See [PUBLISHING.md](./PUBLISHING.md) for detailed instructions.
+
+Quick release commands:
+```bash
+npm run release:patch  # 1.0.0 → 1.0.1
+npm run release:minor  # 1.0.0 → 1.1.0
+npm run release:major  # 1.0.0 → 2.0.0
+```
+
+## Credits
+
+Based on the original THREE.Fire by [mattatz](https://github.com/mattatz/THREE.Fire)
+
+- Real-Time procedural volumetric fire - http://dl.acm.org/citation.cfm?id=1230131
+- webgl-noise - https://github.com/ashima/webgl-noise
+- Three.js - https://threejs.org/
+
+## License
+
+MIT

package/dist/Fire.d.ts

@@ -0,0 +1,31 @@
+import { Mesh, ShaderMaterial, Texture, Color } from 'three';
+import { FireShaderUniforms } from './FireShader';
+export interface FireProps {
+    fireTex: Texture;
+    color?: Color | string | number;
+    iterations?: number;
+    octaves?: number;
+    noiseScale?: [number, number, number, number];
+    magnitude?: number;
+    lacunarity?: number;
+    gain?: number;
+}
+export declare class Fire extends Mesh {
+    material: ShaderMaterial & {
+        uniforms: FireShaderUniforms;
+    };
+    private _time;
+    constructor({ fireTex, color, iterations, octaves, noiseScale, magnitude, lacunarity, gain, }: FireProps);
+    update(time?: number): void;
+    get time(): number;
+    set time(value: number);
+    get fireColor(): Color;
+    set fireColor(color: Color | string | number);
+    get magnitude(): number;
+    set magnitude(value: number);
+    get lacunarity(): number;
+    set lacunarity(value: number);
+    get gain(): number;
+    set gain(value: number);
+}
+//# sourceMappingURL=Fire.d.ts.map

package/dist/Fire.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Fire.d.ts","sourceRoot":"","sources":["../src/Fire.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EAEJ,cAAc,EACd,OAAO,EACP,KAAK,EAMN,MAAM,OAAO,CAAA;AACd,OAAO,EAAc,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAE7D,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAA;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,qBAAa,IAAK,SAAQ,IAAI;IACb,QAAQ,EAAE,cAAc,GAAG;QAAE,QAAQ,EAAE,kBAAkB,CAAA;KAAE,CAAA;IAC1E,OAAO,CAAC,KAAK,CAAI;gBAEL,EACV,OAAO,EACP,KAAgB,EAChB,UAAe,EACf,OAAW,EACX,UAA2B,EAC3B,SAAe,EACf,UAAgB,EAChB,IAAU,GACX,EAAE,SAAS;IAkCL,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAWlC,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,IAAI,CAAC,KAAK,EAAE,MAAM,EAG5B;IAED,IAAW,SAAS,IAAI,KAAK,CAE5B;IAED,IAAW,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,EAElD;IAED,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED,IAAW,SAAS,CAAC,KAAK,EAAE,MAAM,EAEjC;IAED,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,EAElC;IAED,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,IAAI,CAAC,KAAK,EAAE,MAAM,EAE5B;CACF"}

package/dist/FireComponent.d.ts

@@ -0,0 +1,30 @@
+import React from 'react';
+import { ReactThreeFiber } from '@react-three/fiber';
+import { Fire as FireMesh, FireProps as FireMeshProps } from './Fire';
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        fire: ReactThreeFiber.Object3DNode<FireMesh, typeof FireMesh>;
+    }
+}
+export interface FireProps extends Omit<FireMeshProps, 'fireTex'> {
+    /** Fire texture URL or texture object */
+    texture: string | THREE.Texture;
+    /** Auto-update time from useFrame (default: true) */
+    autoUpdate?: boolean;
+    /** Custom update function */
+    onUpdate?: (fire: FireMesh, time: number) => void;
+    children?: React.ReactNode;
+}
+export interface FireRef {
+    /** Fire mesh instance */
+    fire: FireMesh | null;
+    /** Update fire manually */
+    update: (time?: number) => void;
+}
+export declare const FireComponent: React.ForwardRefExoticComponent<FireProps & React.RefAttributes<FireRef>>;
+export declare const useFire: () => {
+    ref: React.RefObject<FireRef>;
+    fire: FireMesh | null;
+    update: (time?: number) => void | undefined;
+};
+//# sourceMappingURL=FireComponent.d.ts.map

package/dist/FireComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FireComponent.d.ts","sourceRoot":"","sources":["../src/FireComponent.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA2D,MAAM,OAAO,CAAA;AAC/E,OAAO,EAAoB,eAAe,EAAa,MAAM,oBAAoB,CAAA;AACjF,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,QAAQ,CAAA;AASrE,OAAO,QAAQ,oBAAoB,CAAC;IAClC,UAAU,aAAa;QACrB,IAAI,EAAE,eAAe,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,QAAQ,CAAC,CAAA;KAC9D;CACF;AAED,MAAM,WAAW,SAAU,SAAQ,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC;IAC/D,yCAAyC;IACzC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAA;IAC/B,qDAAqD;IACrD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IACjD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B;AAED,MAAM,WAAW,OAAO;IACtB,yBAAyB;IACzB,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAA;IACrB,2BAA2B;IAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAChC;AAED,eAAO,MAAM,aAAa,2EAsEzB,CAAA;AAKD,eAAO,MAAM,OAAO;;;oBAKA,MAAM;CAEzB,CAAA"}

package/dist/FireShader.d.ts

@@ -0,0 +1,43 @@
+import { Vector3, Vector4, Color, Matrix4, Texture } from 'three';
+export interface FireShaderUniforms {
+    fireTex: {
+        value: Texture | null;
+    };
+    color: {
+        value: Color;
+    };
+    time: {
+        value: number;
+    };
+    seed: {
+        value: number;
+    };
+    invModelMatrix: {
+        value: Matrix4;
+    };
+    scale: {
+        value: Vector3;
+    };
+    noiseScale: {
+        value: Vector4;
+    };
+    magnitude: {
+        value: number;
+    };
+    lacunarity: {
+        value: number;
+    };
+    gain: {
+        value: number;
+    };
+}
+export declare const FireShader: {
+    readonly defines: {
+        readonly ITERATIONS: "20";
+        readonly OCTAVES: "3";
+    };
+    readonly uniforms: FireShaderUniforms;
+    readonly vertexShader: "\n    varying vec3 vWorldPos;\n\n    void main() {\n      gl_Position = projectionMatrix * modelViewMatrix * vec4(position, 1.0);\n      vWorldPos = (modelMatrix * vec4(position, 1.0)).xyz;\n    }\n  ";
+    readonly fragmentShader: "\n    uniform vec3 color;\n    uniform float time;\n    uniform float seed;\n    uniform mat4 invModelMatrix;\n    uniform vec3 scale;\n    uniform vec4 noiseScale;\n    uniform float magnitude;\n    uniform float lacunarity;\n    uniform float gain;\n    uniform sampler2D fireTex;\n\n    varying vec3 vWorldPos;\n\n    // GLSL simplex noise function by ashima\n    vec3 mod289(vec3 x) {\n      return x - floor(x * (1.0 / 289.0)) * 289.0;\n    }\n\n    vec4 mod289(vec4 x) {\n      return x - floor(x * (1.0 / 289.0)) * 289.0;\n    }\n\n    vec4 permute(vec4 x) {\n      return mod289(((x * 34.0) + 1.0) * x);\n    }\n\n    vec4 taylorInvSqrt(vec4 r) {\n      return 1.79284291400159 - 0.85373472095314 * r;\n    }\n\n    float snoise(vec3 v) {\n      const vec2 C = vec2(1.0 / 6.0, 1.0 / 3.0);\n      const vec4 D = vec4(0.0, 0.5, 1.0, 2.0);\n\n      vec3 i = floor(v + dot(v, C.yyy));\n      vec3 x0 = v - i + dot(i, C.xxx);\n\n      vec3 g = step(x0.yzx, x0.xyz);\n      vec3 l = 1.0 - g;\n      vec3 i1 = min(g.xyz, l.zxy);\n      vec3 i2 = max(g.xyz, l.zxy);\n\n      vec3 x1 = x0 - i1 + C.xxx;\n      vec3 x2 = x0 - i2 + C.yyy;\n      vec3 x3 = x0 - D.yyy;\n\n      i = mod289(i);\n      vec4 p = permute(permute(permute(\n        i.z + vec4(0.0, i1.z, i2.z, 1.0))\n        + i.y + vec4(0.0, i1.y, i2.y, 1.0))\n        + i.x + vec4(0.0, i1.x, i2.x, 1.0));\n\n      float n_ = 0.142857142857;\n      vec3 ns = n_ * D.wyz - D.xzx;\n\n      vec4 j = p - 49.0 * floor(p * ns.z * ns.z);\n\n      vec4 x_ = floor(j * ns.z);\n      vec4 y_ = floor(j - 7.0 * x_);\n\n      vec4 x = x_ * ns.x + ns.yyyy;\n      vec4 y = y_ * ns.x + ns.yyyy;\n      vec4 h = 1.0 - abs(x) - abs(y);\n\n      vec4 b0 = vec4(x.xy, y.xy);\n      vec4 b1 = vec4(x.zw, y.zw);\n\n      vec4 s0 = floor(b0) * 2.0 + 1.0;\n      vec4 s1 = floor(b1) * 2.0 + 1.0;\n      vec4 sh = -step(h, vec4(0.0));\n\n      vec4 a0 = b0.xzyw + s0.xzyw * sh.xxyy;\n      vec4 a1 = b1.xzyw + s1.xzyw * sh.zzww;\n\n      vec3 p0 = vec3(a0.xy, h.x);\n      vec3 p1 = vec3(a0.zw, h.y);\n      vec3 p2 = vec3(a1.xy, h.z);\n      vec3 p3 = vec3(a1.zw, h.w);\n\n      vec4 norm = taylorInvSqrt(vec4(dot(p0, p0), dot(p1, p1), dot(p2, p2), dot(p3, p3)));\n      p0 *= norm.x;\n      p1 *= norm.y;\n      p2 *= norm.z;\n      p3 *= norm.w;\n\n      vec4 m = max(0.6 - vec4(dot(x0, x0), dot(x1, x1), dot(x2, x2), dot(x3, x3)), 0.0);\n      m = m * m;\n      return 42.0 * dot(m * m, vec4(dot(p0, x0), dot(p1, x1), dot(p2, x2), dot(p3, x3)));\n    }\n\n    float turbulence(vec3 p) {\n      float sum = 0.0;\n      float freq = 1.0;\n      float amp = 1.0;\n\n      for(int i = 0; i < OCTAVES; i++) {\n        sum += abs(snoise(p * freq)) * amp;\n        freq *= lacunarity;\n        amp *= gain;\n      }\n\n      return sum;\n    }\n\n    vec4 samplerFire(vec3 p, vec4 scale) {\n      vec2 st = vec2(sqrt(dot(p.xz, p.xz)), p.y);\n\n      if(st.x <= 0.0 || st.x >= 1.0 || st.y <= 0.0 || st.y >= 1.0) {\n        return vec4(0.0);\n      }\n\n      p.y -= (seed + time) * scale.w;\n      p *= scale.xyz;\n\n      st.y += sqrt(st.y) * magnitude * turbulence(p);\n\n      if(st.y <= 0.0 || st.y >= 1.0) {\n        return vec4(0.0);\n      }\n\n      return texture2D(fireTex, st);\n    }\n\n    vec3 localize(vec3 p) {\n      return (invModelMatrix * vec4(p, 1.0)).xyz;\n    }\n\n    void main() {\n      vec3 rayPos = vWorldPos;\n      vec3 rayDir = normalize(rayPos - cameraPosition);\n      float rayLen = 0.0288 * length(scale.xyz);\n\n      vec4 col = vec4(0.0);\n\n      for(int i = 0; i < ITERATIONS; i++) {\n        rayPos += rayDir * rayLen;\n        vec3 lp = localize(rayPos);\n        lp.y += 0.5;\n        lp.xz *= 2.0;\n        col += samplerFire(lp, noiseScale);\n      }\n\n      col.a = col.r;\n      gl_FragColor = col;\n    }\n  ";
+};
+//# sourceMappingURL=FireShader.d.ts.map

package/dist/FireShader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FireShader.d.ts","sourceRoot":"","sources":["../src/FireShader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAEjE,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE;QAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;KAAE,CAAA;IAClC,KAAK,EAAE;QAAE,KAAK,EAAE,KAAK,CAAA;KAAE,CAAA;IACvB,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACvB,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACvB,cAAc,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAA;IAClC,KAAK,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAA;IACzB,UAAU,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAA;IAC9B,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC5B,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7B,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CACxB;AAED,eAAO,MAAM,UAAU;;;;;uBAiBhB,kBAAkB;;;CA8Jf,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,288 @@
+import { Texture, Color, Matrix4, Vector3, Vector4, Mesh, ShaderMaterial } from 'three';
+import React from 'react';
+import { ReactThreeFiber } from '@react-three/fiber';
+
+/**
+ * Uniforms interface for the fire shader
+ */
+interface FireShaderUniforms {
+    /** Fire texture (grayscale mask) */
+    fireTex: {
+        value: Texture | null;
+    };
+    /** Fire color tint */
+    color: {
+        value: Color;
+    };
+    /** Current time for animation */
+    time: {
+        value: number;
+    };
+    /** Random seed for fire variation */
+    seed: {
+        value: number;
+    };
+    /** Inverse model matrix for ray marching */
+    invModelMatrix: {
+        value: Matrix4;
+    };
+    /** Scale of the fire object */
+    scale: {
+        value: Vector3;
+    };
+    /** Noise scaling parameters [x, y, z, time] */
+    noiseScale: {
+        value: Vector4;
+    };
+    /** Fire shape intensity */
+    magnitude: {
+        value: number;
+    };
+    /** Noise lacunarity (frequency multiplier) */
+    lacunarity: {
+        value: number;
+    };
+    /** Noise gain (amplitude multiplier) */
+    gain: {
+        value: number;
+    };
+}
+/**
+ * Volumetric fire shader using ray marching and simplex noise
+ *
+ * Based on "Real-Time procedural volumetric fire" by Alfred et al.
+ * Uses simplex noise for turbulence and ray marching for volume rendering.
+ *
+ * @example
+ * ```ts
+ * const material = new ShaderMaterial({
+ *   defines: FireShader.defines,
+ *   uniforms: FireShader.uniforms,
+ *   vertexShader: FireShader.vertexShader,
+ *   fragmentShader: FireShader.fragmentShader,
+ *   transparent: true
+ * })
+ * ```
+ */
+declare const FireShader: {
+    readonly defines: {
+        readonly ITERATIONS: "20";
+        readonly OCTAVES: "3";
+    };
+    readonly uniforms: FireShaderUniforms;
+    readonly vertexShader: "\n    varying vec3 vWorldPos;\n\n    void main() {\n      gl_Position = projectionMatrix * modelViewMatrix * vec4(position, 1.0);\n      vWorldPos = (modelMatrix * vec4(position, 1.0)).xyz;\n    }\n  ";
+    readonly fragmentShader: "\n    uniform vec3 color;\n    uniform float time;\n    uniform float seed;\n    uniform mat4 invModelMatrix;\n    uniform vec3 scale;\n    uniform vec4 noiseScale;\n    uniform float magnitude;\n    uniform float lacunarity;\n    uniform float gain;\n    uniform sampler2D fireTex;\n\n    varying vec3 vWorldPos;\n\n    // GLSL simplex noise function by ashima\n    vec3 mod289(vec3 x) {\n      return x - floor(x * (1.0 / 289.0)) * 289.0;\n    }\n\n    vec4 mod289(vec4 x) {\n      return x - floor(x * (1.0 / 289.0)) * 289.0;\n    }\n\n    vec4 permute(vec4 x) {\n      return mod289(((x * 34.0) + 1.0) * x);\n    }\n\n    vec4 taylorInvSqrt(vec4 r) {\n      return 1.79284291400159 - 0.85373472095314 * r;\n    }\n\n    float snoise(vec3 v) {\n      const vec2 C = vec2(1.0 / 6.0, 1.0 / 3.0);\n      const vec4 D = vec4(0.0, 0.5, 1.0, 2.0);\n\n      vec3 i = floor(v + dot(v, C.yyy));\n      vec3 x0 = v - i + dot(i, C.xxx);\n\n      vec3 g = step(x0.yzx, x0.xyz);\n      vec3 l = 1.0 - g;\n      vec3 i1 = min(g.xyz, l.zxy);\n      vec3 i2 = max(g.xyz, l.zxy);\n\n      vec3 x1 = x0 - i1 + C.xxx;\n      vec3 x2 = x0 - i2 + C.yyy;\n      vec3 x3 = x0 - D.yyy;\n\n      i = mod289(i);\n      vec4 p = permute(permute(permute(\n        i.z + vec4(0.0, i1.z, i2.z, 1.0))\n        + i.y + vec4(0.0, i1.y, i2.y, 1.0))\n        + i.x + vec4(0.0, i1.x, i2.x, 1.0));\n\n      float n_ = 0.142857142857;\n      vec3 ns = n_ * D.wyz - D.xzx;\n\n      vec4 j = p - 49.0 * floor(p * ns.z * ns.z);\n\n      vec4 x_ = floor(j * ns.z);\n      vec4 y_ = floor(j - 7.0 * x_);\n\n      vec4 x = x_ * ns.x + ns.yyyy;\n      vec4 y = y_ * ns.x + ns.yyyy;\n      vec4 h = 1.0 - abs(x) - abs(y);\n\n      vec4 b0 = vec4(x.xy, y.xy);\n      vec4 b1 = vec4(x.zw, y.zw);\n\n      vec4 s0 = floor(b0) * 2.0 + 1.0;\n      vec4 s1 = floor(b1) * 2.0 + 1.0;\n      vec4 sh = -step(h, vec4(0.0));\n\n      vec4 a0 = b0.xzyw + s0.xzyw * sh.xxyy;\n      vec4 a1 = b1.xzyw + s1.xzyw * sh.zzww;\n\n      vec3 p0 = vec3(a0.xy, h.x);\n      vec3 p1 = vec3(a0.zw, h.y);\n      vec3 p2 = vec3(a1.xy, h.z);\n      vec3 p3 = vec3(a1.zw, h.w);\n\n      vec4 norm = taylorInvSqrt(vec4(dot(p0, p0), dot(p1, p1), dot(p2, p2), dot(p3, p3)));\n      p0 *= norm.x;\n      p1 *= norm.y;\n      p2 *= norm.z;\n      p3 *= norm.w;\n\n      vec4 m = max(0.6 - vec4(dot(x0, x0), dot(x1, x1), dot(x2, x2), dot(x3, x3)), 0.0);\n      m = m * m;\n      return 42.0 * dot(m * m, vec4(dot(p0, x0), dot(p1, x1), dot(p2, x2), dot(p3, x3)));\n    }\n\n    float turbulence(vec3 p) {\n      float sum = 0.0;\n      float freq = 1.0;\n      float amp = 1.0;\n\n      for(int i = 0; i < OCTAVES; i++) {\n        sum += abs(snoise(p * freq)) * amp;\n        freq *= lacunarity;\n        amp *= gain;\n      }\n\n      return sum;\n    }\n\n    vec4 samplerFire(vec3 p, vec4 scale) {\n      vec2 st = vec2(sqrt(dot(p.xz, p.xz)), p.y);\n\n      if(st.x <= 0.0 || st.x >= 1.0 || st.y <= 0.0 || st.y >= 1.0) {\n        return vec4(0.0);\n      }\n\n      p.y -= (seed + time) * scale.w;\n      p *= scale.xyz;\n\n      st.y += sqrt(st.y) * magnitude * turbulence(p);\n\n      if(st.y <= 0.0 || st.y >= 1.0) {\n        return vec4(0.0);\n      }\n\n      return texture2D(fireTex, st);\n    }\n\n    vec3 localize(vec3 p) {\n      return (invModelMatrix * vec4(p, 1.0)).xyz;\n    }\n\n    void main() {\n      vec3 rayPos = vWorldPos;\n      vec3 rayDir = normalize(rayPos - cameraPosition);\n      float rayLen = 0.0288 * length(scale.xyz);\n\n      vec4 col = vec4(0.0);\n\n      for(int i = 0; i < ITERATIONS; i++) {\n        rayPos += rayDir * rayLen;\n        vec3 lp = localize(rayPos);\n        lp.y += 0.5;\n        lp.xz *= 2.0;\n        col += samplerFire(lp, noiseScale);\n      }\n\n      // Apply color tint to the fire\n      col.rgb *= color;\n      col.a = col.r;\n      gl_FragColor = col;\n    }\n  ";
+};
+
+/**
+ * Properties for creating a Fire instance
+ */
+interface FireProps$1 {
+    /** Fire texture (grayscale mask defining fire shape) */
+    fireTex: Texture;
+    /** Fire color tint (default: 0xeeeeee) */
+    color?: Color | string | number;
+    /** Ray marching iterations - higher = better quality, lower performance (default: 20) */
+    iterations?: number;
+    /** Noise octaves for turbulence (default: 3) */
+    octaves?: number;
+    /** Noise scaling parameters [x, y, z, time] (default: [1, 2, 1, 0.3]) */
+    noiseScale?: [number, number, number, number];
+    /** Fire shape intensity (default: 1.3) */
+    magnitude?: number;
+    /** Noise lacunarity - frequency multiplier (default: 2.0) */
+    lacunarity?: number;
+    /** Noise gain - amplitude multiplier (default: 0.5) */
+    gain?: number;
+}
+/**
+ * Volumetric fire effect using ray marching shaders
+ *
+ * Creates a procedural fire effect that renders as a translucent volume.
+ * The fire shape is defined by a grayscale texture, with white areas being
+ * the most dense part of the fire.
+ *
+ * @example
+ * ```ts
+ * const texture = textureLoader.load('fire.png')
+ * const fire = new Fire({
+ *   fireTex: texture,
+ *   color: 0xff4400,
+ *   magnitude: 1.5
+ * })
+ * scene.add(fire)
+ *
+ * // In animation loop
+ * fire.update(time)
+ * ```
+ */
+declare class Fire extends Mesh {
+    material: ShaderMaterial & {
+        uniforms: FireShaderUniforms;
+    };
+    private _time;
+    /**
+     * Creates a new Fire instance
+     *
+     * @param props - Configuration options for the fire effect
+     */
+    constructor({ fireTex, color, iterations, octaves, noiseScale, magnitude, lacunarity, gain, }: FireProps$1);
+    /**
+     * Updates the fire animation and matrix uniforms
+     *
+     * Call this method in your animation loop to animate the fire effect.
+     *
+     * @param time - Current time in seconds (optional)
+     *
+     * @example
+     * ```ts
+     * function animate() {
+     *   fire.update(performance.now() / 1000)
+     *   renderer.render(scene, camera)
+     *   requestAnimationFrame(animate)
+     * }
+     * ```
+     */
+    update(time?: number): void;
+    /**
+     * Current animation time in seconds
+     */
+    get time(): number;
+    set time(value: number);
+    /**
+     * Fire color tint
+     *
+     * @example
+     * ```ts
+     * fire.fireColor = 'orange'
+     * fire.fireColor = 0xff4400
+     * fire.fireColor = new Color(1, 0.5, 0)
+     * ```
+     */
+    get fireColor(): Color;
+    set fireColor(color: Color | string | number);
+    /**
+     * Fire shape intensity
+     *
+     * Higher values create more dramatic fire shapes.
+     * Range: 0.5 - 3.0, Default: 1.3
+     */
+    get magnitude(): number;
+    set magnitude(value: number);
+    /**
+     * Noise lacunarity (frequency multiplier)
+     *
+     * Controls how much the frequency increases for each noise octave.
+     * Range: 1.0 - 4.0, Default: 2.0
+     */
+    get lacunarity(): number;
+    set lacunarity(value: number);
+    /**
+     * Noise gain (amplitude multiplier)
+     *
+     * Controls how much the amplitude decreases for each noise octave.
+     * Range: 0.1 - 1.0, Default: 0.5
+     */
+    get gain(): number;
+    set gain(value: number);
+}
+
+declare module '@react-three/fiber' {
+    interface ThreeElements {
+        fire: ReactThreeFiber.Object3DNode<Fire, typeof Fire>;
+    }
+}
+/**
+ * Props for the Fire React component
+ */
+interface FireProps extends Omit<FireProps$1, 'fireTex'> {
+    /** Fire texture URL or Three.js Texture object */
+    texture: string | Texture;
+    /** Auto-update time from useFrame (default: true) */
+    autoUpdate?: boolean;
+    /** Custom update function called each frame */
+    onUpdate?: (fire: Fire, time: number) => void;
+    /** Child components */
+    children?: React.ReactNode;
+    /** Position in 3D space */
+    position?: [number, number, number];
+    /** Rotation in radians */
+    rotation?: [number, number, number];
+    /** Scale factor (uniform or per-axis) */
+    scale?: [number, number, number] | number;
+}
+/**
+ * Ref interface for imperative fire control
+ */
+interface FireRef {
+    /** Fire mesh instance */
+    fire: Fire | null;
+    /** Update fire animation manually */
+    update: (time?: number) => void;
+}
+/**
+ * React Three Fiber component for volumetric fire effect
+ *
+ * Creates a procedural fire effect that can be easily integrated into R3F scenes.
+ * The component automatically handles texture loading, animation updates, and
+ * provides props for all fire parameters.
+ *
+ * @example
+ * ```tsx
+ * <Canvas>
+ *   <Fire
+ *     texture="/fire.png"
+ *     color="orange"
+ *     magnitude={1.5}
+ *     scale={[2, 3, 2]}
+ *     position={[0, 0, 0]}
+ *   />
+ * </Canvas>
+ * ```
+ *
+ * @example With custom animation
+ * ```tsx
+ * <Fire
+ *   texture="/fire.png"
+ *   onUpdate={(fire, time) => {
+ *     fire.fireColor.setHSL((time * 0.1) % 1, 1, 0.5)
+ *   }}
+ * />
+ * ```
+ */
+declare const FireComponent: React.ForwardRefExoticComponent<FireProps & React.RefAttributes<FireRef>>;
+/**
+ * Hook for easier access to fire instance and controls
+ *
+ * Provides a ref and helper methods for controlling fire imperatively.
+ *
+ * @returns Object with ref, fire instance, and update method
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const fireRef = useFire()
+ *
+ *   const handleClick = () => {
+ *     if (fireRef.fire) {
+ *       fireRef.fire.magnitude = 2.0
+ *     }
+ *   }
+ *
+ *   return (
+ *     <Fire ref={fireRef.ref} texture="/fire.png" />
+ *   )
+ * }
+ * ```
+ */
+declare const useFire: () => {
+    /** Ref to pass to Fire component */
+    ref: React.RefObject<FireRef>;
+    /** Fire mesh instance (null until mounted) */
+    fire: Fire | null;
+    /** Update fire animation manually */
+    update: (time?: number) => void | undefined;
+};
+
+export { FireComponent as Fire, FireComponent, Fire as FireMesh, FireShader, useFire };
+export type { FireProps$1 as FireMeshProps, FireProps, FireRef, FireShaderUniforms };

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,KAAK,SAAS,IAAI,aAAa,EAAE,MAAM,QAAQ,CAAA;AAC1E,OAAO,EAAE,UAAU,EAAE,KAAK,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAGlE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAGtF,OAAO,EAAE,aAAa,IAAI,IAAI,EAAE,MAAM,iBAAiB,CAAA"}