🚀 Unity-MCP项目指南

Unity-MCP（Unity-Multiplayer Collaboration Protocol）是一个开源工具包，用于将Unity游戏引擎与AI代理集成。借助它，AI代理能通过JSON - RPC协议与Unity游戏交互，执行复杂的游戏逻辑任务。

🚀 快速开始

本项目允许你将AI代理与Unity游戏集成，通过JSON - RPC协议实现交互。按照以下步骤操作，即可开启项目使用。

✨ 主要特性

• 支持AI代理通过JSON - RPC协议与Unity游戏进行交互。
• 能够执行复杂的游戏逻辑任务。
• 提供日志记录与查询功能，方便数据管理。

📦 安装指南

克隆仓库

git clone https://github.com/TSavo/unity-mcp.git
cd unity-mcp

.NET SDK安装

确保你已经安装了.NET SDK版本5.0或更高。若未安装，可从官方链接下载并安装。

项目构建

dotnet build src/UnityMCP.sln

配置API密钥

在appsettings.json中添加以下内容：

{
  "ApiKey": "your_project_key_here",
  "LogLevel": "Information"
}

📚 详细文档

日志记录与查询

数据结构

日志条目包含以下字段：

• id: 唯一标识符（GUID）
• name: 日志名称（由工具生成）
• data: 存储的结果数据或错误信息
• timestamp: 记录时间（ISO 8601格式）

查询语法

使用Unity查询语言（UQL）进行操作：

// 获取活动玩家列表
GET /api/players?active=true

// 创建新场景
POST /api/scenes
{
  "name": "New Scene",
  "settings": { ... }
}

💻 使用示例

基础用法

执行代码

请求示例：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "execute_code",
    "arguments": {
      "code": "Debug.Log(\"你好，Unity!\"); return GameObject.FindObjectsOfType<GameObject>().Length;",
      "超时时间": 5000
    }
  }
}

响应示例：

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "内容": [
      {
        "类型": "文本",
        "文本": "{\"状态\":\"成功\",\"日志名称\":\"unity-execute-1712534400000\",\"结果\":{\"成功\":true,\"结果\":42,\"日志\":[\"你好，Unity!\"]}"
      }
    ]
  }
}

查询对象

请求示例：

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "query",
    "arguments": {
      "查询": "Camera.main.transform.position",
      "超时时间": 5000
    }
  }
}

响应示例：

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "内容": [
      {
        "类型": "文本",
        "文本": "{\"x\":10.5,\"y\":-3.2,\"z\":5.8}"
      }
    ]
  }
}

检索结果

使用以下命令查看日志：

dotnet run -- --query "SELECT * FROM logs"

📄 许可证

该项目采用MIT许可证，详情请参考LICENSE文件。

👨‍💻 作者信息

• 作者: 张三
• 邮箱: contact@zhangsan.com
• GitHub链接: Unity-MCP

通过这个指南，你可以轻松地将AI代理与你的Unity游戏集成，并实现各种有趣的功能！