Skip to content

Commit c2eae0d

Browse files
web3dev1337claude
andcommitted
docs: refresh README with showcase examples + add LICENSE file
README rewritten to lead with the 7-chapter showcase walkthrough instead of generic feature lists. Added MIT LICENSE file with dual copyright (mebiusbox original + ShaderBrew enhancements). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent fa9394d commit c2eae0d

4 files changed

Lines changed: 59 additions & 35 deletions

File tree

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2017 mebiusbox (original EffectTextureMaker / pixy shader library)
4+
Copyright (c) 2025 web3dev1337 (ShaderBrew enhancements)
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.

README.md

Lines changed: 30 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,25 @@
22

33
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.
44

5-
**[Live Demo](https://web3dev1337.github.io/shaderbrew/showcase.html)** | **[Open Editor](https://web3dev1337.github.io/shaderbrew/editor.html)**
5+
**[Live Showcase](https://web3dev1337.github.io/shaderbrew/showcase.html)** | **[Open Editor](https://web3dev1337.github.io/shaderbrew/editor.html)**
6+
7+
---
8+
9+
## What It Does
10+
11+
The **[Showcase](https://web3dev1337.github.io/shaderbrew/showcase.html)** walks through the full pipeline in 7 chapters:
12+
13+
| Chapter | What You See |
14+
|---------|-------------|
15+
| **Raw Canvas** | 65+ procedural effects — explosions, corona, caustics, frozen lightning |
16+
| **Color Balance** | RGB channel shifting on raw effects |
17+
| **Gradient Mapping** | One explosion through 10 different color palettes |
18+
| **Multi-Layer Compositing** | Organic caustics + digital matrix blended with 9 modes |
19+
| **Combination** | Full chains — two effects blended and gradient-mapped |
20+
| **PBR Maps** | Auto-generated Normal, Roughness, AO, Metallic from any texture |
21+
| **3D Preview** | PBR materials applied to lit, rotating geometry in real-time |
22+
23+
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.
624

725
---
826

@@ -23,13 +41,15 @@ Professional WebGL procedural texture generator. Multi-layer compositing, PBR ma
2341
<img src="docs/media/dark-ritual-portal.gif" width="160" alt="Dark Ritual Portal">
2442
</p>
2543

44+
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.
45+
2646
---
2747

2848
## Pages
2949

3050
| Page | Description |
3151
|------|-------------|
32-
| **[Showcase](https://web3dev1337.github.io/shaderbrew/showcase.html)** | Guided tour — live renders, 3D preview, PBR maps, 7 chapters |
52+
| **[Showcase](https://web3dev1337.github.io/shaderbrew/showcase.html)** | Guided tour — 7 chapters, live renders, PBR pipeline walkthrough |
3353
| **[Editor](https://web3dev1337.github.io/shaderbrew/editor.html)** | Full texture editor — layers, gradients, PBR export, undo/redo |
3454
| **[Gallery](https://web3dev1337.github.io/shaderbrew/gallery.html)** | Live animated gallery of 70+ procedural effects |
3555
| **[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
4161
## Features
4262

4363
### Editor
44-
- **65+ procedural effect types** — explosions, fire, plasma, voronoi, fractals, caustics, and more
45-
- **52 custom GLSL shaders** — raymarched nebulae, black holes, warp tunnels, fractals, cosmic phenomena
46-
- **Multi-layer compositing** — unlimited layers with 9 blend modes (Normal, Multiply, Screen, Overlay, etc.)
64+
- **65+ procedural effect types** — explosions, fire, plasma, voronoi, fractals, caustics
65+
- **52 custom GLSL shaders** — raymarched nebulae, black holes, warp tunnels, fractals
66+
- **Multi-layer compositing** — unlimited layers with 9 blend modes
4767
- **Gradient color mapping** — multi-stop gradient editor with 5 presets
48-
- **PBR map generation**auto-generates Normal, Roughness, AO, and Metallic maps
49-
- **3D material preview** — real-time on sphere/cube/torus knot with environment reflections, ACES tone mapping, PCF shadows
68+
- **PBR map generation** — Normal, Roughness, AO, Metallic
69+
- **3D material preview** — real-time on sphere/cube/torus knot with environment reflections
5070
- **Undo/Redo** — 50-state history (Ctrl+Z / Ctrl+Shift+Z)
5171
- **Export** — PNG, JPEG, ZIP bundles with all PBR maps, up to 2048x2048
5272

5373
### Sprite Sheets
5474
- **119 pre-rendered sprite sheets** — 6x6 grid, 36 frames each
5575
- **Game-ready** — transparent PNGs with alpha for particle systems and VFX
56-
- **Export** — GIF and MP4 video export via Puppeteer + ffmpeg
57-
58-
### Showcase
59-
- **Dark Ritual Portal** — multi-layer composite build walkthrough
60-
- **Material Forge** — live 3D scene with PBR materials, bloom, and environment lighting
61-
- **7 chapters** — raw effects, color balance, gradients, layers, compositing, PBR maps, 3D preview
6276

6377
---
6478

@@ -71,40 +85,21 @@ Professional WebGL procedural texture generator. Multi-layer compositing, PBR ma
7185
- **JSZip** — ZIP export (loaded on demand)
7286
- No build step, no bundler — pure ES modules served directly
7387

74-
## Architecture
75-
76-
```
77-
editor.html Main editor
78-
src/
79-
app.js Main coordinator
80-
render-pipeline.js 6-pass pipeline (Base > Polar > ColorBalance > Tiling > Normal > Copy)
81-
layer-manager.js Multi-layer CRUD, reorder, duplicate
82-
compositor.js Ping-pong RT compositor, 9 blend modes
83-
gradient-editor.js Multi-stop gradient editor
84-
pbr-generator.js Normal / Roughness / AO / Metallic pass generation
85-
preview-3d.js 3D preview — PMREM environment, ACES tone mapping, shadows
86-
history.js Undo/redo (50 snapshots)
87-
export.js PNG / JPEG / ZIP export
88-
ui/ GUI panels, layer panel, toolbar, action dock
89-
shaders/ Blend modes, gradient map, tiling, PBR shaders
90-
shader-defs.js 52 custom GLSL shader sources
91-
```
92-
9388
## Running Locally
9489

9590
```bash
9691
git clone https://github.com/web3dev1337/shaderbrew.git
9792
cd shaderbrew
9893
python3 -m http.server 4444
99-
# Open http://localhost:4444/editor.html
94+
# Open http://localhost:4444/showcase.html
10095
```
10196

10297
## Credits
10398

104-
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.
99+
Built on [EffectTextureMaker](https://mebiusbox.github.io/contents/EffectTextureMaker/) by [mebiusbox](https://github.com/mebiusbox) (MIT License). The original tool provides the core procedural shader library (pixy) and single-layer editor.
105100

106101
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.
107102

108103
## License
109104

110-
MIT
105+
MIT — see [LICENSE](LICENSE) for details.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
User asked to refresh README with showcase examples and verify license status.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- [x] Create branch off latest master
2+
- [x] Research upstream license (mebiusbox EffectTextureMaker)
3+
- [x] Rewrite README with showcase-based examples
4+
- [x] Add proper LICENSE file with dual copyright
5+
- [x] Commit and push
6+
- [ ] Create PR

0 commit comments

Comments
 (0)