Flux Integration guide — Cranberry Forge

Install

Not published to npm. Pack this repository folder, then install the tarball:

npm ci
npm pack ./dist/packages/flux
# In your own project:
npm install three@0.180.0 /path/to/cranberry-forge-flux-0.1.0.tgz

ES modules and TypeScript declarations are included. TypeScript consumers also need compatible @types/three. Tested with Three.js r180 / WebGLRenderer. ShaderMaterial-based; WebGPU is not supported by this release.

Visual integration

The shader makes a soft edge and bright inner core. Standard output/tone-mapping choices still affect the scene. The showcase uses native Three.js EffectComposer, UnrealBloomPass and OutputPass. Bloom is optional and not included in the package. Additive transparency is intentionally luminous and can become saturated at overlaps. It does not provide opaque smoke, refractive ribbons, collision or particles.