关键词

Unity编辑器自动化LLM游戏开发

使用说明

项目简介

Unity MCP Server (Unity Model Context Protocol Server) 是一个 Unity 编辑器扩展包，它充当一个桥梁，允许大型语言模型 (LLM) 客户端（如 Claude Desktop 或 Cursor）与 Unity 编辑器进行双向通信。通过 MCP 协议，LLM 客户端可以请求 Unity 编辑器的上下文信息，并调用预定义的功能来操作 Unity 项目，例如资源管理、场景控制、材质编辑、脚本集成和编辑器自动化等。

主要功能点

  • 资源管理：创建、导入和操作 Unity 资源，例如模型、材质、预制体等。
  • 场景控制：管理 Unity 场景，包括场景的打开、保存、创建、切换，以及场景中游戏对象的创建、修改、删除和层级结构管理。
  • 增强材质编辑：提供材质的创建、设置和修改功能，包括材质属性、纹理、渲染模式等高级设置。
  • 脚本集成：支持 C# 脚本的创建、查看、更新和附加到游戏对象，实现 LLM 驱动的代码生成和编辑。
  • 编辑器自动化：自动化 Unity 编辑器任务，例如撤销/重做、播放/暂停/停止游戏、构建项目、读取控制台日志等。
  • 双向通信：通过 TCP 协议与 MCP 客户端进行无缝的双向数据传输。

安装步骤

  1. 安装 Python: 确保已安装 Python 3.12 或更高版本，并将其添加到系统 PATH 环境变量中。
  2. 安装 uv: uv 是一个 Python 包管理器，用于简化依赖管理。根据您的操作系统，使用以下命令安装 uv：
    • Mac: 'brew install uv'
    • Windows: 'powershell -c "irm https://astral.sh/uv/install.ps1 | iex"' 然后将 'uv' 添加到 PATH 环境变量。
    • Linux: 'curl -LsSf https://astral.sh/uv/install.sh | sh' 请务必安装 uv，否则无法正常使用。
  3. 安装 Unity Package:
    • 打开 Unity 编辑器，导航到 'Window > Package Manager'。
    • 点击 '+' 按钮，选择 'Add package from git URL...'。
    • 输入 'https://github.com/HuangChILun/reavorse-mcp.git' 并添加。

安装完成后，Unity MCP Package 将在您的 Unity 项目中可用。当与 MCP 客户端（如 Claude Desktop 或 Cursor）一起使用时，服务器将自动启动。

服务器配置

Unity MCP Server 作为 Unity 编辑器的一个 Package 运行，无需手动配置服务器启动命令。MCP 客户端需要配置连接 Unity MCP Server 的相关信息，配置示例如下 (以 JSON 格式配置在 MCP 客户端中)：

{
  "serverName": "UnityMCP",
  "command": "uv",
  "args": [
    "--directory",
    "**[请替换为 server.py 所在的 Python 目录的绝对路径]**",
    "run",
    "server.py"
  ]
}

参数说明:

  • serverName: 服务器名称，可以自定义，用于在 MCP 客户端中标识服务器。例如 "UnityMCP"。
  • command: 启动服务器的命令，这里使用 'uv' (Python 的包管理器)。
  • args: 启动命令的参数列表。
    • '--directory': 指定 Python 脚本 'server.py' 所在的目录。[请替换为 server.py 所在的 Python 目录的绝对路径] 需要用户手动查找并替换为实际的目录路径。
    • 'run server.py': 使用 'uv run' 命令执行 'server.py' 脚本来启动 MCP 服务器。

重要说明:

  • 'server.py 所在的 Python 目录的绝对路径': 此路径需要指向 'server.py' 文件所在的 Python 目录的绝对路径。该目录通常位于 Unity 项目的 'Packages/com.justinpbarnett.unity-mcp/Python' 目录下，或者如果您手动安装了 'unity-mcp' 包，则位于您安装的路径下。用户需要根据实际情况替换此路径。
  • 自动配置: 为了简化配置，Unity MCP Package 提供了一个 MCP Editor 窗口 ('Window > Unity MCP')，可以尝试自动配置 MCP 客户端。如果自动配置失败，您可以使用上述手动配置信息。

基本使用方法

  1. 确保 Unity 编辑器已打开，并且您的 Unity 项目中已安装 Unity MCP Package。
  2. 启动您的 MCP 客户端 (如 Claude Desktop 或 Cursor)，并按照其 MCP 服务器配置说明，添加上述服务器配置信息。
  3. 在 MCP 客户端中连接到名为 "UnityMCP" (或您在配置中设置的 'serverName') 的服务器。
  4. 连接成功后，您就可以在 MCP 客户端中使用预定义的工具来控制 Unity 编辑器，例如创建对象、修改场景、编辑材质等。
  5. 您可以参考 'README.md' 文件和代码中的工具定义，了解可用的工具和参数。

注意: Unity MCP Server 通过 TCP 协议与客户端通信，默认端口为 6400 (Unity 侧) 和 6500 (MCP 侧)。请确保您的防火墙或网络设置允许这些端口的通信。

信息

分类

开发者工具

访问项目