跳到主要内容

配置

Motion Canvas 在 Vite 的配置文件中进行配置:

vite.config.ts
import {defineConfig} from 'vite';
import motionCanvas from '@motion-canvas/vite-plugin';

export default defineConfig({
plugins: [
motionCanvas({
// custom options
}),
],
});

project​

  • 类型:string | string[]
  • 默认值:./src/project.ts

项目文件的导入路径,相对于配置文件而言。也支持 glob。项目文件必须包含一个默认导出,即 Project 类的实例。

当设置为数组时,编辑器将显示项目选择界面,从而无需重启 Vite 即可切换项目。

motionCanvas({
project: [
'./src/firstProject.ts',
'./src/secondProject.ts',
],
});

output​

  • 类型:string
  • 默认值:./output

动画将保存到的输出路径,相对于配置文件而言。

渲染时,完整路径的格式如下:

[output]/[projectName]/[frameNumber].[extension]

静帧会保存到 still 子目录中:

[output]/still/[projectName]/[frameNumber].[extension]

bufferedAssets​

  • 类型:RegExp | false
  • 默认值:/\.(wav|ogg)$/

定义在发送到浏览器之前应缓冲哪些资源。

直接从磁盘流式传输较大的资源可能会导致其他应用程序出现问题。例如,如果项目中使用了音频文件,Adobe Audition 会认为它“正被其他应用程序使用”并拒绝覆盖它。

缓冲的资源会先加载到内存中,再从内存流式传输。这样原始文件保持可修改状态,同时热模块替换仍能正常工作。

editor​

  • 类型:string
  • 默认值:@motion-canvas/ui

编辑器包的导入路径。

此选项可用于开发/使用不同于官方的编辑器。路径将使用 Node.js 模块解析规则进行解析。它应指向一个包含以下文件的目录:

  • editor.html - 编辑器的 HTML 模板。
  • styles.css - 编辑器样式。
  • main.js - 一个导出所需工厂函数的模块。

main.js 应导出以下函数:

  • editor - 接收项目工厂作为第一个参数,并创建用户界面。
  • index - 接收所有项目的列表作为第一个参数,并创建用于选择项目的初始页面。

proxy​

  • 类型:boolean | MotionCanvasCorsProxyOptions
  • 默认值:false

用于远程资源的代理(Proxy)配置。

这会将配置传递给 Motion Canvas 的代理。代理默认处于禁用状态。你可以传入 true 或一个配置对象来启用它。

  • allowedMimeTypes?: string[] - 设置默认允许哪些类型的资源。支持右侧的通配符。传入空数组将允许所有类型的资源,但不建议这样做。默认值为 ["image/*", "video/*"]。
  • allowListHosts?: string[] - 设置允许的主机。请注意,主机是第一个 / 左侧、协议 https:// 右侧的部分。默认情况下不使用允许列表,不过建议你考虑仅设置相关的主机。