Unity

🚀 UnityMCP

UnityMCP 是一款強大的 Unity 編輯器插件，它實現了 Model Context Protocol (MCP)，能讓 Unity 與 AI 助手實現無縫集成。該插件具備即時編輯器狀態監控、遠程命令執行和全面日誌記錄等功能，極大提升了開發效率。

🚀 快速開始

UnityMCP 使 Unity 與 AI 助手的集成變得輕鬆，它通過 WebSocket 實現雙向即時通信，支持 JSON 格式的消息傳輸，適用於遊戲開發、即時協作工具等需要即時交互的場景。

✨ 主要特性

• 核心功能：通過 WebSocket 實現雙向即時通信，支持 JSON 格式的消息傳輸。
• 應用場景：適用於需要即時交互的場景，如遊戲開發、即時協作工具或其他需要動態數據交換的應用。
• 目標用戶：開發者、設計師和研究人員。

📦 安裝指南

使用 Smithery 安裝

# 示例代碼：通過 Smithery 進行安裝

手動安裝

• 插件安裝：

  • 將 UnityMCP 文件夾放入你的 Unity 項目中。
  • 在 Unity 中導入該文件夾以完成插件安裝。

• 服務器配置：

  • 確保 Node.js 和 npm 已安裝。
  • 在項目目錄下運行：

    npm install
    

💻 使用示例

啟動服務器

node server.js

連接插件

1. 打開 Unity 編輯器。
2. 在 Assets/Editor 文件夾中添加 MCPManager.cs 腳本。
3. 將腳本附加到任意空物體上。
4. 配置 WebSocket 服務器地址（默認為 ws://localhost:8080）。

📚 詳細文檔

編譯與構建

npm run build

監控代碼變更

npm run watch

調試通信

npm run inspector

🔧 技術細節

通信協議

• 傳輸方式：基於 WebSocket 的即時雙向通信。
• 端口號：默認使用 8080 端口。
• 消息格式：所有通信均採用 JSON 格式。

安全機制

• 命令超時保護：防止長時間未響應的命令執行。
• 錯誤處理：包括連接異常、命令失敗、編譯錯誤和運行時異常的全面處理。
• 日誌管理：提供可靠的日誌記錄和緩衝功能。
• 狀態監控：即時跟蹤連接狀態，確保系統穩定性。

錯誤處理

系統針對以下情況提供了完善的處理機制：

• 連接中斷
• 命令執行失敗
• 編譯錯誤
• 運行時異常
• 超時問題

📄 許可證

本項目採用 Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) 協議進行許可。