Motion Canvas 开源项目使用手册

1. 项目目录结构及介绍

Motion Canvas 是一个基于 TypeScript 的库，用于创建动画视频。它利用了Canvas API，并提供了一个Web编辑器来实时预览音频同步的动画。以下是对项目主要目录结构的概览：

• main：存放主分支代码，未特定指向某一分支。
• 2d：默认的2D渲染器包，处理2D图形的渲染工作。
• core：核心逻辑部分，涉及运行和渲染动画的所有相关逻辑。
• create：用于快速启动新项目的工具包。
• docs：项目文档网站的源码。
• e2e：端到端测试相关文件。
• examples：动画示例，常用于文档中展示。
• internal：内部使用的辅助工具集合，不直接对外暴露。
• player：一个自定义元素，用于在浏览器中播放动画。
• template：提供给开发者的一个模板项目，便于开发时的快速搭建和测试。
• ui：编辑器的用户界面代码。
• vite-plugin：Vite插件，支持动画的开发打包过程。
• gitignore, npmrc, prettierrc, package.json等：标准的Git忽略文件、NPM配置、代码风格规则以及项目依赖管理文件。

2. 项目的启动文件介绍

开发环境启动

若要本地开发或查看编辑器，重点关注以下几个命令：

• 进入项目根目录后执行 npm install 安装所有依赖。
• 然后，通过运行 npx lerna run build 来构建所有包。
• 对于编辑器，使用 npm run template:dev 启动Vite服务器，它监视core, 2d, ui, 和 vite-plugin 包，同时提供一个简单的Motion Canvas项目实例用于开发。

动画播放器开发启动

对于播放器组件的开发，首先确保已构建模板项目 (npm run template:build)，之后运行 npm run player:dev 以启动开发模式。

3. 项目的配置文件介绍

package.json

每个子包通常有自己的package.json文件，定义了包的元数据和脚本命令，比如构建、测试等流程。在根目录下，package.json 控制整个monorepo的基本配置与脚本，包括了Lerna管理和整体的构建指令。

lerna.json

Lerna配置文件，位于根目录，用于管理这个monorepo内的多个npm包。它定义了如何执行命令、版本控制策略等。

vite.config.js 或 vite-plugin配置

在开发编辑器时，可能需要调整vite.config.js来配置Vite服务器，例如允许加载外部资源（当链接本地包时），通过修改该文件可以添加插件或调整服务器设置。

.gitignore, .npmrc, prettierrc

这些是常规的配置文件，分别用来告诉Git哪些文件不需要纳入版本控制，配置npm的行为，以及代码格式化规则。

通过以上步骤和配置，开发者可以高效地进行项目开发和维护，确保Motion Canvas的功能正常运作并不断进化。