py-ue5-mcp-server

py-ue5-mcp-server

site icon
2025.04.10 0
PythonUnreal Engine 5 集成自然语言控制3D 对象管理开发效率
py-ue5-mcp-server 是一个基于 Python 的 Model Context Protocol (MCP) 服务器,用于连接 Claude 和 Unreal Engine 5。它通过自然语言处理能力,使用户能够通过对话与 Claude 交互,从而在 Unreal Engine 5 中创建、操纵和控制 3D 对象及蓝图演员。该服务器利用 Unreal Engine 的 Remote Control API,实现了自然语言控制、蓝图演员交互、场景管理、资产发现和实时反馈等功能。
View on GitHub

Overview

基本能力

产品定位

py-ue5-mcp-server 是一个桥梁工具,连接 Claude 的自然语言处理能力和 Unreal Engine 5 的 3D 环境,旨在通过自然语言简化 Unreal Engine 5 中的对象创建和场景管理。

核心功能

  • 自然语言控制:通过对话创建和操纵 3D 对象。
  • 蓝图演员交互:通过简单文本提示访问蓝图演员的功能。
  • 场景管理:通过文本指令构建、修改和排列场景。
  • 资产发现:通过 Claude 搜索和使用 Unreal 项目中的资产。
  • 实时反馈:在 Unreal Engine 视口中即时查看结果。

适用场景

  • 快速原型设计:通过自然语言快速创建和修改 3D 场景。
  • 教育演示:展示如何通过对话控制 Unreal Engine 5。
  • 自动化测试:通过脚本自动化 Unreal Engine 5 中的对象操作。

工具列表

  • get_all_scene_actors:获取当前关卡中的所有演员列表。
  • spawn_actor:在当前 Unreal Engine 关卡中生成蓝图演员。
  • spawn_snowman_family:生成三个雪人家庭。
  • modify_actor:修改现有演员的属性。

常见问题解答

  • 连接问题:确保 Unreal Engine 正在运行,Remote Control API 插件已启用。
  • 命令执行问题:从简单命令开始,检查语法和错误日志。
  • 服务器日志:查看详细日志以诊断问题。

使用教程

使用依赖

  • Python 3.10+
  • Unreal Engine 5.x 并启用 Remote Control API 插件
  • Claude Desktop (Windows)

安装教程

  1. 克隆仓库并安装依赖:
git clone https://github.com/yourusername/ue5-mcp.git
cd ue5-mcp
pip install uv mcp requests
  1. 配置 Claude Desktop:
  2. 打开 Claude Desktop
  3. 编辑 claude_desktop_config.json,添加服务器配置。
  4. 准备 Unreal Engine:
  5. 启用 Remote Control API 插件。

调试方式

  1. 启动 Unreal Engine 和 Claude Desktop。
  2. 使用示例命令测试功能:
  3. "Create a snowman at position 0, 100, 50"
  4. "Modify the center snowman's scale to make it bigger"

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。