Reference
Where to look things up.
| You need | Look at |
|---|---|
| a class, a function, its thread and whether it is real-time safe | the API reference, generated from the public headers |
| the purpose, ports, threads and status of a module | the module’s README: core/<module>/README.md, adapters/<backend>/README.md; the catalogue is modules.md |
| exact behaviour, with examples as data | the spec: specs/ (see Specs and requirement IDs) |
| every port a backend implements, with threading rules | ports.md |
| what is done, in progress or planned | roadmap.md |
| the JUCE and Tracktion adapters, AI, education and the other satellite repositories | satellites.md |
| which modules a kind of application uses | applications.md |
| CMake functions, options and pinned versions | using-cmake.md |
| a runnable program for a task | examples/README.md |
| the commands of a domain | the *Commands.h header of its core (SetlistCommands.h, RoutingCommands.h, …), and the spec’s “Commands of this module” table |
| why something is the way it is | decisions/ |
| a term | Glossary |
| every document, one line each | llms.txt |
Specs by domain
Section titled “Specs by domain”| Area | Specs |
|---|---|
| foundations | time, commands, resilience |
| live show | setlist, cues, showcontrol, timecode, routing |
| protocols | midi, osc, netaudio, redundancy, sync |
| audio and production | engine, dsp, synth, formats, loudness, edit |
| user interface | ui_model, ui_bridge, ui_theme, ui_widgets |
| AI and analysis (in shuffle_ai) | inference, neural, llm, mir, ai_tasks |
A spec exists before its code: check the roadmap for whether a domain is implemented.
© 2026 Umberto Sorbo. The software is licensed under the Apache License, Version 2.0, and provided “as is”, without warranties or conditions of any kind; see the disclaimer.
SHUFFLE Framework and the SHUFFLE Framework logo are trademarks of Umberto Sorbo; the licence grants no rights to them (trademarks). Other names belong to their owners. Fonts: IBM Plex Sans and JetBrains Mono, SIL Open Font License 1.1.
Contact: shuffleframework@gmail.com · Instagram @shuffleframework. Security problems: write to the same address with “Security” in the subject, not in a public issue.