grimoire   ![BUILD-img] ![MIT-img] ![APACHE-img] ![RUSTC-img]

grimoire is a command-line tool for creating shader demos on Windows, MacOS, and Linux

Create interactive art, make games, learn computer graphics, have fun!

• What?
• How?
• Install
  • Windows
  • MacOS
  • Linux
• Resources
• Inspiration
• Dual licensed under MIT & Apache 2.0
• FAQ

What?

grimoire is best described as a native clone of shadertoy and vertexshaderart with the following features:

• Shader inputs: images, videos, audio, cubemaps, volumetric data, webcam, mouse, time of day, keyboard, microphone, kinect2, and openni2 devices
• Multiple render passes
• Multiple render targets
• Vertex shaders
• Shadertoy compatibility
• Live code your shader demo in a single file in your editor of choice
• Cross-platform (Windows, MacOS, Linux)
  • SDL2 for window and input handling
  • GStreamer for video, webcam, audio, microphone, and kinect2 inputs
  • OpenGL 3.3+, but uses a subset of OpenGL accessible from GLES 3.0

Install now and learn by example!

grimoire is in the early stages of development. You will encounter bugs and features may change with notice. Bug reports, feedback, and PRs are welcomed!

How?

```glsl // image.glsl /* [dog] image = "poodle.png"

[cat] image = "garfield.png"

[[pass]] iChannel0 = "dog" iChannel1 = "cat" */

void mainImage(out vec4 fragColor, in vec2 fragCoord) { vec2 uv = fragCoord / iResolution.xy; fragColor = mix(texture(iChannel0, uv), texture(iChannel1, uv), 0.5 + 0.5 * sin(iTime)); } console $ grimoire image.glsl ```

• The only required input to grimoire is a single GLSL file with TOML configuration embedded in a comment block. You author this file in your editor of choice.
• Your configuration defines a list of ordered rendering passes. Your GLSL code defines the vertex and fragment shader main function for each pass. grimoire inserts several #define statements before compiling your GLSL code depending on the shader type under compilation and the pass. Your GLSL code conditions on these statements in #ifdef blocks to ensure only one main function is compiled per shader.
• Your configuration defines named buffers that passes draw to, and named texture resources that your GLSL code samples. grimoire inserts the correct uniform sampler declarations into your code based on the resource type.
• As you edit and save the file, grimoire reloads resources and recompiles the shader programs live. As you edit and save file backed resources referenced by the configuration, grimoire reloads the texture data. You never need to restart grimoire once it's running, even on misconfigurations or GLSL compilation errors.

Want to learn more? Read the spec or learn by example!

Install

You need to build and install grimoire from source using rust and install the required system dependencies:

• SDL2
• GStreamer

Windows

This is a really rough experience right now and the following steps may not work for you without further tinkering:

• Download and run msys2
• Install the required dependencies
• Manually copy the SDL2 and GStreamer DLLs to the top-level grimoire source directory (the one containing Cargo.toml) before running

console $ pacman -S mingw-w64-x86_64-pkg-config mingw-w64-x86_64-SDL2 mingw-w64-x86_64-GStreamer mingw-w64-x86_64-gst-plugins-base mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav $ rustup target add x86_64-pc-windows-gnu $ git clone https://github.com/jshrake/grimoire $ cd grimoire $ cargo build --release

Breadcrumbs: - https://github.com/sdroege/GStreamer-rs#windows

MacOS

console $ curl https://sh.rustup.rs -sSf | sh $ brew install sdl2 gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav $ git clone https://github.com/jshrake/grimoire $ cd grimoire $ cargo install --path .

Linux

console $ curl https://sh.rustup.rs -sSf | sh $ apt-get install libsdl2-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav $ git clone https://github.com/jshrake/grimoire $ cd grimoire $ cargo install --path .

Resources

fragment shaders

• Ray Marching and Signed Distance Functions
• Modeling with Signed Distance Functions
• Ray Marching Distance Fields
• The Book of Shaders

vertex shaders

• vertexshaderart lessons
• perspective projection matrix

Inspiration

• shadertoy
• vertexshaderart
• interactiveshaderformat
• the book of shaders
• https://shadertoyunofficial.wordpress.com/

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.