Unity Editor

🚀 UnityMCP

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

🚀 快速開始

UnityMCP 能幫助你在 Unity 中輕鬆集成 MCP 功能，實現與 AI 助手的無縫交互。以下是快速開始的步驟：

1. 安裝：通過 npm 安裝 UnityMCP。

npm install unitymcp

2. 啟動服務器：安裝完成後，運行服務器。

npx unitymcp start

3. 導入插件到 Unity 編輯器：
   • 將插件文件夾添加到編輯器的 Assets/ 目錄。
   • 在 Unity 中啟用 MCP 插件。

✨ 主要特性

• 即時狀態更新：藉助 WebSocket 即時監控編輯器的狀態。
• 命令執行：接收並執行來自 MCP 服務器的指令。
• 日誌記錄：高效收集和管理編輯器的日誌信息。

📦 安裝指南

通過 npm 安裝

npm install unitymcp

啟動服務器

npx unitymcp start

在 Unity 編輯器中導入插件

• 將插件文件夾添加到編輯器的 Assets/ 目錄。
• 在 Unity 中啟用 MCP 插件。

💻 使用示例

基本用法

啟動 MCP 服務器

npx unitymcp start --port=8080

在 Unity 腳本中初始化插件

using UnityMCP;

public class MCPInitializer : MonoBehaviour {
    void Start() {
        MCPManager.Instance.Connect("ws://localhost:8080");
    }
}

高級用法

訂閱事件

MCPManager.Instance.OnCommand += HandleCommand;

自定義命令

註冊自定義命令處理程序：

[MCPCommand("customcommand")]
public class CustomCommandHandler {
    public static void Execute(string[] args) {
        // 處理自定義命令
    }
}

📚 詳細文檔

開發指南

創建新命令

1. 創建新的 C# 類：

[MCPCommand("newcommand")]
public class NewCommandHandler {
    public static void Execute(string[] args) {
        // 實現邏輯
    }
}

2. 註冊命令處理程序：

MCPManager.Register(typeof(NewCommandHandler));

擴展插件功能

1. 添加新的功能模塊：
   • 創建新文件夾 Assets/Plugins/Extensions。
   • 在其中添加自定義腳本或資產。
2. 編寫擴展程序：

public class ExtensionExample : MonoBehaviour {
    void Update() {
        if (MCPManager.IsConnected) {
            MCPManager.Instance.SendHeartbeat();
        }
    }
}

問題排查

連接問題

• 確保服務器正在運行且 WebSocket 端口開放。
• 檢查網絡配置，避免防火牆阻止端口。

命令未執行

• 確認命令已正確註冊並處理。
• 查看日誌以獲取更多調試信息。

貢獻指南

1. Fork 倉庫
2. 創建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m 'Add amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打開 Pull Request

🔧 技術細節

通信協議

• 使用 WebSocket 協議，端口為 8080。
• 支持雙向即時更新。
• 所有通信基於 JSON 格式。

安全特性

• 命令執行超時保護。
• 錯誤處理和驗證機制。
• 日誌緩衝管理。
• 連接狀態監控。

📄 許可證

本項目採用 MIT License 開源協議。