Merge pull request #15 from web3dev1337/feature/readme-refresh

docs: refresh README with showcase examples + add LICENSE

Author: web3dev1337

CLAUDE.md

@@ -6,13 +6,12 @@
 3. Run on `http://localhost:4444` (do NOT use port 3000)
 
 ## Project Overview
-WebGL shader-based procedural texture generator. Originally by mebiusbox (MIT). Enhanced into a professional multi-layer texture creation tool with PBR export, 3D preview, gradient editor, undo/redo, and 119 pre-rendered sprite sheet particle effects (100 pixy-based + 19 custom GLSL).
+WebGL shader-based procedural texture generator. Uses mebiusbox's MIT-licensed pixy.js shader library. Built into a professional multi-layer texture creation tool with PBR export, 3D preview, gradient editor, undo/redo, and 119 pre-rendered sprite sheet particle effects (100 pixy-based + 19 custom GLSL).
 
 ## Key Files
 - `editor.html` - Main editor (loads src/app.js, has layers/PBR/gradient/export)
-- `index.html` - Original editor (loads fxgen.module.min.js, kept for compat)
-- `fxgen.module.min.js` - Original minified app (kept for index.html)
-- `pixy.module.min.js` - 439KB shader library (DO NOT MODIFY)
+- `index.html` - Redirect to showcase.html
+- `pixy.module.min.js` - 439KB MIT-licensed shader library by mebiusbox (DO NOT MODIFY)
 - `gallery.html` - Live animated gallery of 70+ effects
 - `particles.html` - 3D particle viewport + Browse 100 mode
 - `sprite-gallery.html` - 119 animated sprite sheets from pre-rendered PNGs
@@ -74,7 +73,6 @@ WebGL shader-based procedural texture generator. Originally by mebiusbox (MIT).
 - **Analogous cool**: Warp Rainbow (teal→blue→violet HSV sweep)
 
 ## Gotchas
-- `s` (fxgen app object) is module-private — not accessible from outside
 - Gallery uses IntersectionObserver + round-robin (max 6/frame) for GPU efficiency
 - Puppeteer needs Xvfb for WebGL: `xvfb-run --auto-servernum node save-sprites.mjs`
 - Custom shaders NOT in editor yet — only in sprite gallery. Editor uses pixy effects only.

CODEBASE_DOCUMENTATION.md

@@ -1,13 +1,13 @@
 # ShaderBrew — Codebase Documentation
 
-Enhanced fork of mebiusbox's MIT-licensed WebGL procedural texture generator. Transformed from a single-effect viewer into a multi-layer texture creation tool with PBR export, 3D preview, gradient editor, undo/redo, and 160 animated sprite sheet effects (100 FXGEN + 52 custom GLSL + 8 composites).
+WebGL procedural texture generator built on mebiusbox's MIT-licensed pixy.js shader library. Multi-layer texture creation tool with PBR export, 3D preview, gradient editor, undo/redo, and 160 animated sprite sheet effects (100 FXGEN + 52 custom GLSL + 8 composites).
 
 ## Quick Navigation
 
 ```
 ENTRY POINTS:
   editor.html          Main editor (loads src/app.js)
-  index.html           Original editor (loads fxgen.module.min.js, kept for compat)
+  index.html           Redirect to showcase.html
   gallery.html         Live animated gallery of 70+ effects
   showcase.html        Feature showcase (pipeline + custom GLSL previews)
   demos.html           Interactive material demos
@@ -67,8 +67,7 @@ PRESET & LOADER:
   preset-loader.js     Preset bar UI + JSON/URL loading
 
 LIBRARY (DO NOT MODIFY):
-  pixy.module.min.js   439KB shader library — 70+ effects, noise functions, Composer
-  fxgen.module.min.js  42KB original app (kept for index.html compat)
+  pixy.module.min.js   439KB MIT-licensed shader library by mebiusbox — 70+ effects, noise functions, Composer
 
 DATA:
   presets/              38 JSON preset files (13 custom + 25 built-in)
@@ -197,7 +196,7 @@ Exportable individually or as ZIP bundle.
 
 | Phase | Status | Description |
 |-------|--------|-------------|
-| 0 | DONE | Deobfuscated fxgen into src/ modules |
+| 0 | DONE | Built src/ modules using pixy.js shader API |
 | 1 | DONE | Multi-layer compositing (LayerManager, 9 blend modes, Compositor) |
 | 2 | DONE | Gradient map color ramp (editor + 5 presets + GLSL shader) |
 | 3 | DONE | Enhanced UI layout (layer panel, toolbar, split-pane) |
@@ -229,7 +228,6 @@ xvfb-run --auto-servernum --server-args="-screen 0 1280x1024x24" node save-custo
 | Component | Files | Size |
 |-----------|-------|------|
 | pixy.module.min.js | 1 | 439KB |
-| fxgen.module.min.js | 1 | 42KB |
 | src/ modules | 22 | ~3,800 lines |
 | sprites/ | 118 | ~133MB |
 | presets/ | 38 | ~200KB |

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017 mebiusbox (pixy.js shader library — pixy.module.min.js)
+Copyright (c) 2025 web3dev1337 (ShaderBrew — everything else)
+
+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.

PLAN.md

@@ -2,7 +2,7 @@
 
 ## Context
 
-ShaderBrew (originally EffectTextureMaker by mebiusbox, MIT) is a WebGL shader-based procedural texture generator. We forked it and have been enhancing it into a professional multi-layer texture creation tool.
+ShaderBrew is a WebGL shader-based procedural texture generator built on mebiusbox's MIT-licensed pixy.js shader library. Enhanced into a professional multi-layer texture creation tool.
 
 **Current state (work already done on branch `work1`):**
 - Created `gallery.html` - live animated gallery of all 70+ effects with IntersectionObserver for GPU efficiency
@@ -114,10 +114,10 @@ Created 5 basic V1 presets + 8 advanced V2 presets with intentional parameter in
 
 ## Implementation Plan
 
-### Phase 0: Deobfuscate & Structure -- DONE (commit ff2d265)
+### Phase 0: Project Structure -- DONE (commit ff2d265)
 **Files created:** `src/app.js`, `src/pixy-api.js`, `src/defaults.js`, `src/render-pipeline.js`, `src/sprite-sheet.js`, `src/alpha-export.js`, `src/noise-sphere.js`, `src/preset-loader.js`, `src/ui/gui-setup.js`, `editor.html`
 
-- [x] Deobfuscated fxgen.module.min.js into 10 focused modules in src/
+- [x] Built 10 focused modules in src/ using pixy.js shader API
 - [x] Created pixy-api.js facade
 - [x] Created editor.html loading from src/
 - [ ] Verify everything works identically (needs browser test)

README.md

@@ -2,7 +2,25 @@
 
 Professional WebGL procedural texture generator. Multi-layer compositing, PBR map generation, 3D material preview, 52 custom GLSL shaders, and 65+ procedural effects — all running in your browser with zero dependencies.
 
-**[Live Demo](https://web3dev1337.github.io/shaderbrew/showcase.html)** | **[Open Editor](https://web3dev1337.github.io/shaderbrew/editor.html)**
+**[Live Showcase](https://web3dev1337.github.io/shaderbrew/showcase.html)** | **[Open Editor](https://web3dev1337.github.io/shaderbrew/editor.html)**
+
+---
+
+## What It Does
+
+The **[Showcase](https://web3dev1337.github.io/shaderbrew/showcase.html)** walks through the full pipeline in 7 chapters:
+
+| Chapter | What You See |
+|---------|-------------|
+| **Raw Canvas** | 65+ procedural effects — explosions, corona, caustics, frozen lightning |
+| **Color Balance** | RGB channel shifting on raw effects |
+| **Gradient Mapping** | One explosion through 10 different color palettes |
+| **Multi-Layer Compositing** | Organic caustics + digital matrix blended with 9 modes |
+| **Combination** | Full chains — two effects blended and gradient-mapped |
+| **PBR Maps** | Auto-generated Normal, Roughness, AO, Metallic from any texture |
+| **3D Preview** | PBR materials applied to lit, rotating geometry in real-time |
+
+The hero demo builds a **Dark Ritual Portal** from scratch — layering a raymarched warp tunnel with a sprite ring and alpha compositing it into a final effect.
 
 ---
 
@@ -23,13 +41,15 @@ Professional WebGL procedural texture generator. Multi-layer compositing, PBR ma
 <img src="docs/media/dark-ritual-portal.gif" width="160" alt="Dark Ritual Portal">
 </p>
 
+The showcase features 12 of these live — Volumetric Nebula, Black Hole, Cosmic Jellyfish, God Rays, Reality Shatter, Dimensional Portal, Time Vortex, Particle Collider, Void Tendril, and Summoning Circle among them.
+
 ---
 
 ## Pages
 
 | Page | Description |
 |------|-------------|
-| **[Showcase](https://web3dev1337.github.io/shaderbrew/showcase.html)** | Guided tour — live renders, 3D preview, PBR maps, 7 chapters |
+| **[Showcase](https://web3dev1337.github.io/shaderbrew/showcase.html)** | Guided tour — 7 chapters, live renders, PBR pipeline walkthrough |
 | **[Editor](https://web3dev1337.github.io/shaderbrew/editor.html)** | Full texture editor — layers, gradients, PBR export, undo/redo |
 | **[Gallery](https://web3dev1337.github.io/shaderbrew/gallery.html)** | Live animated gallery of 70+ procedural effects |
 | **[Material Forge](https://web3dev1337.github.io/shaderbrew/demos.html)** | 3D material demo — textures on lit spinning objects with bloom |
@@ -41,24 +61,18 @@ Professional WebGL procedural texture generator. Multi-layer compositing, PBR ma
 ## Features
 
 ### Editor
-- **65+ procedural effect types** — explosions, fire, plasma, voronoi, fractals, caustics, and more
-- **52 custom GLSL shaders** — raymarched nebulae, black holes, warp tunnels, fractals, cosmic phenomena
-- **Multi-layer compositing** — unlimited layers with 9 blend modes (Normal, Multiply, Screen, Overlay, etc.)
+- **65+ procedural effect types** — explosions, fire, plasma, voronoi, fractals, caustics
+- **52 custom GLSL shaders** — raymarched nebulae, black holes, warp tunnels, fractals
+- **Multi-layer compositing** — unlimited layers with 9 blend modes
 - **Gradient color mapping** — multi-stop gradient editor with 5 presets
-- **PBR map generation** — auto-generates Normal, Roughness, AO, and Metallic maps
-- **3D material preview** — real-time on sphere/cube/torus knot with environment reflections, ACES tone mapping, PCF shadows
+- **PBR map generation** — Normal, Roughness, AO, Metallic
+- **3D material preview** — real-time on sphere/cube/torus knot with environment reflections
 - **Undo/Redo** — 50-state history (Ctrl+Z / Ctrl+Shift+Z)
 - **Export** — PNG, JPEG, ZIP bundles with all PBR maps, up to 2048x2048
 
 ### Sprite Sheets
 - **119 pre-rendered sprite sheets** — 6x6 grid, 36 frames each
 - **Game-ready** — transparent PNGs with alpha for particle systems and VFX
-- **Export** — GIF and MP4 video export via Puppeteer + ffmpeg
-
-### Showcase
-- **Dark Ritual Portal** — multi-layer composite build walkthrough
-- **Material Forge** — live 3D scene with PBR materials, bloom, and environment lighting
-- **7 chapters** — raw effects, color balance, gradients, layers, compositing, PBR maps, 3D preview
 
 ---
 
@@ -71,40 +85,23 @@ Professional WebGL procedural texture generator. Multi-layer compositing, PBR ma
 - **JSZip** — ZIP export (loaded on demand)
 - No build step, no bundler — pure ES modules served directly
 
-## Architecture
-
-```
-editor.html            Main editor
-src/
-  app.js               Main coordinator
-  render-pipeline.js   6-pass pipeline (Base > Polar > ColorBalance > Tiling > Normal > Copy)
-  layer-manager.js     Multi-layer CRUD, reorder, duplicate
-  compositor.js        Ping-pong RT compositor, 9 blend modes
-  gradient-editor.js   Multi-stop gradient editor
-  pbr-generator.js     Normal / Roughness / AO / Metallic pass generation
-  preview-3d.js        3D preview — PMREM environment, ACES tone mapping, shadows
-  history.js           Undo/redo (50 snapshots)
-  export.js            PNG / JPEG / ZIP export
-  ui/                  GUI panels, layer panel, toolbar, action dock
-  shaders/             Blend modes, gradient map, tiling, PBR shaders
-shader-defs.js         52 custom GLSL shader sources
-```
-
 ## Running Locally
 
 ```bash
 git clone https://github.com/web3dev1337/shaderbrew.git
 cd shaderbrew
 python3 -m http.server 4444
-# Open http://localhost:4444/editor.html
+# Open http://localhost:4444/showcase.html
 ```
 
 ## Credits
 
-Built on [EffectTextureMaker](https://github.com/mebiusbox/EffectTextureMaker) by [mebiusbox](https://github.com/mebiusbox) (MIT License). The original tool provides the core procedural shader library (pixy) and single-layer editor.
+Uses [pixy.js](https://github.com/mebiusbox/pixy.js) by [mebiusbox](https://github.com/mebiusbox) (MIT License) — the procedural shader library that powers the 65+ built-in effect types.
 
-ShaderBrew adds multi-layer compositing, gradient mapping, PBR generation, 3D preview, 52 custom GLSL shaders, sprite sheet generation, the showcase, material forge, and the enhanced editor UI.
+Everything else (editor, layers, compositing, gradient mapping, PBR generation, 3D preview, 52 custom GLSL shaders, sprite sheets, showcase, material forge) is original ShaderBrew code.
 
 ## License
 
-MIT
+MIT — see [LICENSE](LICENSE) for details.
+
+`pixy.module.min.js` bundles GLSL from Shadertoy authors (CC-BY-NC-SA 3.0) and other sources — see [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md) for full attribution.

THIRD_PARTY_LICENSES.md

@@ -0,0 +1,71 @@
+# Third-Party Licenses
+
+## pixy.js Shader Library
+
+`pixy.module.min.js` is by [mebiusbox](https://github.com/mebiusbox) and licensed under MIT.
+Source: https://github.com/mebiusbox/pixy.js
+
+pixy.js bundles GLSL shader code from the following third-party sources.
+Shadertoy shaders use [CC-BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/)
+unless the author specified otherwise.
+
+### Shadertoy Sources
+
+| Effect | Source | Author |
+|--------|--------|--------|
+| Explosion | [Xd3GWn](https://www.shadertoy.com/view/Xd3GWn), [XdSXDc](https://www.shadertoy.com/view/XdSXDc) | — |
+| Explosion2 | [lsySzd](https://www.shadertoy.com/view/lsySzd) | Duke |
+| Cloud | [XsfXW8](https://www.shadertoy.com/view/XsfXW8), [XslGRr](https://www.shadertoy.com/view/XslGRr) | Inigo Quilez (iq) |
+| Fire | [XsXSWS](https://www.shadertoy.com/view/XsXSWS) | xbe |
+| Flame | [MdX3zr](https://www.shadertoy.com/view/MdX3zr) | — |
+| FlameEye | [ltBfDt](https://www.shadertoy.com/view/ltBfDt) | — |
+| Corona | [XdV3DW](https://www.shadertoy.com/view/XdV3DW) | — |
+| Sun | [MlKGDc](https://www.shadertoy.com/view/MlKGDc), [MsBGRh](https://www.shadertoy.com/view/MsBGRh), [4lBXzy](https://www.shadertoy.com/view/4lBXzy), [4sfGzS](https://www.shadertoy.com/view/4sfGzS), [4tlSzl](https://www.shadertoy.com/view/4tlSzl) | Inigo Quilez (iq) et al. |
+| Flare | [4scXWB](https://www.shadertoy.com/view/4scXWB) | — |
+| Flare2 | [Xs33R2](https://www.shadertoy.com/view/Xs33R2) | — |
+| Flare3 | [4sX3Rs](https://www.shadertoy.com/view/4sX3Rs) | — |
+| Caustics | [MdKXDm](https://www.shadertoy.com/view/MdKXDm) | — |
+| Energy | [XdjcWc](https://www.shadertoy.com/view/XdjcWc) | — |
+| Particle | [llGBWw](https://www.shadertoy.com/view/llGBWw) | — |
+| Cross | [ls3GRS](https://www.shadertoy.com/view/ls3GRS) | — |
+| MagicCircle | [4dfXDn](https://www.shadertoy.com/view/4dfXDn) | — |
+| Mandara | [MtcSz4](https://www.shadertoy.com/view/MtcSz4) | — |
+| Mandalas | [4tdSDr](https://www.shadertoy.com/view/4tdSDr) | — |
+| BrushStroke | [lt23D3](https://www.shadertoy.com/view/lt23D3) | — |
+| Squiggles | [MstBD4](https://www.shadertoy.com/view/MstBD4) | — |
+| Bubbles | [Xl2Bz3](https://www.shadertoy.com/view/Xl2Bz3) | — |
+| Speckle | [XlSBDz](https://www.shadertoy.com/view/XlSBDz) | — |
+| Pentagon | [MlBfWz](https://www.shadertoy.com/view/MlBfWz) | — |
+| KochCurve | [XdcGzH](https://www.shadertoy.com/view/XdcGzH) | — |
+| MarbleNoise | [lsf3WH](https://www.shadertoy.com/view/lsf3WH) | — |
+| CoherentNoise | [4dS3Wd](https://www.shadertoy.com/view/4dS3Wd) | — |
+| iqnoise/iqhash (utility) | [Xd23Dh](https://www.shadertoy.com/view/Xd23Dh) | Inigo Quilez (iq) |
+| Hash functions (utility) | [4djSRW](https://www.shadertoy.com/view/4djSRW) | Dave Hoskins |
+
+### GitHub Sources
+
+| Component | Source | Author | License |
+|-----------|--------|--------|---------|
+| Simplex noise | [ashima/webgl-noise](https://github.com/ashima/webgl-noise) | Stefan Gustavson | MIT |
+| Color balance | [liovch/GPUImage](https://github.com/liovch/GPUImage) | liovch | BSD-3 |
+| Sky scattering | [SimonWallner/kocmoc-demo](https://github.com/SimonWallner/kocmoc-demo) | Simon Wallner | — |
+| Cloud overlay | [GameTechDev/CloudsGPUPro6](https://github.com/GameTechDev/CloudsGPUPro6) | Intel GameTechDev | — |
+
+### Special Thanks
+
+As credited by mebiusbox on the EffectTextureMaker page:
+doxas, liovch, iq, KeyMaster-, knighty, XT95, Brandon Fogerty, FabriceNeyret2,
+TambakoJaguar, mu6k, anisoptera, namortrailblazer, vamoss, xbe,
+Iulian Marinescu Ghetau, Duke, hclarke, 104, vchizhov, smkgames,
+Stefan Gustavson, skaplun, Koltes, arxyz, diviaki, Sunpy, Hadyn,
+Dave_Hoskins, maysssam, joltz0r, Xor
+
+## ShaderBrew Custom GLSL Shaders
+
+The 52 custom shaders in `shader-defs.js` and `gen-custom.html` are original work
+and do not derive from Shadertoy or other third-party sources.
+
+## Three.js
+
+Three.js 0.174.0 — MIT License
+https://github.com/mrdoob/three.js

ai-memory/feature/readme-refresh-fa9394d/init.md

@@ -0,0 +1 @@
+User asked to refresh README with showcase examples and verify license status.

ai-memory/feature/readme-refresh-fa9394d/progress.md

@@ -0,0 +1,6 @@
+- [x] Create branch off latest master
+- [x] Research upstream license (mebiusbox EffectTextureMaker)
+- [x] Rewrite README with showcase-based examples
+- [x] Add proper LICENSE file with dual copyright
+- [x] Commit and push
+- [ ] Create PR