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

Repository layout

The top-level folders and files of the repository, and what each one holds. A tour of the code says how the crates work together.

Crates

PathWhat it holds
crates/oscyl-driverThe driver contract, the shared SysEx helpers and the request engine.
crates/drivers/One crate for each synth model: its protocol, program model, files and simulator. Also logue, which the KORG logue drivers share, and tutorial-synth, the driver of the tutorial “Your first driver”.
crates/oscyl-conformanceThe checks that every driver must pass.
crates/oscyl-coreThe .oscyllib library format, and the parts of Generate that no driver owns.
crates/oscyl-midiThe transports (midir on the desktop, or bytes that the platform moves) and DRIVERS, the drivers that the apps know.
crates/oscyl-appThe app logic that every app shares: documents, libraries, settings, the synth worker, the editor, Generate, translations.
crates/oscyl-ffiThe UniFFI bindings over oscyl-app, for the mobile apps.
crates/oscyl-cliThe command line tool, oscyl.
crates/oscyl-osc-hostTests of the oscillator unit: its C, compiled for the computer.

Apps

PathWhat it holds
apps/linuxThe desktop app (oscyl-gtk), for Linux, Windows and macOS. Its desktop entry, AppStream metadata, icons and fonts are in apps/linux/data/.
apps/mobile/sharedThe mobile apps’ UI and the bindings, in common Kotlin.
apps/mobile/androidAppThe Android entry, USB-MIDI and the manifest.
apps/mobile/iosAppThe Xcode project of the iOS app.
apps/mobile/iosPlatformThe iOS platform code that needs no Rust core: CoreMIDI, files, haptics, storage and language.
apps/mobile/baselineprofileThe Baseline Profile generator and the frame benchmarks.

Everything else

PathWhat it holds
units/oscyl-oscThe oscillator unit: its C source, KORG’s logue SDK files and the prebuilt payloads.
docs/This book. docs/images/ holds the pictures of the README and the website.
site/The website’s landing page.
design/tokens.jsonThe design tokens: every colour, shape, spacing and motion value of both apps.
DESIGN.mdThe design system.
po/The gettext translations.
packaging/The Flatpak manifest, the bundle scripts for Windows and macOS, and the install notes.
scripts/The local checks (ci.sh) and the build, release and asset scripts.
fuzz/The fuzz targets of the parsers.
.github/The workflows, the issue forms, the pull request template and the Vale styles.
.vale.ini, lychee.tomlThe settings of the prose check and of the link check.
_typos.toml, deny.toml, about.tomlThe settings of the spelling check, of cargo-deny and of cargo-about.