Metadata-Version: 2.4
Name: shaderflow
Version: 0.10.0
Dynamic: Keywords
Summary: 🔥 Modular shader engine designed for simplicity and speed
Author: Tremeschin
License-Expression: AGPL-3.0
Requires-Python: >=3.10
Requires-Dist: attrs~=25.0
Requires-Dist: cyclopts~=4.0
Requires-Dist: dearlog
Requires-Dist: glcontext~=3.0
Requires-Dist: glfw~=2.10
Requires-Dist: imgui-bundle~=1.92
Requires-Dist: moderngl-window~=3.1
Requires-Dist: moderngl~=5.12
Requires-Dist: numpy
Requires-Dist: numpy-quaternion
Requires-Dist: ordered-set~=4.1
Requires-Dist: pillow
Requires-Dist: platformdirs~=4.0
Requires-Dist: pooch~=1.0
Requires-Dist: pretty-midi~=0.2
Requires-Dist: pyfluidsynth~=1.3
Requires-Dist: soundcard~=0.4
Requires-Dist: thefuzz~=0.22
Requires-Dist: tqdm~=4.0
Requires-Dist: turbopipe~=1.2.3
Requires-Dist: watchdog~=6.0
Requires-Dist: xxhash
Description-Content-Type: text/markdown

<div align="center">
  <img src="https://raw.githubusercontent.com/BrokenSource/ShaderFlow/main/website/assets/logo.png" width="210">
  <h1>ShaderFlow</h1>
  <span>Modular shader engine designed for simplicity and speed</span>
  <br>
  <br>
  <a href="https://pypi.org/project/shaderflow/"><img src="https://img.shields.io/pypi/v/shaderflow?label=PyPI&color=blue"></a>
  <a href="https://pypi.org/project/shaderflow/"><img src="https://img.shields.io/pypi/dw/shaderflow?label=%E2%86%93&color=blue"></a>
  <a href="https://github.com/BrokenSource/ShaderFlow/releases/"><img src="https://img.shields.io/github/v/release/BrokenSource/ShaderFlow?label=Pyaket&color=light-green"></a>
  <a href="https://github.com/BrokenSource/ShaderFlow/releases/"><img src="https://img.shields.io/github/downloads/BrokenSource/ShaderFlow/total?label=%E2%86%93&color=light-green"></a>
  <a href="https://github.com/BrokenSource/ShaderFlow/stargazers"><img src="https://img.shields.io/github/stars/BrokenSource/ShaderFlow?label=Stars&style=flat&color=orange"></a>
  <a href="https://discord.gg/KjqvcYwRHm"><img src="https://img.shields.io/discord/1184696441298485370?label=Discord&style=flat&color=purple"></a>
  <br>
  <b>
    Links •
    <a href="https://github.com/BrokenSource/ShaderFlow/">GitHub</a> •
    <a href="https://shaders.brokensrc.dev/">Documentation</a> •
    <a href="https://github.com/sponsors/Tremeschin/">Support</a> •
    <a href="https://shaders.brokensrc.dev/about/license/">License</a>
  </b>
  <br>
  <sub><small>⭐️ Consider starring the project to help it grow! ⭐️</small></sub>
  <br>
  <br>
</div>

<video src="https://github.com/user-attachments/assets/100939e1-b246-4b5a-a46d-99cda4a901b7" controls></video>

## 🔥 Description

**ShaderFlow** is a platform for creating and exporting GLSL shaders scenes to videos or realtime previews, with a modularity similar to manim and shadertoy's simplicity.

- [x] **Quality**: Native supersampling for any resolution, smooth frametimes for any fps
- [x] **Fastest** video exporting not seen anywhere, powered by [🌀 TurboPipe](https://github.com/BrokenSource/TurboPipe) optimizations
- [x] **Camera** module using quaternions, generic for Ray Marching, 2D, VR scenes
- [x] **Audio** reactive processing for music visualizers, FFTs already in natural scale
- [x] **Commercial** use allowed and encouraged, simply pick a [❤️ Sponsorship](https://github.com/sponsors/Tremeschin/) tier!
- [x] No watermarks, unlimited usage, portable executables made with [📦 Pyaket](https://pyaket.dev/)

## 📦 Getting Started

<div align="center">
  <a href="https://shaders.brokensrc.dev/">
    <img src="https://github.com/user-attachments/assets/f74653a0-a62d-4911-b23b-f5d0ea03007e"/>
  </a>
  <i>
    Visit our documentation at
    <a href="https://shaders.brokensrc.dev/">https://shaders.brokensrc.dev/</a>
  </i>
</div>

<br><br><br>

<div align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=BrokenSource/ShaderFlow&theme=dark"/>
    <img src="https://api.star-history.com/svg?repos=BrokenSource/ShaderFlow"/>
  </picture>
</div>
