@timkendrick/cl5-sdk

cl5-sdk

Scripting toolkit for the CL5 animation tool

Installation

npm install -g @timkendrick/cl5-sdk

This will make the cl5 command globally available.

Usage

Compile an animation into a JavaScript file:

cl5 compile /path/to/animation.json --output=/path/to/output.js

The resulting JavaScript file can be loaded into the CL5 animation editor page by pasting its contents into the browser console

Preview an animation in browser:

cl5 preview /path/to/animation.json --watch

This will launch a browser with the animation injected into the viewer, and automatically recompile the animation and reload the page whenever the animation file changes

Watching additional source files:

cl5 preview /path/to/animation.json --watch=/path/to/animation/resources/*.svg

This will additionally recompile the animation and reload the page whenever the additional files are changed

Full usage instructions:

cl5 --help

cl5 compile --help

cl5 preview --help

Animation file format

See the animation file reference for instructions on creating valid CL5 animation files.