diff --git a/README.md b/README.md new file mode 100644 index 0000000..62f3d8e --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Trommelkiste + +A 10-track drum sampler plugin built with [JUCE](https://juce.com/). + +## Tracks + +| # | Abbreviation | Instrument | +|---|---|---| +| 1 | BD | Bass Drum | +| 2 | RS | Rimshot | +| 3 | SN | Snare | +| 4 | CL | Clap | +| 5 | CH | Closed Hi-Hat | +| 6 | PH | Pedal Hi-Hat | +| 7 | OH | Open Hi-Hat | +| 8 | RD | Ride | +| 9 | LT | Low Tom | +| 10 | MT | Mid Tom | + +MIDI notes C4 through A4 (60-69) trigger the 10 tracks respectively. + +## Features + +- 32-voice polyphony +- Per-track parameters: Level, Length, Velocity sensitivity, Pitch, Tone (low-pass filter), Pan, Decay mode (saw envelope / gate) +- Built-in sample library with ~160 TR-909-style WAV samples embedded as binary data +- 4 kit presets: Classic, Punchy, Soft, Raw +- Cycle through samples per track with prev/next buttons +- Load custom samples via file picker (WAV, AIFF, FLAC) +- Adjustable UI scale (100%-200%) +- State save/restore (DAW recall) +- Outputs: VST3, AU, Standalone + +## Building + +```sh +make # build +make install # copy plugins to system directories +make clean # remove build directory +``` + +Requires CMake 3.22+, a C++17 compiler, and (on macOS) Xcode command-line tools. JUCE is cloned automatically on first build.