 |
Rack-SDK v2
|
|
Rack-SDK v2
|
Unofficial CMake targets and API for VCV Rack 2 SDK.
Created by StoneyDSP (no affiliation with VCV Rack or its' creators).
This is an empty project containing primarily a CMakeLists.txt file and some license information.
The CMakeLists.txt file is designed to find a local copy of the Rack SDK using the variable named RACK_DIR; once found, the CMakeLists.txt file instructs CMake how to arrange the SDK files into logical CMake-style "targets".
Developers who are building plugins (suites of "modules") for VCV Rack 2 may use these "targets" in their own CMake projects, by using find_package(rack-sdk), followed by target_link_libraries(yourTarget PRIVATE unofficial-vcvrack::rack-sdk::lib), and such forth, in their project's CMakeLists.txt file.
This provides a way of setting up the C++ toolchain - the compiler, linker, and other tools - in a CMake project to create library files (and test executables) which are compatible with the VCV Rack 2 runtime (the Rack executable).
Additionally, developers who acquire Rack-SDK using these CMake targets will be able to use a custom, lightweight CMake API to easily build a VCV Rack plugin and scale it up with modules. Here's an example project's CMakeLists.txt file:
...and that's it!
See StoneyVCV for a working example.
This CMake project expects that you have an unmodified copy of the correct Rack 2 SDK on your filesystem (for now...), and for the correct platform. The location of this Rack SDK copy is passed in to CMake when configuring the VCVRack project (-DRACK_DIR="path/to/unzipped/Rack-SDK"), and in return, CMake will generate three targets for linkage:
unofficial-vcvrack::rack-sdk::dep - the header file contents of <RACK_SDK>/dep/includeunofficial-vcvrack::rack-sdk::core - the header file contents of <RACK_SDK>/includeunofficial-vcvrack::rack-sdk::lib - the libRack.{so,dylib,dll,dll.a} library fileAll three targets are passed to CMake's "install" routine, which makes them relocatable within the context of the CMake buildsystem. This allows CMake to relocate and/or make copies of the SDK files, and do whatever it likes to do with them, without causing any breakages.
See StoneyVCV for a working example.
Download VCV Rack and the Rack SDK (Windows x64 / Mac x64+ARM64 / Linux x64). Install VCV Rack, and unzip the SDK to any location on your local filesystem.
Clone this project and move into the VCVRack SDK directory:
Configure CMake with a source directory (-S), a build directory (-B), and the RACK_DIR variable (-DRACK_DIR=).
Once configuration is complete, use the --install command on the build output directory, optionally with the --prefix arg to specify where the files should be "installed" to (here, just to ./install in the current working directory):
The above allows us to "acquire" the VCVRack SDK files as if it were a "package" dependency in another project (i.e., in a VCV Rack plugin project) via vcpkg package manager for C and C++.
To facilitate the above, a vcpkg portfile can simply download the SDK zip file, unzip it, and pass along the unzipped output directory as RACK_DIR when configuring this as a CMake package dependency...
See StoneyVCV for a working example.
Rack-SDK for CMake packs some interesting features into its' design, including some well - thought-out and thoroughly tested build system features.
To streamline much of these many options and configurations, we have provided some additional functionality which will brings a lot more control over the build (and deloyment, and debugging, and tests...) under smaller "macro"-like functions, with the use of tools such as CMake Presets and Makefile commands.
These additional functions provide a wide coverage of the full feature set, usually in just a single command line argument each.
The following CMake Presets are available for easy access to various configurations:
To use a CMake Preset, you can just pass the --preset= arg to CMake (no other args required):
The above command will configure the CMake project for Windows 64-bit in Release mode using the same settings that the Rack-SDK itself implements, respectively
As a further helper, we have also organized our Makefile to automatically detect a relevant CMake Preset - if not manually chosen - and run CMake for us, using an even simpler command, which works on all platforms:
The above command will configure the plugin for the host machine's platform; the CPU and OS are detected by the Rack-SDK itself, while the common environment variables VERBOSE and DEBUG may also be set or unset, to further adapt the behaviour of make configure according to your current environment.
Further CMake actions and workflows can be triggered via make in a similarly environment-sensitive manner:
Clears the current CMake cache file (not dir!) and runs the configure step again
Builds all currently-enabled CMake targets (none currently)
Runs CTest on the build output directory, executing any tests it finds (none currently)
*Creates a local directory (./install) containing a distributable package, unarchived*
The GitHub Workflows in this repository may be a useful reference, if any doubts.
The files under share/ and include/ are not actually in use; those are just reference material, and a helper to silence some warnings from vcpkg, respectively. Everything of interest is in either the CMakeLists.txt, vcpkg.json, or elsewhere...
1.9.8