Andrew Belt 7b697b1487 Update dist license for new libraries		7 years ago
.github	Add Github issue template	7 years ago
dep	Fix rtmidi build and linker flag on Windows	7 years ago
ext	Adjust transparency	7 years ago
include	Changed log() to info(), warn(), and fatal()	7 years ago
plugins	Add stub to plugins directory	7 years ago
res	Add LEDBezel, change sizes of LEDs	7 years ago
src	Changed log() to info(), warn(), and fatal()	7 years ago
.gitignore	Set FrameBuffer::oversample to 1 by default	7 years ago
.gitmodules	Remove dr_libs submodule	7 years ago
CHANGELOG.md	Add SearchModuleField to RackWidget	7 years ago
Info.plist	Remove version strings from Info.plist on Mac	7 years ago
LICENSE-dist.txt	Update dist license for new libraries	7 years ago
LICENSE.txt	Relicensed to BSD-3-Clause	7 years ago
Makefile	Merge branch 'master' of https://github.com/VCVRack/Rack	7 years ago
README.md	Reverted light sizes in components.hpp, updated README	7 years ago
Rack.rc	Fix Windows build, use portaudio pre-builds, remove curl init/destroy	7 years ago
Rack.res	Fix plugin and request.hpp bugs, add icon res file to Windows	7 years ago
Rack.sh	Add Rack.sh Linux wrapper script	7 years ago
arch.mk	Various tweaks and fixes	7 years ago
compile.mk	Clean up build system	7 years ago
icon.icns	Update Mac icns icon	7 years ago
icon.ico	Tweak icons again	7 years ago
installer-banner.bmp	Finished Windows installer	7 years ago
installer.nsi	Finished Windows installer	7 years ago
plugin.mk	Clean up build system	7 years ago

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/.

The Issue Tracker is the official developer's forum

Bug reports, feature requests, and even questions/discussions are welcome on the GitHub Issue Tracker for all VCVRack repos. However, please search before posting to avoid duplicates, and limit to one issue per post.

You may vote on feature requests by using the Thumbs Up/Down reaction on the first post.

I rarely accept Pull Requests, so please notify me in advance to plan your contribution before writing code.

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. Install CMake (for some of Rack's dependencies) and wget, preferably from Homebrew.

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. If you would like to build a previous version of Rack instead of the master branch, check out the desired tag with git checkout v0.4.0 for example.

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

Be sure to check out and build the version of Rack you wish to build your plugins against.

You must clone the plugin in Rack's 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 BSD-3-Clause

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