使用说明

项目简介

UnrealMCP插件是一个非官方的Unreal Engine插件,旨在通过AI工具控制Unreal Engine。它在Unreal Engine内部实现了模型上下文协议 (MCP),允许外部AI系统以程序化的方式与Unreal环境进行交互和操作。该插件充当MCP服务器,允许AI客户端(如Claude for Desktop)通过标准化的JSON-RPC协议发送命令,从而实现对Unreal Engine编辑器的控制。

主要功能点

  • 场景操作: 支持获取场景信息、创建、修改和删除场景中的对象(如静态网格体、光源等)。
  • 材质编辑: 允许创建和修改Unreal Engine项目中的材质资源,包括调整材质属性、颜色、金属度、粗糙度等。
  • 蓝图控制: 初步支持蓝图的创建和修改,包括创建自定义事件,为AI驱动的自动化工作流打下基础。(蓝图功能尚在开发中)
  • Python脚本执行: 支持在Unreal Engine的Python环境中执行任意Python代码或脚本文件,实现更高级和定制化的功能扩展。
  • TCP服务器: 插件内置TCP服务器,用于接收来自MCP客户端的指令。
  • JSON命令协议: 使用基于JSON的命令协议进行AI工具集成,易于理解和扩展。
  • 编辑器UI集成: 在Unreal Engine编辑器工具栏中提供便捷的MCP服务器控制按钮,方便用户启动和停止服务器。

安装步骤

  1. 克隆仓库到插件目录: 将仓库 'UnrealMCP' 克隆到您的Unreal Engine项目 'Plugins' 目录下。
    git clone https://github.com/kvick-games/UnrealMCP.git Plugins/UnrealMCP
    确保项目路径结构如下: '...\UNREAL_PROJECT\Plugins\UnrealMCP'
  2. 生成项目文件: 右键单击您的 '.uproject' 文件,选择 "Generate Visual Studio project files" (或 "Generate Rider project files" 等,根据您的IDE)。
  3. 编译项目: 在您的IDE中(如Visual Studio, Rider)编译Unreal Engine项目。
  4. 启用插件: 打开您的Unreal Engine项目,在 "Edit > Plugins > UnrealMCP" 中启用插件。
  5. 启用Python插件: 确保Unreal Engine的Python插件已启用(通常默认启用,若未启用请在插件列表中搜索 "Python Editor Script Plugin" 并启用)。
  6. 运行安装脚本: 运行 'setup_unreal_mcp.bat' 脚本(位于插件根目录),该脚本可能需要根据实际使用情况进行调整。
  7. 集成Claude for Desktop (或其他MCP客户端): 按照MCP客户端的配置要求,配置连接到UnrealMCP服务器。

服务器配置

以下是配置 Claude for Desktop 连接到 UnrealMCP 服务器的示例 JSON 配置。您需要将此配置添加到 Claude for Desktop 的配置文件 'claude_desktop_config.json' 中。

{
    "mcpServers": {
        "unreal": {
            "command": "C:\\UnrealMCP_Project\\Plugins\\UnrealMCP\\MCP\\run_unreal_mcp.bat",
            //  请将 "C:\\UnrealMCP_Project\\Plugins\\UnrealMCP" 替换为您实际的 UnrealMCP 插件在项目中的路径
            //  确保路径指向 MCP 目录下 的 run_unreal_mcp.bat 脚本
            "args": []
            //  可以添加启动参数,当前示例为空
        }
    }
}

配置说明:

  • 'mcpServers': 定义 MCP 服务器配置的顶级 JSON 对象。
  • 'unreal': 为您的 UnrealMCP 服务器自定义的名称,在Claude for Desktop中用于识别和调用。
  • 'command': 重要: 指向 'run_unreal_mcp.bat' 脚本的完整路径。您必须根据 UnrealMCP 插件在您项目中的实际位置修改此路径。此脚本负责启动 UnrealMCP 的 Python 桥接服务器。
  • 'args': 启动 'run_unreal_mcp.bat' 脚本时传递的命令行参数,当前示例中为空,如有需要可以根据 'run_unreal_mcp.bat' 脚本的定义添加参数。

查找 'claude_desktop_config.json' 路径:

在 Claude for Desktop 设置中点击 "Edit Config" 按钮可以打开配置文件目录,通常 'claude_desktop_config.json' 文件位于该目录下。

基本使用方法

  1. 启动UnrealMCP服务器: 在Unreal Engine编辑器中,点击工具栏上的 "MCP Server Control Panel" 按钮(插件图标),打开控制面板。在控制面板中点击 "Start Server" 按钮启动MCP服务器。
  2. 连接MCP客户端: 配置并启动您的MCP客户端(例如 Claude for Desktop),确保客户端配置中指向了正确的 UnrealMCP 服务器启动命令。
  3. AI指令控制Unreal Engine: 使用MCP客户端,通过自然语言指令或程序化方式,指示AI与Unreal Engine进行交互。例如,您可以指示 Claude for Desktop 在场景中创建物体、修改材质或执行Python脚本。
  4. 查看日志: UnrealMCP插件和Python桥接服务器的日志信息可以在Unreal Engine的 "Output Log" 面板中查看,日志过滤器设置为 "LogMCP"。Claude for Desktop 的日志也可能包含有用的调试信息。

注意安全风险: UnrealMCP 插件允许AI直接修改您的Unreal Engine项目,请务必仔细阅读 README.md 中的 "⚠️ DISCLAIMER" 和 "IMPORTANT SAFETY MEASURES" 部分,并采取必要的安全措施,如使用版本控制和定期备份项目。

信息

分类

开发者工具