Unity MCP

🚀 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遊戲集成，並實現各種有趣的功能！