UnrealMCP Plugin

UnrealMCP Plugin

site icon
2025.03.21 2
C++AI控制Unreal Engine插件自动化工具开发效率
UnrealMCP是一个非官方的Unreal Engine插件,旨在通过AI工具控制Unreal Engine。它实现了Unreal Engine中的机器控制协议(MCP),允许外部AI系统以编程方式与Unreal环境交互和操作。该插件提供了TCP服务器实现、基于JSON的命令协议、编辑器UI集成等功能,支持场景操作和Python客户端脚本。
View on GitHub

Overview

基本能力

产品定位

UnrealMCP是一个用于Unreal Engine的AI控制插件,通过MCP协议实现AI与Unreal Engine的交互。

核心功能

  • TCP服务器实现,用于远程控制Unreal Engine
  • 基于JSON的命令协议,用于AI工具集成
  • 编辑器UI集成,便于访问MCP功能
  • 全面的场景操作能力
  • Python配套脚本,用于客户端交互

适用场景

  • AI辅助的Unreal Engine场景构建
  • 自动化Unreal Engine操作
  • AI驱动的Unreal Engine内容生成

工具列表

  • setup_unreal_mcp.bat:配置Python和AI助手(Claude for Desktop或Cursor)
  • run_unreal_mcp.bat:运行Unreal MCP服务
  • unreal_mcp_client.py:Python客户端脚本,用于连接和控制Unreal Engine实例

常见问题解答

  • 确保Unreal Engine正在运行MCP插件
  • 检查Claude for Desktop中的日志以获取stderr输出
  • 如果遇到问题,可以到Discord社区寻求帮助

使用教程

使用依赖

  • Unreal Engine 5.5(测试版本,可能支持更早版本)
  • 配置了Unreal Engine的C++开发环境
  • Python 3.7+(用于客户端脚本)
  • 支持MCP的LLM(如Claude for Desktop或Cursor)

安装教程

  1. 克隆或下载此仓库
  2. 创建或打开一个Unreal项目
  3. 在项目目录中创建"Plugins"文件夹(如果不存在)
  4. 将此仓库解压或复制到Plugins文件夹
  5. 运行setup_unreal_mcp.bat脚本(位于MCP文件夹中)
  6. 打开Unreal项目,在Edit > Plugins中启用插件
  7. 选择您喜欢的AI助手(Claude for Desktop或Cursor)

调试方式

  1. 启动Unreal编辑器
  2. 打开Claude for Desktop或Cursor,确保工具已成功启用
  3. 尝试以下示例命令:
  4. "What actors are in the current level?"
  5. "Create a cube at position (0, 0, 100)"
  6. "List available commands I can use with Unreal Engine"

许可证

该项目遵循 MIT 开源许可条款。