使用说明

项目简介

Unity MCP Server 是一个开源项目,旨在通过 Model Context Protocol (MCP) 协议,在 Unity 编辑器和大型语言模型 (LLM) 之间建立桥梁。它允许 LLM 自动化 Unity 中的任务,例如资源管理、场景编辑和脚本操作,从而提升游戏开发和内容创作的效率。

主要功能点

  • 双向通信: 实现 Unity 编辑器与 LLM 之间的无缝数据交换。
  • 资源管理: 通过程序化方式导入资源、实例化预制体、创建新的预制体。
  • 场景控制: 控制场景的打开、保存和修改,以及场景中物体的创建和编辑。
  • 材质编辑: 轻松应用和修改材质。
  • 脚本集成: 在 Unity 中创建、查看和更新 C# 脚本。
  • 编辑器自动化: 自动化执行 Unity 编辑器任务,如构建项目、进入运行模式、执行菜单命令等。

安装步骤

  1. Unity Package: 通过 Unity Package Manager 添加 Git URL 'https://github.com/justinpbarnett/unity-mcp.git'。
  2. Python 环境:
    • 确保已安装 Python 3.7 或更高版本,并安装包管理器 'uv' ('pip install uv')。
    • 在 Unity 项目中,导航到 'Assets/MCPServer/Python' 目录。
    • 运行 'uv venv' 创建虚拟环境。
    • 运行 'uv pip install -e .' 安装 Python 依赖。

服务器配置

要连接 MCP 客户端(如 Claude Desktop 或 Cursor),需要配置客户端以启动 Unity MCP Server。以下是配置示例 (JSON 格式):

{
  "mcpServers": {
    "unityMCP": {  // 服务器名称,可以自定义
      "command": "uv", // 启动服务器的命令,假设 uv 已添加到系统 PATH 环境变量
      "args": [
        "--directory",
        "path/to/your/unity-project/Assets/MCPServer/Python", // 替换为你的 Unity 项目中 Python 目录的**绝对路径**
        "run",
        "server.py"
      ]
    }
  }
}

注意: 请将 '"path/to/your/unity-project/Assets/MCPServer/Python"' 替换为实际的 Python 目录在你的 Unity 项目中的绝对路径。获取绝对路径的方法:在Unity编辑器中选中 'Assets/MCPServer/Python' 文件夹,然后在 Inspector 窗口中可以看到文件夹路径,复制该路径并替换上述配置中的占位符。

基本使用方法

完成安装和配置后,首先启动 Python 服务器。在 Unity 编辑器中,打开 "Unity MCP" 窗口 ('Window > Unity MCP') 并检查连接状态。连接成功后,LLM 客户端即可向服务器发送 MCP 请求,通过注册的工具和 Prompt 控制 Unity 编辑器。常用的操作包括创建物体、修改场景、导入资源等。详细的工具列表和使用示例请参考仓库中的 'README.md' 和 'HOW_TO_ADD_A_TOOL.md' 文件。

信息

分类

开发者工具