Rack/README.md

Rack

Rack is the engine for the VCV open-source virtual Eurorack DAW.

This README includes instructions for building Rack from source. For information about the software, go to https://vcvrack.com/.

Setting up your development environment

Rack's dependencies (GLEW, glfw, etc) do not need to be installed on your system, since specific versions are compiled locally during the build process. However, you need proper tools to build these dependencies.

Mac

Install Xcode or command line developer tools with xcode-select --install. Install CMake, preferably from Homebrew.

If you would like MacOS 10.7+ users to be able to run your binaries and plugins, install the MacOS 10.7 SDK using the xcodelegacy script.

Windows

Install MSYS2 and launch the mingw64 shell (not the default msys2 shell). Install build dependencies with the pacman package manger.

pacman -S git make tar unzip mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake

Linux

With your distro's package manager, make sure you have installed gcc, make, cmake, tar, and unzip.

Building

If the build fails for you, please report the issue with a detailed error message to help the portability of Rack.

Clone this repository and cd into it.

Clone submodules.

git submodule update --init --recursive

Build dependencies locally. You may use make's -j$(nproc) flag to parallelize builds across all your CPU cores.

make dep

You should see a message that all dependencies built successfully.

Build Rack.

make

Run Rack.

make run

Building plugins

Clone your favorite plugin in the plugins/ directory. e.g.:

cd plugins
git clone https://github.com/VCVRack/Fundamental.git

Clone submodules.

cd Fundamental
git submodule update --init --recursive

Build plugin.

make

License

Rack source code by Andrew Belt licensed under the BSD-3-Clause

Component Library graphics by Grayscale licensed under the CC BY-NC 4.0