Skip to content

Latest commit

 

History

History
77 lines (65 loc) · 2.46 KB

BUILDING.md

File metadata and controls

77 lines (65 loc) · 2.46 KB
Raw

Instructions For Building

ChowTape is built using CMake, along with the JUCE framework, and PluginGUIMagic for the UI. JUCE and PluginGUIMagic are included in the repository, but CMake must be installed before attempting to build. To build from scratch, you must first clone the repository and initialize the submodules using the following commands:

# Clone the repository
git clone --recursive https://github.com/jatinchowdhury18/AnalogTapeModel.git

# Enter the repository
cd AnalogTapeModel

# Initialize submodules
git submodule update --init --recursive

Next you can generate the builds with CMake:

cd Plugin

cmake -Bbuild -DCMAKE_BUILD_TYPE=Release
cmake --build build/ --config Release

Building for iOS

To build for iOS, you can use the following CMake configuration command:

cmake -Bbuild-ios -GXcode -DCMAKE_SYSTEM_NAME=iOS \
    -DCMAKE_OSX_DEPLOYMENT_TARGET=11.4 \
    -DCMAKE_XCODE_ATTRIBUTE_DEVELOPMENT_TEAM="$YOUR_TEAM_ID" \
    -DCMAKE_XCODE_ATTRIBUTE_TARGETED_DEVICE_FAMILY="1,2" \
    -DCMAKE_XCODE_ATTRIBUTE_ENABLE_BITCODE="NO"

Then, go to the build-ios/ directory, open the Xcode project, and build. Note that you may not need to pass the XCODE_ATTRIBUTE_DEVELOPMENT_TEAM argument if you're building for your own local device, or using the Xcode simulator. Alternatively, you could set the development team manually from within Xcode.

Linux Dependencies

The Linux build utilises the following dependencies:

  • libasound
  • libxcursor
  • libxinerama
  • libxrandr
  • freeglut3
  • libjack
  • libfreetype6
  • lv2-dev

These can be installed with the following command:

sudo apt-get install libasound2-dev libxcursor-dev libxinerama-dev libxrandr-dev freeglut3-dev libjack-jackd2-dev libfreetype6-dev lv2-dev

Depending on your Linux distribution, you may also need to install:

  • libGL
  • libXext
  • libcurl

Note that Linux dependencies may sometimes change during the development process. If you're local builds are failing due to a missing dependency, please review the latest dependencies used for our CI builds here.

Building with the GUI Editor

If you need to make changes to the GUI, you can build the plugin with Foley's Magic Editor attached. In Plugin/modules/CMakeLists.txt, set FOLEYS_SHOW_GUI_EDITOR_PALLETTE equal to 1.