README.md

Spiro

⚠️ Pre-Alpha

Semi-modular VST / Standalone Synthesizer

Features marked with * are unstable. Features marked with ** are to be implemented or still in progress and may change in future updates.

Module	Feature	Options
VCO (4X)	Modes	Poly, Mono (Retrigger, **Legato), Freerun
	Modulation	Amplitude (AM), Frequency (FM), Pulse Width (PWM), Phase Locked Loop (PLL), Detune, **Sync
	Waveforms	Tomisawa (Adjustable pulse-width sine), Pulse, Hexagon (Saw - Triangle - Ramp)
CSO (2X)	Modulation	*Frequency, *Warp
	Waveforms	*Sprott, *Helmholz, *Halvorsen, *TSUCS
ADSR (4X)	Modes	Triggered
VCA (2X)	Modulation	Amplitude
LFO (2X)	Modulation	Amplitude, Frequency
	Waveforms	Sine, Square, Ramp, Saw, Triangle
SNH (2X)	Modulation	Time
Delay	Modulation	Time, Feedback
VCF (2X)	Modulation	Frequency, Resonance
	Outputs	Low Pass, High Pass, Band Pass
Rotor	Modulation	Angle X, Angle Y, Angle Z
Mixer	Modulation	LC->L Crossfade, RC->Right Crossfade

Build Instructions

Prerequisites

Before building, ensure you have:

• C++20 or later

• A compatible compiler:

  • Windows: MSVC / Clang
  • Linux: GCC / Clang
  • macOS: Xcode / Clang

Steps to Build

Linux

1. Clone the Repository

   git clone https://github.com/p-o-l-e/spiro.git
   

2. Compile

   mkdir build
   cd build
   cmake -DCMAKE_BUILD_TYPE=Release ..
   make
   

3. Run (Standalone Mode)

   ./build/Spiro_artefacts/Standalone/spiro
   

Windows

1. Clone the Repository

   git clone https://github.com/p-o-l-e/spiro.git
   

2. Compile

   cmake -B build -G "Visual Studio 18 2026"
   cmake --build build --config Release
   

3. Run (Standalone Mode)

   ./build/Spiro_artefacts/Standalone/spiro
   

⚠️ Pre-Alpha Caveats:

Spiro is still in its early pre-alpha phase, meaning some features may be incomplete, unstable, or subject to change as development progresses.

Known Limitations:

Potential bugs & crashes – The codebase is evolving, so unexpected behavior may occur.

UI/UX refinements ongoing – Some interface elements may not be fully optimized.

Performance tuning in progress – Audio processing efficiency may vary depending on the system.

Cross-platform compatibility not guaranteed – Currently tested only on Linux, with macOS and Windows testing needed.

Feature changes may happen – Some modules, parameters, or workflows might be adjusted before the first stable release.