Skip to content

Installation

Video tutorial — coming soon

Octo Scene Assembler is a Toon Boom Harmony tool. It installs per user and needs no elevation.

The Octo Tools Installer

There is one installer for the whole Octo Tools suite. Download it once, tick the products you bought — here, Octo Scene Assembler — tick the Harmony installs to deploy into, and press Install.

Platform What you run
Windows Octo-Tools-Installer.exe
macOS Install Octo Tools.command

macOS ships as a script, not a signed app

Install Octo Tools.command is a plain shell script running the same Python as the Windows build — no .app, no code signing, no notarization. Double-click it. If macOS refuses, make it executable once:

chmod +x "Install Octo Tools.command"

The window has three parts:

  1. Detected hosts — the Harmony installs found on this machine.
  2. Products — one row per product, one checkbox per application. Nothing is ticked by default. A checkbox is disabled when that application was not detected.
  3. Licence key (optional) — one field per product row. Leave it empty and activate later inside the app.

Every ticked target is deployed to its native location, and the installer records exactly what it wrote in an uninstall manifest.

Licences are per product

One key never unlocks the suite. Octo Scene Assembler has its own licence — see Licensing & Activation.

Uninstalling

Tick the product's row and press Uninstall. Removal is per product and precise: only the paths recorded for that product are removed, so the other Octo tools on the machine are untouched.

What lands where

Shape Location
OctoSceneAssembler.js loose in the scripts root, plus the octoSceneAssembler/ bundle beside it Windows %APPDATA%\Toon Boom Animation\<product>\<version>-scripts\ · macOS ~/Library/Preferences/Toon Boom Animation/<product>/<version>-scripts/

Harmony only registers scripts found in the scripts root

The .js must sit loose in <version>-scripts/, never inside a subfolder, and the Python package must be in a folder named exactly octoSceneAssembler — that is the name the .js resolves. The installer gets this right; if you deploy by hand, match it exactly.

Harmony needs a system Python 3.9

Harmony launches user scripts through a system Python 3.9 on PATH. This applies to every Octo Tools product.

3.10 and newer are silently ignored — the script simply does not run, with no error at all. The installer detects Python 3.9 and warns if it is missing; it never blocks, so you can install Python afterwards.

Manual install

On a locked-down machine, deploy by hand — the layout above is the whole contract:

  1. Copy OctoSceneAssembler.js into <version>-scripts/.
  2. Copy the Python package into <version>-scripts/octoSceneAssembler/.
  3. Restart Harmony.

Opening it

Run Octo Scene Assembler from Harmony's Scripts menu, or add it to a toolbar.

The first launch starts a free trial — the full tool, no restrictions.

Where OSA keeps its data

%APPDATA%/Toon Boom Animation/Toon Boom Harmony Premium/octo_scene_assembler/
    license.json     the licence
    sessions/        one saved staging tree per scene
    osa.log          the log

One folder to back up, one folder to clear, and one file to send when you report a bug. See Sessions & Crash Recovery.

Next