使用说明

项目简介

Blender MCP Addon (cuBe) 是一款Blender插件,它在Blender内部启动一个MCP服务器。该插件允许外部MCP客户端,例如Cursor AI,通过标准的MCP协议连接到Blender,并远程控制Blender的各项功能。这为使用AI助手程序化地创建、修改和管理Blender场景及3D模型提供了可能。

主要功能点

  • 双向通信: 通过Socket连接,实现AI助手与Blender之间的双向通信。
  • 对象操控: 支持创建、修改和删除Blender场景中的3D对象。
  • 材质控制: 允许应用和修改材质及颜色。
  • 场景信息获取: 能够获取Blender场景的详细信息。
  • 代码执行: 支持在Blender中执行Python代码,扩展功能。
  • 视口捕捉: 可以捕获Blender视口图像并传输给客户端。
  • 场景性能指标: 提供Blender场景的性能和统计数据。
  • 实时预览: 支持实时流式传输Blender视口更新。
  • PolyHaven资源集成: 集成PolyHaven在线资源库,支持下载和应用HDRI、纹理和模型 (需启用)。
  • Hyper3D Rodin模型生成集成: 集成Hyper3D Rodin API,支持通过文本或图像生成3D模型 (需启用并配置API密钥)。

安装步骤

  1. 下载或克隆仓库: 从GitHub仓库 https://github.com/TheMapleseed/cuBe 下载或克隆 cuBe 仓库到本地。
  2. 运行安装脚本 (推荐):
    • Windows: 双击运行 'install.bat',按照提示操作。
    • macOS/Linux: 打开终端,进入仓库目录,运行命令 'chmod +x install.sh',然后运行 './install.sh',按照提示操作。
  3. 手动安装 (如果自动安装失败):
    • 将 'addon.py' 文件复制到Blender的插件目录。插件目录位置通常为:
      • Windows: 'C:\Program Files\Blender Foundation\Blender[版本号]\scripts\addons'
      • macOS: '/Applications/Blender.app/Contents/Resources/scripts/addons/' 或 '~/Library/Application Support/Blender/[版本号]/scripts/addons/'
      • Linux: '/usr/share/blender/scripts/addons/' 或 '~/.config/blender/scripts/addons/'
    • 将复制后的 'addon.py' 文件重命名为 'blendermcp.py'。
  4. 启用插件: 启动Blender,进入 '编辑' (Edit) > '偏好设置' (Preferences) > '插件' (Add-ons),搜索 "BlenderMCP",勾选复选框启用插件。

服务器配置

MCP客户端连接Blender MCP服务器时,需要配置服务器连接信息。以下是一个JSON格式的配置示例,适用于大多数MCP客户端:

{
  "server name": "BlenderMCP",
  "command": "",
  "args": {
    "host": "localhost",
    "port": 9876,
    "protocol": "socket"
  }
}

配置参数说明:

  • '"server name"': 服务器名称,可以自定义,例如 "BlenderMCP"。
  • '"command"': 留空即可。因为Blender MCP服务器作为Blender插件运行,无需额外的启动命令。
  • '"args"': 连接参数。
    • '"host"': 服务器主机地址,Blender MCP服务器运行在本地,因此设置为 '"localhost"'。
    • '"port"': 服务器端口号,Blender MCP默认端口为 '9876'。
    • '"protocol"': 连接协议,Blender MCP使用Socket协议,设置为 '"socket"'。

基本使用方法

  1. 启动Blender: 安装并启用Blender MCP插件后,启动Blender。
  2. 启动MCP服务器: 在Blender界面中,按下 'N' 键打开侧边栏,找到 "BlenderMCP" 选项卡。点击 "Start MCP Server" 按钮启动MCP服务器。服务器默认监听端口为 9876。
  3. 连接MCP客户端: 在MCP客户端 (例如Cursor AI) 中,根据客户端的要求配置服务器连接信息。通常需要填入服务器地址 ('localhost') 和端口号 ('9876')。 对于Cursor AI,请参考仓库 README.md 中 "Integration with Cursor AI" 部分的说明进行配置。
  4. 使用AI助手控制Blender: 连接成功后,即可使用MCP客户端向Blender MCP服务器发送指令,控制Blender进行各种操作,例如创建对象、修改材质、获取场景信息等。

信息

分类

桌面与硬件