A tool for shader coding and live performances
Sh4derJockey lets you design custom render pipelines in yaml files, supports as many fragment, vertex, and compute shader stages as your machine can handle, provides 20+ audio textures and uniforms for audio-reactive effects, offers plenty of buttons and sliders which can be hooked up to midi controllers, allows for quick prototyping and live shader coding with automatic pipeline reloading, includes support for live NDI® video input, and so much more!
The documentation on how to use this tool can be found in the docs folder or using the links below:
To build this project from source, you will need a Rust compiler and the Cargo package manager.
We highly recommend installing rustup which takes care of installing and updating the entire Rust toolchain.
Checkout the Getting Started section on the rust-lang website for more.
# clone the repo
git clone https://github.com/slerpyyy/sh4der-jockey.git
cd sh4der-jockey
# build and run
cargo run
# install so you can run it from anywhere
cargo install --path .| Please note that the tool drops config files in the folder where the executable is located. |
|---|
It is up to the user to ensure that additional files in the install directory do not interfere with other programs. The tool does also work when placed into a read-only directory, but user comfort will suffer.
This project is 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.
This program makes use of NDI® (Network Device Interface), a standard developed by NewTek, Inc.
Please refer to https://www.ndi.tv/ for further information about this technology.
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.