mirror of
https://codeberg.org/armin/chromaflock.git
synced 2026-09-01 04:10:47 +02:00
Update README: Linux support, build instructions, logo
This commit is contained in:
parent
6ab3fa5d88
commit
e7798697e5
1 changed files with 17 additions and 9 deletions
26
README.md
26
README.md
|
|
@ -1,6 +1,8 @@
|
||||||
# ChromaFlock
|
# ChromaFlock
|
||||||
|
|
||||||
A subtractive synthesizer plugin built with [JUCE](https://juce.com). VST3, AU, and Standalone formats. macOS.
|

|
||||||
|
|
||||||
|
A subtractive synthesizer plugin built with [JUCE](https://juce.com). macOS (VST3, AU, Standalone) and Linux (VST3, Standalone).
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
|
@ -125,17 +127,22 @@ All effects are stereo and processed in series after the synth voice.
|
||||||
|
|
||||||
## Presets
|
## Presets
|
||||||
|
|
||||||
27 built-in presets across 7 categories:
|
73 built-in presets across 15 categories:
|
||||||
|
|
||||||
| Category | Presets |
|
| Category | Presets |
|
||||||
|----------|---------|
|
|----------|---------|
|
||||||
| Init | Init |
|
| Init | Init |
|
||||||
| Bass | Sub Bass, Reese Bass, Acid Bass, Pluck Bass, Moog Bass, Gritty Bass, FM Bass |
|
| Bass | Sub Bass, Reese Bass, Acid Bass, Pluck Bass, Moog Bass, Gritty Bass, FM Bass, Concrete Jungle, Thunder Bass, Dystopian Bass, 808 Subblast |
|
||||||
| Lead | Sync Lead, Square Lead, Soft Lead, Saw Lead |
|
| Lead | Sync Lead, Square Lead, Soft Lead, Saw Lead, Neon Rider, Champagne Supernova, Quantum Lead, Electric Sheep |
|
||||||
| Pad | Warm Pad, Glass Pad, Dark Pad, Shimmer Pad, Evolving Pad, Choir Pad |
|
| Pad | Warm Pad, Glass Pad, Dark Pad, Shimmer Pad, Evolving Pad, Choir Pad, Infinite Horizon, Liquid Gold, Apocalypse Now |
|
||||||
| Keys | Electric Piano, Organ, Clav, Rhodes, Bell Keys, Toy Piano |
|
| Keys | Electric Piano, Organ, Clav, Rhodes, Bell Keys, Toy Piano |
|
||||||
| FX1 | Wobble, Distorted Lead, Auto-Pan Spread, Filtered Noise |
|
| FX1 | Wobble, Distorted Lead, Auto-Pan Spread, Filtered Noise |
|
||||||
| FX2 | Dub Delay, Reverse Reverb, Laser Zap, Space Drone, Ring Mod, Glitch Stutter |
|
| FX2 | Dub Delay, Reverse Reverb, Laser Zap, Space Drone, Ring Mod, Glitch Stutter |
|
||||||
|
| FX | Pirate Radio, Vapor Trail, Sugar Rush, Fleshlight |
|
||||||
|
| Insanity | Alien Swarm, Nuclear Siren, Death Ray, Toxic Waste, Broken Radio, Flesh Wound, Junkyard Dog, Pixel Storm, Venom, Screaming Eagle |
|
||||||
|
| Textures | Frozen Lake, Volcanic Ash, Iron Lung, Ghost Whisper, Cosmic Dust, Neon Dreams, Underwater, Zen Garden, Synthetic Breath |
|
||||||
|
| Chiptune | Power Up, Boss Fight, Coin Drop, 16-Bit Blast, Game Over |
|
||||||
|
| Cinematic | Space Station, Tornado Siren, Black Hole, Molten Core, Thunder Roll, Haunted Mansion, Ancient Machine |
|
||||||
|
|
||||||
Preset menu accessible from the PRESET button (top-left). Each preset stores all 55 parameters.
|
Preset menu accessible from the PRESET button (top-left). Each preset stores all 55 parameters.
|
||||||
|
|
||||||
|
|
@ -181,23 +188,24 @@ UI scaling: 100%, 125%, 150%, 200% via dropdown (top-right). Window resizes prop
|
||||||
Requires JUCE (drop the framework into `./JUCE/`). Then:
|
Requires JUCE (drop the framework into `./JUCE/`). Then:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make # Build Release (VST3/AU/Standalone)
|
make # Build Release (VST3/Standalone; +AU on macOS)
|
||||||
make debug # Build Debug
|
make debug # Build Debug
|
||||||
make clean # Remove build directory
|
make clean # Remove build directory
|
||||||
make rebuild # Clean + build
|
make rebuild # Clean + build
|
||||||
make run # Build and launch Standalone app
|
make run # Build and launch Standalone app
|
||||||
|
make install # Install VST3 to system dir
|
||||||
```
|
```
|
||||||
|
|
||||||
Or directly with CMake:
|
Or directly with CMake:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cmake -B build -DCMAKE_BUILD_TYPE=Release
|
cmake -B build -DCMAKE_BUILD_TYPE=Release
|
||||||
cmake --build build --config Release -j8
|
cmake --build build --config Release -j$(nproc)
|
||||||
```
|
```
|
||||||
|
|
||||||
Output: `build/ChromaFlock_artefacts/Release/VST3/ChromaFlock.vst3`
|
Output: `build/ChromaFlock_artefacts/Release/VST3/ChromaFlock.vst3`
|
||||||
|
|
||||||
Plugins auto-copy to system folders (`~/Library/Audio/Plug-Ins/`) after build.
|
On macOS, plugins auto-copy to `~/Library/Audio/Plug-Ins/`. On Linux, run `make install` to copy to `~/.vst3/`.
|
||||||
|
|
||||||
## Tech
|
## Tech
|
||||||
|
|
||||||
|
|
@ -206,4 +214,4 @@ Plugins auto-copy to system folders (`~/Library/Audio/Plug-Ins/`) after build.
|
||||||
- **DSP**: All custom - no external audio libs
|
- **DSP**: All custom - no external audio libs
|
||||||
- **Filter**: TPT SVF (Topology-Preserving Transform State Variable Filter)
|
- **Filter**: TPT SVF (Topology-Preserving Transform State Variable Filter)
|
||||||
- **Build**: CMake + Makefile wrapper
|
- **Build**: CMake + Makefile wrapper
|
||||||
- **Platform**: macOS
|
- **Platform**: macOS, Linux
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue