Rhizomium Documentation
Rhizomium is a modular GPU node environment for real-time generative visuals, built on WebGPU and WGSL. Shaders are composed visually by connecting nodes; parameters can be driven by expressions, audio, MIDI or a keyframe timeline. It is a desktop app for Windows 10 or later (64-bit); there is no web version.
Download it from https://github.com/Amirashkan/rhizomium/releases/latest. This index is the plain-text version of the documentation; the pages below are the markdown sources, which read without JavaScript.
Getting Started
- Quick Start: Get started with Rhizomium in just 5 minutes! This guide will help you create your first visual.
- Your First Graph: This guide will walk you through creating your first visual composition in Rhizomium. You'll learn the basics of the node editor and create a simple animated pattern.
- Interface Overview: Get familiar with the Rhizomium interface and learn how to navigate the editor efficiently.
Using the Editor
- Node System: Understanding the node-based architecture of Rhizomium.
- Working with Audio: Make your visuals react to music and sound! Rhizomium includes built-in audio analysis, with no extra software needed.
- Saving Your Work: Learn how to save, open and manage your Rhizomium projects.
- Web Patch Viewer: A published patch, running live in a browser, with no editor around it — /viewer. It is where a link to your work leads: the graph is compiled and rendered on the visitor's own GPU
- Working with Textures: Load, use, and manipulate image textures in your node graphs. Create rich, detailed visuals by combining procedural generation with real images.
- Compute Nodes: Learn how to use GPU-accelerated compute shaders to create powerful visual effects and simulations.
- 3D Field Visualization: Visualize compute shader outputs as 3D objects! Convert 2D and 3D fields into point clouds, meshes, and volumetric visualizations.
- Multi-Screen Output: Drive several displays from one patch, each showing its own part of the composition — a projector panorama, a video wall, or a stage rig where every surface gets its own slice.
- Accessibility: Rhizomium can be used without a mouse and with a screen reader. You can enlarge it and raise its contrast, have it check a patch for flashing before it plays, and preview your work
Animation & Control
- Parameter Expressions: Use mathematical expressions to create dynamic, animated parameters that respond to time, audio, and other inputs.
- Timeline & Keyframes: Create smooth, professional animations by setting keyframes for any parameter. Perfect for VJ performances, music videos, and animated visuals.
- MIDI Controller Integration: Control your visuals in real-time using MIDI controllers! Connect knobs, sliders, and pads to any parameter in your node graph.
- Input from Other Software: Rhizomium can take data and visuals from other applications running at the same time — TouchDesigner, Resolume, OBS, Max/MSP, a camera rig, a Python script — and send its own outpu
Reference
- Complete Node Reference: This document provides a comprehensive reference for all available nodes in Rhizomium. Nodes are organized by the same categories you see in the editor's add-node menu, and include
- Keyboard Shortcuts: Every command in the menu bar has a key, and the menu prints it next to the command — you never have to come here to find one. Help → Shortcuts / Keymap (Ctrl+/) shows this same ta
- Frame Rate & Display Refresh: The status bar's fps readout counts presented frames — frames the browser actually handed to your display. It is the same thing a game's FPS counter reports, and it is the only rat
- FAQ: Frequently asked questions about Rhizomium, the desktop app for Windows.
- Changelog: What changed in each Rhizomium release, newest first. Downloads for every version are on the GitHub releases page.
Advanced Topics
- Shader Compilation: The generated WGSL is viewable at any time from View → Show Console:
- Performance Tips: Optimize your Rhizomium node graphs for smooth, real-time performance.
- Performance Profiler: Monitor your visual's performance in real-time! Track frame rate, GPU usage, and identify performance bottlenecks.
- Frame Timing Monitoring: The Frame Timing Monitoring system provides comprehensive visibility into RAF (RequestAnimationFrame) performance, helping identify bottlenecks and frame drops in real-time.
- Camera Controls: This document describes the camera control system for the GLSL Node Editor's 3D viewport.
For Developers
- Local Installation: This guide covers running Rhizomium from source. To just use Rhizomium, install the Windows desktop app from the latest release - there is no web version to sign up for.
- Vercel Deployment: The web build - landing page, editor, web patch viewer, docs site - and the AI backend deploy to Vercel as one project. vercel.json in the repository root holds the whole configura
- Audio Analysis Design: Reference for the Audio Analysis node's internals. If you are trying to use the node, start with Working with Audio — this page is for anyone changing the detector, and exists main