使用说明

项目简介

UnityMCP 是一个 Unity 编辑器插件和 MCP 服务器的组合，旨在通过 Model Context Protocol (MCP) 将 Unity 编辑器与 AI 助手无缝集成。它允许 AI 助手获取 Unity 编辑器的实时状态、执行编辑器命令和访问编辑器日志，从而实现更智能的 Unity 开发工作流程。

主要功能点

实时编辑器状态监控: 提供当前 Unity 编辑器的详细状态，包括活动的游戏对象、选择状态、播放模式、场景层级结构和项目结构。
远程命令执行: 允许 AI 助手在 Unity 编辑器中执行 C# 代码，实现对编辑器的远程控制和自动化操作。
全面的日志管理: 提供 Unity 编辑器日志的检索和过滤功能，支持多种过滤条件，方便 AI 助手进行错误诊断和调试。

安装步骤

安装前提: 确保已安装 Unity 2022.3 或更高版本，Node.js 18 或更高版本，npm 9 或更高版本。
Unity 插件安装: 将 'UnityMCPPlugin' 文件夹复制到 Unity 项目的 'Assets' 目录下。在 Unity 编辑器中，通过菜单栏 'UnityMCP > Debug Window' 打开插件窗口。

MCP 服务器安装:

cd unity-mcp-server
npm install
npm run build

服务器配置

MCP 客户端需要配置以下信息以连接到 UnityMCP 服务器：

{
  "serverName": "UnityMCP Server",
  "command": "node",
  "args": [ "build/index.js" ],
  "cwd": "unity-mcp-server"
}

'serverName': 服务器的名称，可以自定义。
'command': 启动服务器的命令，这里使用 'node' 运行 JavaScript 代码。
'args': 传递给 'node' 命令的参数，'build/index.js' 是编译后的服务器入口文件。
'cwd': 工作目录，设置为 'unity-mcp-server'，确保命令在正确的目录下执行。

基本使用方法

启动服务器: 在 'unity-mcp-server' 目录下运行命令 'node build/index.js' 启动 MCP 服务器。
连接 Unity 编辑器: 打开 Unity 项目，并打开 'UnityMCP Debug Window' 窗口。插件会自动尝试连接到 MCP 服务器。
使用 MCP 客户端: 配置 MCP 客户端连接到 UnityMCP 服务器。客户端可以通过调用 'get_editor_state' 获取编辑器状态，使用 'execute_editor_command' 执行 C# 代码，或使用 'get_logs' 获取编辑器日志。

关键词