motion-canvas /motion-canvas

Visualize Your Ideas With Code

★ 19,967⑂ 915👁 91⑃ 748● 444▤ 94
TypeScriptMITCreated 2022-08-03motion-canvas.io
Download: v3.17.2v3.17.2 ↓3.17.22024-12-14
+119
Daily
19,967
stars
915
forks
91
watchers
748
prs
444
issues
94
releases

README

Motion Canvas

Motion Canvas is two things:

- A TypeScript library that uses generators to program animations.
- An editor providing a real-time preview of said animations.

It's a specialized tool designed to create informative vector animations and
synchronize them with voice-overs.

Aside from providing the preview, the editor allows you to edit certain aspects
of the animation which could otherwise be tedious.

 Using Motion Canvas

Check out our [getting started][docs] guide to learn how to use Motion Canvas.

 Developing Motion Canvas locally

The project is maintained as one monorepo containing the following packages:

| Name          | Description                                                    |
| ------------- | -------------------------------------------------------------- |
| 2d          | The default renderer for 2D motion graphics                    |
| core        | All logic related to running and rendering animations.         |
| create      | A package for bootstrapping new projects.                      |
| docs        | [Our documentation website.][docs]                             |
| e2e         | End-to-end tests.                                              |
| examples    | Animation examples used in documentation.                      |
| internal    | Internal helpers used for building the packages.               |
| player      | A custom element for displaying animations in a browser.       |
| template    | A template project included for developer's convenience.       |
| ui          | The user interface used for editing.                           |
| vite-plugin | A plugin for Vite used for developing and bundling animations. |

After cloning the repo, run npm install in the root of the project to install
all necessary dependencies. Then run npx lerna run build to build all the
packages.

 Developing Editor

When developing the editor, run the following command:

bash
npm run template:dev


It will start a vite server that watches the core, 2d, ui, and
vite-plugin packages. The template package itself contains a simple Motion
Canvas project that can be used during development.

 Developing Player

To develop the player, first build the template: npm run template:build. Then,
start npm run player:dev.

 Installing a local version of Motion Canvas in a project

It can be useful to install a local version of Motion Canvas in a standalone
project. For example, when you want to use your own fork with some custom-made
features to create your animations.

Let's assume the following project structure:


projects/
├── motion-canvas/ <- your local monorepo
└── my-project/ <- a bootstrapped project
    └── package.json


You can link the local packages from the monorepo by updating the package.json
of your project. Simply replace the version with a file: followed by a
relative path to the package you want to link:

diff
  "dependencies": {
-   "@motion-canvas/core": "^3.11.0",
+   "@motion-canvas/core": "file:../motion-ca

Top issues

Discussions

Latest release

v3.17.2 v3.17.2 2024-12-14
3.17.2 (2024-12-14)


 Bug Fixes

 core: fix incorrect rollup ordering (4743b92)
 vite-plugin, ui: project file path on selection (1090) (f15b375)

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON