Get Started with iPlug2

How do I get started with iPlug2 on macOS?

To get started with iPlug2 on macOS, you'll need to set up your development environment properly. Here are the steps you should follow:

Requirements

1. Basic Knowledge of C++: Familiarity with C++ and git version control is necessary.
2. Tools Installation:
   • Xcode 10 or Higher: Xcode is essential for macOS development.
   • Latest Git for macOS: For version control.
   • Python 3.x: Needed for various scripts.
   • An Apple Developer Account: Required for notarizing and deploying applications.
   • Additional Tools (Optional but useful): Visual Studio Code for text editing, Reaper DAW for testing plug-ins.

Setting Up the Development Environment

1. Organize Your Projects: Create a folder (e.g., Dev) in your macOS user directory for organizing your projects.
2. Clone iPlug2 Repository: Use git to clone the iPlug2 repository.

   DownloadCopy code
   1git clone https://github.com/iPlug2/iPlug2.git

3. Download Dependencies:
   • Navigate to the iPlug2/Dependencies/IPlug directory.
   • Run the download-iplug-sdks.sh script to download the VST3 SDK.
   • Optionally, run the download-prebuilt-libs.sh script in iPlug2/Dependencies to download pre-built static libraries.

Compile an Example Project

1. Navigate to an Example: Go to iPlug2/Examples/IPlugInstrument.
2. Open the Project: Use Xcode to open the .xcworkspace file.
3. Select the Target Scheme: Choose the appropriate target (e.g., macOS-APP) in Xcode.
4. Build and Run: Press Command-R to build and run the app.

Tweak the Code

• As a test, you might want to change something simple, like the background color in the IPlugInstrument example.

Start Your Own Project

1. Use the duplicate.py Script: This script clones a project folder and replaces template names with your new project's name.

   DownloadCopy code
   1cd iPlug2/Examples
   2python duplicate.py IPlugEffect MyNewPlugin MyManufacturerName

2. Initialize a Git Repository: For your new project, initialize a git repository and commit your changes.

3. Open Your New Project: Open the .xcworkspace file in Xcode.

By following these steps, you'll have a basic setup ready for iPlug2 development on macOS. Remember to periodically update your cloned iPlug2 repository to get the latest changes and improvements.