跳到主要内容

Node.js

Motion Canvas 构建在 Vite 插件系统之上。要创建一个运行在 Node.js 上的插件,你只需 创建一个 Vite 插件 并将其导入到 vite.config.ts 文件中。除此之外, @motion-canvas/vite-plugin 还提供了一个符号,让你能够定义 Motion Canvas 特有的 选项。

首先为我们的插件创建一个文件。这次我们把它放在项目的根目录中,因为 Vite 插件不属于 运行时源代码。

我们使用 Vite 的 configureServer 钩子来添加一个自定义 端点。同时,entryPoint 选项让我们可以指定运行时插件的路径:

Project structure
project/
├── src/
│ ├── scenes/
│ │ └── example.tsx
│ ├── plugin.ts
│ └── project.ts
├── package.json
├── tsconfig.json
+ ├── myVitePlugin.ts
└── vite.config.ts
myVitePlugin.ts
import {Plugin, PLUGIN_OPTIONS} from '@motion-canvas/vite-plugin';

export default function myVitePlugin(): Plugin {
return {
name: 'vite-plugin-motion-canvas-example',

// extend the dev server using Vite plugin hooks:
configureServer(server) {
server.middlewares.use('/my-plugin', (req, res) => {
res.end('Hello from my plugin!');
});
},

// extend Motion Canvas:
[PLUGIN_OPTIONS]: {
entryPoint: './plugin.ts',
},
};
}

下面是我们如何在 vite.config.ts 文件中导入这样一个插件:

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

export default defineConfig({
plugins: [
motionCanvas(),
myVitePlugin(),
],
});

此外,由于我们在 Node.js 插件中定义了入口点,因此不再需要在项目文件中导入运行时 插件:

src/project.ts
import {makeProject} from '@motion-canvas/core';
- import myPlugin from './plugin';
import example from './scenes/example?scene';

export default makeProject({
scenes: [example],
- plugins: [myPlugin()],
});

请注意,我们将入口点定义为 './plugin.ts'。由于它是一个相对路径,因此会相对于项目 文件进行解析。一旦你将插件转换为独立的包,就可以改用包名。

你可以通过运行项目并访问 http://localhost:9000/my-plugin 来验证插件是否 正常工作。

向运行时传递选项​

Node.js 插件能够向运行时插件传递选项。我们可以使用 runtimeConfig 属性来实现:

myVitePlugin.ts
import {Plugin, PLUGIN_OPTIONS} from '@motion-canvas/vite-plugin';

export default function myVitePlugin(): Plugin {
return {
name: 'vite-plugin-motion-canvas-example',
// ...
[PLUGIN_OPTIONS]: {
entryPoint: './plugin.ts',
runtimeConfig: () => ({
foo: 'bar',
}),
},
};
}

然后我们可以更新运行时插件以接收这些选项:

src/plugin.ts
import {makePlugin} from '@motion-canvas/core';

interface MyPluginOptions {
foo: string;
}

export default makePlugin((options?: MyPluginOptions) => {
console.log(options?.foo); // 'bar'

return {
name: 'motion-canvas-plugin-example',
player(player) {
player.onRecalculated.subscribe(() => {
player.requestReset();
player.togglePlayback(true);
});
},
};
});