Install ShowFlo
For now, ShowFlo is installed from source. You need Python 3.12 or newer.
1. Create the environment
Section titled “1. Create the environment”In the ShowFlo folder:
python3 -m venv .venv.venv/bin/pip install -e ".[dev,network,audio,video]"On Windows:
python -m venv .venv.venv\Scripts\pip install -e ".[dev,network,audio,video]"The groups in brackets are optional:
| Group | What it adds |
|---|---|
audio |
sound file playback (sounddevice, soundfile, soxr) |
video |
video cues |
network |
the HTTP and WebSocket control server, and the MCP server |
dev |
tests and code analysis, for ShowFlo developers |
Without audio, ShowFlo still starts: the Audio cue type is simply not offered, and a project
that contains audio cues opens normally.
2. Launch ShowFlo
Section titled “2. Launch ShowFlo”./showflo.sh # empty ShowFlo./showflo.sh my-show.sflo # open a projectOn Windows, scripts/windows/lancer_showflo_venv.bat does the same.
On GNOME, ./install_launcher.sh adds an icon to the Desktop and to Activities.
3. What next
Section titled “3. What next”Read Understand the cue list: it is the one idea to master before building a first show.