Scripting with the Creator API

What is scripting in Creator?

You can write and execute scripts with the Creator API through the Script Editor.

This makes it easy to write, test, and run scripts in Creator.

What you can do with scripting

Scripts can read and manipulate almost anything that lives inside a Creator project:

• Walk and modify the scene graph — create, rename, group, and delete layers, shapes, and groups.

• Add and edit keyframes and animations on any animatable property.

• Apply styling — fills, strokes, gradients, opacity, blend modes, masks, and mattes.

• Read and modify the current selection.

• Control the timeline — play, pause, jump to a frame, or read the current frame.

• Import assets including Lottie files, SVGs, and images.

For the full surface, see the API Reference.

What scripting doesn't include

The Script Editor gives you access to most of the Creator API.

However, it doesn't include methods related to plugin messaging or life cycles. The following methods are not available inside a script:

• creator.ui — there is no companion UI iframe to post messages to.

• creator.on and creator.off — scripts run on demand, so there is no event subscription model.

• creator.closePlugin() — a script's lifetime ends when execution finishes.

If you need any of these — a custom UI, event hooks, or a longer-lived integration — build a plugin instead. See the Creator Plugins guides for setup, the plugin manifest, the UI iframe, and the publishing flow.

How to start scripting with the Script Editor

1. Open the Script Editor in Creator — either from the plugins menu, or with this direct link: Open the Script Editor.

2. Run your first script. Paste the following into the editor and press Shift + Enter:

   const layerCount = creator.activeScene.layers.length;
   console.log(`Active scene has ${layerCount} layer(s).`);

   The result appears in the console pane.

3. Try a template. The Script Editor ships with starter templates that demonstrate common patterns. Open a template from the Script Editor sidebar and run it the same way.

Whenever you create, update or remove scripts, these changes are saved to your browser. So feel free to iterate on your scripts, and close the Script Editor when you need to. Your scripts will be there when you open the editor again.