【☰】Table of Contents 👆

ShaderFlow

_{👆 Out of the many Explorers, you can be among the Shining stars who support us! ⭐️}

Imagine [ShaderToy], on a [Manim]-like Architecture. That's [ShaderFlow].

🔥 Description

ShaderFlow is a complete Tool for Artists, Musicians and Shader Enthusiasts

A Framework for Creating, Exporting Real Time and Audio Reactive Shaders

• 🛡️ Open Source, Trust and Transparency, Cross Platform, Configurable
• 🧸 80% ShaderToy Compatible, Easily transfer your Knowledge
• 🚀 Physics-like Animations with Control Systems Dynamics
• 🔱 High Quality, Any Resolution, Framerate, Bitrate, SSAA
• 🎵 Audio Reactive, Live Music, Professional Video
• 🌊 Audio Waveforms and Oscilloscope Support
• 🎥 Video as Texture: Real Time 4k Processing
• 🎨 No Watermarks, User First Experience
• 🌵 Fastest Rendering times in the West
• 👁 Built-in Camera 2D, 3D, 360°, VR
• 🎹 Piano Roll scene, the smoothest

📸 Showcase

🎧 • Remember to Enable Audio on the Videos !

2024.2.19.ShaderFlow.Visualizer.mp4

^{Video: Music Visualizer Tech Demo Scene. Sources: Music and Image. Property of their original owners ⚖️}

2024.2.19.ShaderFlow.Bars.mp4

^{Video: Music Bars Tech Demo Scene. Sources: Music. Property of their original owners ⚖️}

2024.2.29.ShaderFlow.Piano.Roll.mp4

^{Video: Real Time Piano Roll Tech Demo Scene. Sources: Salamander Grand Piano by Alexander Holm, CC BY 3.0 and Midi File for the composition Flight of The Bumblebee by Rimsky Korsakov. Property of their original owners ⚖️}

2024.2.22.ShaderFlow.Educational.mp4

^{Video: Educational Scene about Parallel Plates Capacitor. Source: Coded myself long ago.}

📦 Installation

ShaderFlow, similar to Manim, is best used directly from a python script

🔴🟡🟢  For Extra Installation Help, check out the Monorepo

• 🐧 Linux and MacOS 🍎: Open a Terminal in some Folder and run:

  /bin/bash -c "$(curl -sS https://brakeit.github.io/get.sh)"

• 💠 Windows: Open a PowerShell in some Folder and run:

  irm https://brakeit.github.io/get.ps1 | iex

_{Note: The commands above are safe. You can read what they do here.}

After you are inside the Development Environment:

• Run broken shaderflow to see all available scenes

• Run broken shaderflow (scene) to run a specific scene

• Run broken shaderflow (scene) --help for rendering options

Scene files are placed under ShaderFlow/Resources/Scenes/**/*.py

🎮 Controls

Camera Modes

• 1: Free Camera 3D
• 2: Generic Camera 2D
• 3: Spherical Camera 3D
• p: Camera Projection
• i j k: UP Axis (x, y, z)

Camera Controls

• W A S D: Move
• Q E: Roll
• Space Shift: Move Up/Down
• Mouse: Look Around
• Mouse Wheel: Zoom In/Out
• T G: Isometric +/-

Window Controls:

• Tab: ShaderFlow Menu
• F1: Exclusive Mouse Mode
• F2: Screenshot
• F11: Fullscreen
• Esc: Exit

⚖️ License

See BrokenSource Repository for the License of the Code, Assets, Projects and User Generated Content.