Documentation
Uzume is a music visualizer for macOS that listens, analyzes, and accompanies. These pages are for people who want to run it, and for people who want to write something for it to play.
Start here
Section titled “Start here”- Getting started — what it needs, how to download and install it, what the Screen Recording permission is for, and the questions most people arrive with.
- Using Uzume — what happens while a session runs, how to steer it, and what to do when it goes quiet.
- Contributing a scene — what a scene is on disk, how to get one rendering on your own Mac, what the gates check, and what happens after you open a pull request.
One word, two spellings
Section titled “One word, two spellings”This site calls a single visual — its own shapes, its own colors, its own way of answering a beat — a scene. The code and the repository call it a preset, and that is the word you will meet in filenames, folder names and JSON keys the moment you follow a link into the app repository. They are the same thing.
What these pages are not
Section titled “What these pages are not”They are a curated subset, rewritten. The app repository’s documentation is written maintainers-first — numbered decisions, increment IDs, internal shorthand — and stays canonical. Every page here names the upstream documents it was drawn from, so you can go read the long version.
Drawn from the app repository: README.md and CONTRIBUTING.md.