Importing Scripts

T-ANIMPA-007-002

To use scripts prepared by other users, transfer the .js files from the computer where the scripts were created to the one that you intend to use. Then use the Script Editor to import the .js files from where they are saved on your computer.

When working with Harmony Stand Alone, scripts that you created while working on a scene or imported are available for all other projects created on the same computer; there's no need for any kind of transfer or import. You can find your custom, default and imported scripts in:

NOTES
  • When you import a script, any user interface (.ui) or icon (.png) file that is in the same directory and has the same filename as the script will also be imported.

  • When using Harmony Stand Alone, user scripts are stored in the following location:

    • Windows: C:\Users\[username]\AppData\Roaming\Toon Boom Animation\Toon Boom HarmonyAdvanced\1600-scripts
    • macOS: /Users/[username]/Library/Preferences/Toon Boom Animation/Toon Boom HarmonyAdvanced/1600-scripts
    • GNU/Linux: /home/[username]/Toon Boom Animation/Toon Boom HarmonyAdvanced/1600-scripts

    When using Harmony Server, user scripts are stored in the following location, depending on the level at which you save them:

    • User: /USA_DB/users/[username]/Harmony Advanced/1600-scripts
    • Job: /USA_DB/jobs/[job_name]
    • Environment: /USA_DB/environments/[environment name]
    • Global: /USA_DB/scripts
  1. Do one of the following:
    • In the Script Editor toolbar, click on Import Script.
    • In the top-left corner of the Script Editor view, click on the Menu button and select File > Import Script.

    An Open dialog appears.

  1. In the Open dialog, browse to the location of the script you want to import. Select it, then click on Open.

    A dialog prompts you to select the location in which to import the script.

  1. In the drop-down menu, select the location in which you want to import the script:

    • User: Saves the script to a directory in your user preferences directory. You will be able to run and edit the script from any scene as long as you are logged in as the same user.

      NOTE If you are using Harmony Stand Alone, the script will be saved to the preferences for your account on your computer. if you are using Harmony Server, the script will be saved to the preferences for your Harmony database user.
    • Global: If you are using Harmony Server, select this option to save the script to the Harmony database's global script directory. Anyone who is logged in to the database will be able to edit and run this script.
    • Environment: If you are using Harmony Server, select this option to save the script to the current scene's environment. Anyone will be able to edit and run the script as long as they are working on a scene inside this environment.
    • Job: If you are using Harmony Server, select this option to save the script to the current scene's job. Anyone will be able to edit and run the script as long as they are working on a scene inside this job.
    • Scene: Save the script to the scene's scripts sub-folder. Anyone will be able to edit and run the script when working on this specific scene.
    • System Variable: Save the script to the directory in the TOONBOOM_GLOBAL_SCRIPT_LOCATION environment variable. This option is only available if this environment variable is set.

  1. Click on OK.

    The script is copied to the chosen location and can now be edited and executed in the Script Editor view. It can also be added as a button to the Scripting toolbar—see Adding Scripts as Toolbar Buttons.