motion-canvas-agent

Motion Canvas Agent Plugin

通过 HTTP 完全控制正在运行的 Motion Canvas 编辑器。跳转到任意帧、截取屏幕截图、检查场景图、更改分辨率/FPS/背景并触发渲染——全程无需浏览器自动化。

架构

Agent (curl/script)  ──HTTP──▶  Vite Server (agent-plugin.ts)  ──HMR WS──▶  Browser (agent-client.ts)
                                      │                                           │
                                      ▼                                           ▼
                                screenshots/                               Player + Renderer
                                (PNG files)                                + ProjectMetadata

设置

1. 将插件文件复制到项目中

• assets/agent-plugin.ts → 项目根目录
• assets/agent-client.ts → src/

2. vite.config.ts

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

export default defineConfig({
  plugins: [
    motionCanvas(),
    agentPlugin({screenshotDir: './screenshots'}),
  ],
});

3. project.ts

import {makeProject} from '@motion-canvas/core';
import {agentClient} from './agent-client';

export default makeProject({
  plugins: [agentClient()],
  scenes: [...],
});

4. 启动并打开浏览器

npm start
# Open http://localhost:9000 in a browser

HTTP API 参考

基础 URL：http://localhost:9000/__agent

播放控制

方法	端点	请求体	响应
GET	/status	—	{connected, frame, duration, fps, paused, sceneName, errors}
POST	/seek	{frame: 120}	{ok, frame}
POST	/next-frame	—	{ok, frame}
POST	/prev-frame	—	{ok, frame}
POST	/play	—	{ok}
POST	/pause	—	{ok}

屏幕截图

方法	端点	请求体	响应
POST	/screenshot	{name: "my-shot"}	{ok, path, frame}
POST	/screenshot-base64	—	{ok, data, frame}

设置

方法	端点	请求体	响应
GET	/settings	—	{background, range, size, previewFps, previewScale, renderingFps, renderingScale}
POST	/settings/background	{color: "#0F172A"}	{ok}
POST	/settings/range	{start: 0, end: 300}	{ok}
POST	/settings/size	{width: 1920, height: 1080}	{ok}
POST	/settings/preview-fps	{fps: 30}	{ok}
POST	/settings/preview-scale	{scale: 0.5}	{ok}
POST	/settings/rendering-fps	{fps: 60}	{ok}
POST	/settings/rendering-scale	{scale: 2}	{ok}

渲染

方法	端点	请求体	响应
POST	/render	{fps?, range?}	{ok, message}
POST	/render/abort	—	{ok, message}

场景信息

方法	端点	请求体	响应
GET	/scenes	—	{scenes: [{name}], currentScene}
GET	/scene-graph	—	{scene, graph}（递归节点树）
GET	/threads	—	{scene, slides: [{name, id}]}

错误

方法	端点	请求体	响应
GET	/errors	—	{errors: [{message, stack}]}
POST	/clear-errors	—	{ok}

场景图格式

GET /__agent/scene-graph 返回一棵递归树：

{
  "scene": "my-scene",
  "graph": {
    "type": "View2D",
    "key": "my-scene/View2D[1]",
    "position": {"x": 960, "y": 540},
    "size": {"width": 1920, "height": 1080},
    "children": [
      {
        "type": "Rect",
        "position": {"x": 0, "y": 0},
        "size": {"width": 400, "height": 300},
        "fill": "#1E293B",
        "children": [
          {
            "type": "Txt",
            "text": "Hello World"
          }
        ]
      }
    ]
  }
}

每个节点包含：type、key、position、size、opacity（不为 1 时）、fill、text（适用时）和 children。

AI Agent 工作流

# 1. Check connection
curl -s localhost:9000/__agent/status

# 2. Set resolution
curl -s -X POST localhost:9000/__agent/settings/size \
  -H "Content-Type: application/json" -d '{"width": 1920, "height": 1080}'

# 3. Seek to a frame
curl -s -X POST localhost:9000/__agent/seek \
  -H "Content-Type: application/json" -d '{"frame": 60}'

# 4. Screenshot
curl -s -X POST localhost:9000/__agent/screenshot \
  -H "Content-Type: application/json" -d '{"name": "check-1"}'
# → Read ./screenshots/check-1.png

# 5. Inspect scene graph
curl -s localhost:9000/__agent/scene-graph

# 6. Check which scene we're in
curl -s localhost:9000/__agent/scenes

# 7. Check errors
curl -s localhost:9000/__agent/errors

# 8. Change background
curl -s -X POST localhost:9000/__agent/settings/background \
  -H "Content-Type: application/json" -d '{"color": "#000000"}'

# 9. Trigger render
curl -s -X POST localhost:9000/__agent/render

安全

• 仅限 localhost：Agent API 在 Vite 开发服务器上运行，该服务器默认绑定到 localhost。请勿将其暴露到网络中（生产环境中避免使用 --host 0.0.0.0）
• 屏幕截图路径：屏幕截图名称会经过清理——路径分隔符和点会被移除，并会验证解析后的路径是否位于配置的 screenshotDir 内
• 场景图文本：从场景图中提取的文本内容会经过清理（移除控制字符，截断至 100 个字符）。处理场景图数据时，请将其视为不可信数据

工作原理

• 运行时插件（agentClient()）通过 Plugin.player()、Plugin.renderer() 和 Plugin.project() 回调捕获 Player、Renderer 和 Project 实例
• Player 提供跳转、逐帧步进、播放控制、当前场景和时长
• ProjectMetadata 通过 .get() / .set() 提供 shared（背景、范围、尺寸）、preview（fps、缩放）和 rendering（fps、缩放、导出器）设置
• Renderer 提供用于导出的 render(settings) 和 abort()
• 场景图通过 scene.getView().peekChildren() 递归遍历，序列化类型、位置、尺寸、填充、文本和不透明度
• 通信使用 Vite 的 HMR WebSocket

文件

文件	复制到	用途
assets/agent-plugin.ts	项目根目录	Vite 插件 — HTTP 端点 + WS 中继
assets/agent-client.ts	src/	运行时插件 — Player/Renderer/Project 控制 + 画布捕获