/PluginBuilder

Primary LanguageC++MIT LicenseMIT

PluginBuilder

PluginBuilder is a development tool designed to accelerate the process of building, developing, and compiling plugins for TouchDesigner from within TouchDesigner. It facilitates real-time, script-like editing of plugins by leveraging CMake and Ninja for rapid compilation. The system automatically recompiles and reloads the plugin upon any source changes, with extremely fast build times that typically run under a second.

The build and compile processes are non-blocking, allowing TouchDesigner to run without any major stalls. The initial build (triggered by Create Plugin) is usually the longest where subsequent updates are completed in less than a second with minimal frame drops, depending on the caching and the scope of changes.

Requirements

  • TouchDesigner: Version 2023.11600 or newer, with a commercial or pro license.
  • Visual Studio: C++ development tools installed.
  • CMake: Installed and added to the system or user PATH.
  • Ninja: Installed and recognized in the system PATH.
  • OS: Windows only at this time.

    Optional

    • In order to build and compile plugins that depend on Cuda you'll need to install Cuda Toolkit. Currently TD uses CUDA 11.8 so that will be the easiest CUDA version to get working without requiring copying .dll's to the plugin or project path.

Installation

  1. PluginBuilder: Clone or download PluginBuilder from its repository.
  2. Visual Studio: If not already installed, install Visual Studio with C++ development tools.
  3. CMake: If not already installed, install CMake. Ensure it is added to your system path.
  4. Ninja: If ninja.exe is not in your PATH, download it from Ninja Releases, unzip, and copy ninja.exe to ${USER_PATH}/ninja.
  5. Configure settings.ini:
    • In the PluginBuilder directory open SetSettings.toe.
    • Navigate to the textDAT named settings.
    • Edit the fields as instructed in the comments.
    • The settings.ini file will be saved to ${USER_PATH}/AppData/Roaming/IntentDev/PluginBuilder.

Usage

  1. Load PluginBuilder: Drag PluginBuilder.tox into an existing TouchDesigner project saved on disk. (PluginBuilder can also be added to palette, but do not delete the PluginBuilder directory that is set in settings.ini...)

  2. Set Plugin Name: Enter a name for your plugin in the Plugin Name parameter.

  3. Select a Template: Choose a template from the Plugin Template menu.

  4. Create Plugin: Click Create Plugin. This will generate:

    • A PluginProjects folder in your project directory, containing a subfolder for your plugin. This subfolder includes a source folder with the copied template source.
    • A Plugins folder containing the .dll files. These are managed by PluginBuilder and loaded in plugin_loader CPlusPlus operator inside PluginBuilder.

  5. Edit Source Files: If Compile On Update is Active, any source change will automatically trigger a rebuild and compile. Ensure to save changes in your .toe before editing any source files - crashes due to a dll compiled with coding errors can happen...

  6. Edit CMake: Edit CMakelists.txt as required to include additional libraries.

  7. Install Plugin: This will install a completed plugin in the global plugins folder located in Documents/Derivative/Plugins for use in other projects.

    Usage Video Link

Visual Studio workflow debugging plugin loaded a custom operator in TD

  1. Create PluginBuilder Project: Follow steps 1 through 4 in Usage above and toggle off the Compile On Update parameter. Save the {YourToeName}.toe.

  2. Load Plugin: Restart the .toe so the new plugin shows up in the Op Create Dialog and load the custom operator in your network. Optionally disable cooking on PluginBuilder. Save and close {YourToeName}.toe.

  3. Open Visual Studio: Either right click in the the Plugin Project directory for your plugin and select Open with Visual Studio or open Visual Studio and select Open CMake project and navigate to the plugin project directory and open it.

  4. Edit and compile: Edit and compile as required in Visual Studio

  5. Debug: In the Select Startup Item dropdown menu at the top of the Visual Studio editor select Launch {YourToeName}.toe. Now click Launch {YourToeName}.toe to start TD attached to the Visual Studio Debugger, with the path to {YourToeName}.toe passed as an argument.

    VS Workflow Video Link

Visual Studio Notes

A path has been set for the PluginBuilder directory in CMakeList.txt and a paths for TouchDesigner.exe and {YourToeName}.toe have been set in launch.vs.json (located in the plugin project directory). If any of these paths change the respective files will need to be manually updated for Visual Studio to successfully configure, generate and compile the CMake project. The harcoded variables will have no effect on building from within PluginBuilder.

Contributing

Contributions to PluginBuilder are welcome and appreciated! If you're interested in improving the tool or adding new features please start a discussion!