Toon Boom Harmony Plugins

Toon Boom Harmony plugins and scripts extend the core animation workflow by automating repetitive rigging tasks, adding advanced visual effects, and streamlining pipeline integration. While the software is robust out-of-the-box, these add-ons are essential for high-end studio productions and independent artists looking to speed up their delivery. Types of Add-ons There are three primary ways to extend Toon Boom Harmony:

Custom Scripts (.js): These are JavaScript-based tools that handle common tasks like renaming nodes, baking parent transformations to drawings, or managing pivots.

OpenFX Plugins: Harmony Premium supports OpenFX, allowing users to integrate third-party visual effects directly into the Node Library.

Gaming SDKs: Specialized plugins like the Harmony Unity SDK allow for seamless transfer of character rigs and animations into game engines. Essential Script Collections

Several community-developed script packages are widely considered standard in professional pipelines:

Raindrop Moment Scripts: A popular collection including tools like Batch Rename Cels, Remove Unused Colors, and Contour Generator.

dpotekhin Harmony Scripts: A comprehensive GitHub repository featuring tools such as PS_DeformerTools for working with complex deformers and PS_ExpressionEditor for custom logic.

SMF Script Updater: A manager script that simplifies the installation and updating of multiple script sets simultaneously. Specialized & Pipeline Tools Import Photoshop Brushes I Storyboard Pro 25 and Harmony 25

Toon Boom Harmony is a professional 2D animation software that supports third-party extensibility and pipeline integration through various plugin architectures and SDKs . While academic "papers" specifically on plugins are rare, technical documentation and industry-focused research detail how these extensions function within high-end production environments. Core Plugin & Integration Architectures Toon Boom Harmony Plugins

Toon Boom Harmony utilizes several methods for extending its core functionality:

OpenFX Plugins: Harmony supports OpenFX (OFX), an open standard for visual effects plugins . This allows studios to use professional-grade effects—such as those from Sapphire or GenArts—directly within the Harmony Node view to apply complex masking, lighting, and texture effects to 2D layers .

Gaming SDK (Unity Integration): For game development, Harmony provides a specialized Harmony Unity SDK . This package includes:

Native C++ Libraries: Processes Harmony-specific animation data within Unity .

Runtime Scripts: Handles the execution of Harmony frames and physics during gameplay .

Shader Graphs: Customizable shaders that ensure Harmony-specific visuals (like line textures and deformers) render correctly in a 3D engine .

Pipeline Scripting: Studios often use Harmony Scripts (often using Qt Script/JavaScript) to automate repetitive tasks or bridge data between Harmony and project management tools like Toon Boom Producer . Research and Case Studies on Pipeline Integration

Technical research often focuses on how these plugins and integrated tools optimize production: Harmony 24 Premium Documentation: About the Unity SDK Toon Boom Harmony plugins and scripts extend the

Toon Boom Harmony is widely regarded as the industry standard for 2D animation, used by major studios like Disney and Ubisoft

. While the software itself is incredibly robust, its "plugins"—often referred to as scripts or add-ons—are essential for streamlining complex rigging and scene management tasks that can otherwise be daunting due to a steep learning curve Key Plugin Categories & Notable Tools Workflow & Automation Scripts

: These are the most common "plugins" used to bypass repetitive manual work in the Node View. Find and Replace Node Name

: A crucial script for large-scale rigging that allows users to quickly rename multiple selected nodes using specific criteria or prefixes. Selection & Hierarchy Tools

: Many professional animators use custom scripts to navigate complex character hierarchies without digging through the Node View, such as tools that automatically select parent pegs or center the view on active nodes. Official Add-ons Toon Boom Ember AI-powered add-on

introduced as a beta for Harmony 25. It assists professional teams by automating repetitive creative tasks, allowing them to focus on high-level artistic work. Producer Integration : For studio environments, the Producer Harmony Scripts

are vital for synchronizing asset libraries and managing scene "baking" across remote teams. Third-Party Community Tools

: Experienced users often recommend looking for scripts from specialized creators (like those found on Gumroad or specific animation forums) that handle "layer selectors" or advanced z-depth management for complex puppet rigs. Quick Verdict Dramatically speeds up complex rigging and node management. Some scripts can be buggy or break during major software updates Essential for "industry standard" studio pipelines. High cost for the Premium tier required to use many advanced scripts/nodes. New AI tools like Ember offer cutting-edge efficiency. Plugin Name: Harmony Flow 8

Finding and installing high-quality 3rd-party scripts requires research. Note on Versions

: Most advanced scripting and plugin functionality is reserved for Harmony Premium . Users on the Essentials or Advanced

versions may find their ability to use third-party scripts limited by the lack of the full Node View or scripting API. character rigging specifically, or are you trying to improve your rendering and effects


Plugin Name: Harmony Flow

8. FX Preset Gallery (Node-Based)


3.3 Python API (Harmony 22+ Premium)

With Harmony 22 (and later), Toon Boom introduced a Python 3 API for deeper automation. This is the closest to a true plugin system.

Capabilities:

Example:

from toonboom.api import scene, node
my_node = scene.get_selected_node()
node.set_parameter(my_node, "color", [1,0,0])

Note: The Python API is not yet fully exhaustive (e.g., no direct drawing surface pixel access).


Sample plugin: Batch Export Manager (high-level spec)

Creating Your Own Plugins

For those interested in developing their own plugins, Toon Boom offers extensive documentation and resources. Learning to script in Python or JavaScript is a good starting point, as these are commonly used languages for Harmony plugins.

The Future of the Pipeline

As animation pipelines become more integrated, the role of plugins is shifting from simple "helpers" to essential infrastructure components. We are seeing a trend toward pipeline integration, where plugins serve as the glue holding together a studio's asset management system (such as Shotgrid or ftrack) and the Harmony software itself.

Types of Plugins and Scripts

To understand Harmony plugins, it is necessary to distinguish between the different levels of integration:

  1. Scripting (Python/JavaScript): Most "plugins" available to the community are scripts. Harmony provides a comprehensive API (Application Programming Interface) that allows developers to write scripts that interact with the software’s internal logic. These can be simple utility scripts or complex custom toolbars.
  2. OpenFX (OFX): Harmony supports the OpenFX standard, meaning it can utilize many industry-standard visual effects plugins. This opens the door to a massive library of blurs, glows, and color correction tools that are used across the film and television industry.
  3. Game Development Bridges: With the rise of 2D gaming, several plugins now exist to bridge Harmony with engines like Unity and Unreal Engine, facilitating the export of skeletal mesh data and sprite sheets.

Key plugin types & uses