Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Oscyl documentation

Oscyl is an open-source librarian and sound editor for hardware synths. It reads the programs on your synth, and lets you organise and edit them on a computer or a phone. Then it writes back only the programs you changed.

New here? Read the four pages of Start here in order, from What Oscyl is, and what it is not.

How this documentation is organised

PartRead it when you want toStart with
Start hereunderstand what Oscyl is and how it worksWhat Oscyl is
Tutorialslearn by doing, one lesson at a timeTry Oscyl without a synth
How-to guidesfinish one real taskAdd a driver for a new synth
Referencelook up a factThe driver contract
Explanationunderstand why Oscyl is made the way it isArchitecture

Explanation also holds the decision records (ADRs), which record decisions already made, and the RFCs, which propose a change before anyone makes it.

The Rust API reference of the crates that a driver or another project uses is on the website, at oscyl.github.io/oscyl/api.

Outside this book

  • README: the project’s front page, with the downloads.
  • CONTRIBUTING: how to send a change.
  • GOVERNANCE: roles, decisions, driver tiers and driver acceptance.
  • CHANGELOG: what each release changed.