diff --git a/README.md b/README.md index 52d499b..23a8713 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,10 @@ TODO cool image and youtube link - [From repository (dev version)](#from-repository-dev-version) - [Usage](#usage) - [CLI arguments](#cli-arguments) - - [Included Shaders and Config](#included-shaders-and-config) + - [Default Shaders and Config](#default-shaders-and-config) + - [Sources and Effects](#sources-and-effects) + - [Debug View](#debug-view) + - [NanoKontrol2 Controller mapping](#nanokontrol2-controller-mapping) - [Making your own FORGE config](#making-your-own-forge-config) - [Working with `frag0.glsl`](#working-with-frag0glsl) - [Frequently Asked Questions](#frequently-asked-questions) @@ -112,9 +115,45 @@ options: --trace-fps print fps status of subsystems ``` -### Included Shaders and Config +### Default Shaders and Config -TODO +> A.K.A Kleπek's shaders + +![](./images/preview.png) + +#### Sources and Effects + +| P | # | SRC | _COL2_ | _COL3_ | _COL4_ | FX | _COL6_ | _COL7_ | _COL8_ | +| ----- | ----- | ----------------- | ----------------- | --------------- | ------------------ | ---------------- | --------------- | ------------- | -------------- | +| **1** | **0** | Feedback + Thru | _Hue_ | _Saturation_ | _Light_ | Thru | _Hue_ | _Saturation_ | \_Light | +| | **1** | Lines | _Thick. / Dezoom_ | _Rotation_ | _Distortion_ | Feedback + Shift | _Zoom / Dezoom_ | _X Shift_ | _Y Shift_ | +| | **2** | Dots | _Zoom_ | _Rotation_ | _Lens_ | Shift | _Zoom / Dezoom_ | _X Shift_ | _Y Shift_ | +| | **3** | Waves | _Spacing_ | _Thickness_ | _Vert. Scroll (R)_ | Colorize | _Black Color_ | _White Color_ | _Shift_ | +| | **4** | Noise | _Zoom_ | _Voronoi dist._ | _Details_ | Quantize | _Pixel Size_ | _Bit Depth_ | _Blur_ | +| **2** | **5** | Video In 1 + Thru | _Hue_ | _Saturation_ | _Light_ | Dithering | _Pixel Size_ | _Bit Depth_ | _Blur_ | +| | **6** | CP437 | _Zoom_ | _Charset_ | _Char. Delta_ | TV | _Lens_ | _Horz. Noise_ | _Dezoom_ | +| | **7** | Sentences | _Zoom_ | _Sentence_ | _Vertical repeat_ | Kaleidoscope | _Axes_ | _Rotation_ | _Horz. Scroll_ | +| | **8** | | | | | CP437 | _Zoom_ | _Charset_ | _Char. Delta_ | +| | **9** | | | | | Lens | _Lens limit_ | _Lens power_ | _Pre Zoom_ | +| **3** | **A** | Video In 2 + Thru | _Hue_ | _Saturation_ | _Light_ | | | | | +| | **B** | | | | | | | | | +| | **C** | | | | | | | | | +| | **D** | | | | | | | | | +| | **E** | Debug | --- | --- | --- | | | | | + +TODO update + +#### Debug View + +![](./images/debug.jpg) + +#### NanoKontrol2 Controller mapping + +![](./images/nanokontrol.jpg) + +> In blue is a sample "stage" as most sources/effects use a combination of 4 stages (see table above) + +> ⚠️ you'll need to change your NanoKontrol2 settings to remove the "toggle" behavior of the buttons and use "external" led control ### Making your own FORGE config diff --git a/images/debug.jpg b/images/debug.jpg new file mode 100644 index 0000000..9e30377 Binary files /dev/null and b/images/debug.jpg differ diff --git a/images/nanokontrol.jpg b/images/nanokontrol.jpg new file mode 100644 index 0000000..53eac5d Binary files /dev/null and b/images/nanokontrol.jpg differ diff --git a/images/preview.png b/images/preview.png new file mode 100644 index 0000000..aeb1f6a Binary files /dev/null and b/images/preview.png differ