Unity AI Bridge

🚀 Unity-MCP

Unity-MCP 是一個用於連接 Unity 引擎與 AI 助手的橋樑項目。它藉助 JSON-RPC 協議，實現了 AI 助手與 Unity 應用程序之間的通信和交互，為開發者提供了便捷的跨平臺協作方式。

🚀 快速開始

Unity-MCP 作為連接 Unity 引擎與 AI 助手的橋樑，允許通過 JSON-RPC 協議在兩者之間進行通信和交互，為開發者提供了便捷的跨平臺協作方式。

✨ 主要特性

• JSON-RPC 接口：項目基於 JSON-RPC 2.0 規範設計，提供了一系列 RPC 方法用於與 Unity 引擎交互。
• 工具集：提供多個功能模塊，包括在 Unity 運行時環境中執行任意 C# 代碼、使用點表示法查詢 unity 對象、屬性和方法，以及從 AILogger 中檢索特定日誌條目。
• 異步執行：所有操作均支持異步執行，確保高性能和響應式體驗。
• 支持代碼執行：支持直接在 Unity 運行時環境中執行代碼片段。
• 只讀訪問接口：提供對 unity 對象模型的只讀訪問接口。
• 可擴展架構：可擴展架構設計，便於添加更多功能模塊。
• 錯誤處理機制：強大的錯誤處理機制。
• 日誌記錄和跟蹤：統一的日誌記錄和跟蹤能力。

📦 安裝指南

文檔未提及安裝步驟，故跳過該章節。

💻 使用示例

基礎用法

執行代碼

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "execute_code", 
    "arguments": {
      "code": "Debug.Log(\"Hello from Unity!\"); return GameObject.FindObjectsOfType<GameObject>().Length;",
      "timeout": 5000
    }
  }
}

查詢對象

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call", 
  "params": {
    "name": "query",
    "arguments": {
      "query": "Camera.main.transform.position",
      "timeout": 5000
    }
  }
}

獲取日誌

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call", 
  "params": {
    "name": "get_log_by_name",
    "arguments": {
      "log_name": "unity-execute-1712534400000",
      "limit": 1
    }
  }
}

高級用法

一旦 AI 助手獲得對 Unity 工具的訪問權限，可以執行以下操作：

你能在這個 Unity 中執行下面的 C# 代碼嗎？

GameObject.Find("Player").transform.position = new Vector3(0, 1, 0);

📚 詳細文檔

文檔未提及詳細說明內容，故跳過該章節。

🔧 技術細節

文檔未提及技術實現細節，故跳過該章節。

📄 許可證

本項目採用 MIT 許可證。

👨‍💻 作者

T Savo (@TSavo)