mirror of
https://codeberg.org/armin/beamgrid.git
synced 2026-09-01 12:20:47 +02:00
update README
This commit is contained in:
parent
859f2aa1f6
commit
fc3e9cee59
1 changed files with 41 additions and 13 deletions
48
README.md
48
README.md
|
|
@ -1,7 +1,6 @@
|
||||||
# BEAMGRID
|
# BEAMGRID
|
||||||
|
|
||||||
A JUCE-based VST3 / AU spectrum analyzer with a fully black UI, teal accents,
|
BEAMGRID is a JUCE-based VST3 / AU spectrum analyzer with a fully black UI, teal accents, and a configurable display.
|
||||||
and a configurable display.
|
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||

|

|
||||||
|
|
@ -11,13 +10,10 @@ and a configurable display.
|
||||||
|
|
||||||
- **Three display modes** (`MODE` knob):
|
- **Three display modes** (`MODE` knob):
|
||||||
- **BARS** - classic log-spaced spectrum bars with peak-hold caps.
|
- **BARS** - classic log-spaced spectrum bars with peak-hold caps.
|
||||||
- **SPECTRUM** - a smooth (quadratic-spline) waveform trace of the spectrum,
|
- **SPECTRUM** - a smooth (quadratic-spline) waveform trace of the spectrum, with a matching smooth peak-hold wave. Use the `SMOOTH` knob to go from raw/edgy to heavily smoothed.
|
||||||
with a matching smooth peak-hold wave. Use the `SMOOTH` knob to go from
|
|
||||||
raw/edgy to heavily smoothed.
|
|
||||||
- **LED** - an LED-meter style view (`LEDS` knob sets LEDs per bar).
|
- **LED** - an LED-meter style view (`LEDS` knob sets LEDs per bar).
|
||||||
- **Frequency range** fixed to **20 Hz – 20 kHz**.
|
- **Frequency range** fixed to **20 Hz – 20 kHz**.
|
||||||
- **HUE** knob rotates the hue of every UI accent (knob arcs, peaks, title)
|
- **HUE** knob rotates the hue of every UI accent (knob arcs, peaks, title) without altering the underlying data.
|
||||||
without altering the underlying data.
|
|
||||||
- **UI scaling** dropdown (75% – 300%) in the top-right.
|
- **UI scaling** dropdown (75% – 300%) in the top-right.
|
||||||
- Per-project **size & scale persistence** (stored in the plugin state).
|
- Per-project **size & scale persistence** (stored in the plugin state).
|
||||||
|
|
||||||
|
|
@ -28,7 +24,7 @@ and a configurable display.
|
||||||
| PEAK GRACE | 0 – 2000 ms | Grace period before a peak-hold marker decays |
|
| PEAK GRACE | 0 – 2000 ms | Grace period before a peak-hold marker decays |
|
||||||
| PEAK FALLOFF| 0 – 1 | Peak-hold decay rate |
|
| PEAK FALLOFF| 0 – 1 | Peak-hold decay rate |
|
||||||
| BAR FALLOFF | 0 – 1 | Spectrum bar release speed |
|
| BAR FALLOFF | 0 – 1 | Spectrum bar release speed |
|
||||||
| BARS | 8 / 16 / 32 / 64 / 128 | Number of spectrum bands (snaps) |
|
| BARS | 8 - 128 | Number of spectrum bands (snaps) |
|
||||||
| HUE | 0 – 1 | Rotates the UI accent hue (0.5 = no change) |
|
| HUE | 0 – 1 | Rotates the UI accent hue (0.5 = no change) |
|
||||||
| MODE | 1 / 2 / 3 | BARS / SPECTRUM / LED |
|
| MODE | 1 / 2 / 3 | BARS / SPECTRUM / LED |
|
||||||
| LEDS | 4 – 48 | LEDs per bar in LED mode |
|
| LEDS | 4 – 48 | LEDs per bar in LED mode |
|
||||||
|
|
@ -45,9 +41,36 @@ and a configurable display.
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
Requires [CMake](https://cmake.org/) (>= 3.22) and a JUCE-supported
|
Requires [CMake](https://cmake.org/) (>= 3.22) and a JUCE-supported
|
||||||
toolchain (Xcode / clang on macOS, MSVC / GCC on Windows, etc.). JUCE is
|
toolchain (Xcode / clang on macOS, GCC / Clang on Linux, etc.). JUCE is
|
||||||
fetched automatically by CMake.
|
fetched automatically by CMake.
|
||||||
|
|
||||||
|
### macOS
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cmake -B build -G Ninja
|
||||||
|
cmake --build build --config Release
|
||||||
|
```
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
Install the JUCE system dependencies, then build:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Debian / Ubuntu (DEB)
|
||||||
|
sudo apt-get install -y libasound2-dev libfreetype6-dev libx11-dev \
|
||||||
|
libxcomposite-dev libxcursor-dev libxext-dev libxinerama-dev libxrandr-dev
|
||||||
|
|
||||||
|
# Fedora (RPM)
|
||||||
|
sudo dnf install -y alsa-lib-devel freetype-devel libX11-devel \
|
||||||
|
libXcomposite-devel libXcursor-devel libXext-devel libXinerama-devel libXrandr-devel
|
||||||
|
|
||||||
|
# Arch Linux / Artix
|
||||||
|
sudo pacman -S alsa-lib freetype2 libx11 libxcomposite libxcursor \
|
||||||
|
libxext libxinerama libxrandr
|
||||||
|
```
|
||||||
|
|
||||||
|
Build BEAMGRID:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
cmake -B build -G Ninja
|
cmake -B build -G Ninja
|
||||||
cmake --build build --config Release
|
cmake --build build --config Release
|
||||||
|
|
@ -56,10 +79,14 @@ cmake --build build --config Release
|
||||||
The built plugins are installed to your system plugin folders:
|
The built plugins are installed to your system plugin folders:
|
||||||
|
|
||||||
- `build/BEAMGRID_artefacts/Release/VST3/BEAMGRID.vst3`
|
- `build/BEAMGRID_artefacts/Release/VST3/BEAMGRID.vst3`
|
||||||
- `build/BEAMGRID_artefacts/Release/AU/BEAMGRID.component`
|
- `build/BEAMGRID_artefacts/Release/AU/BEAMGRID.component` (macOS only)
|
||||||
|
|
||||||
Then rescan in your DAW (FL Studio, REAPER, Logic, etc.).
|
Then rescan in your DAW (FL Studio, REAPER, Logic, etc.).
|
||||||
|
|
||||||
|
### Windows
|
||||||
|
|
||||||
|
It *should* work on Windows, too, but I have not tested that, and I have zero intentions to do so. Good luck.
|
||||||
|
|
||||||
## Project layout
|
## Project layout
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -74,3 +101,4 @@ Source/
|
||||||
## License
|
## License
|
||||||
|
|
||||||
See the repository license file.
|
See the repository license file.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue