Unitymcpintegration

🚀 Unity MCP 集成

Unity MCP 集成可讓 AI 助手藉助 MCP 協議與 Unity 編輯器進行交互。它提供了一套完整的工具集，能讓 AI 助手執行代碼操作、管理文件系統以及監控 Unity 項目狀態，極大提升開發效率。

🚀 快速開始

通過 Unity MCP 集成，你可以將 AI 功能無縫融入遊戲開發工作流程，提高開發效率並拓展更多可能性。以下是快速上手的步驟：

初始化 MCP 服務

在項目根目錄下運行以下命令：

npx @quaza/unitymcpintegration init

此命令會創建必要的配置文件和目錄結構。

啟動 MCP 服務器

運行以下命令啟動 MCP 服務：

npm run start

✨ 主要特性

🛠️ Unity 編輯器工具

• get_editor_state：獲取關於 Unity 項目和編輯器狀態的詳細信息
• get_current_scene_info：獲取當前場景的詳細信息
• get_game_objects_info：獲取特定遊戲對象的信息
• execute_editor_command：在 Unity 編輯器中直接執行 C# 代碼
• get_logs：檢索並過濾 Unity 控制檯日誌
• verify_connection：檢查與 Unity 編輯器是否存在有效連接

📁 文件系統工具

• read_file：讀取項目中的文件內容
• read_multiple_files：一次性讀取多個文件
• write_file：創建或覆蓋指定文件
• edit_file：對現有文件進行針對性編輯，帶有預覽功能
• list_directory：獲取目錄中的文件和文件夾列表
• directory_tree：獲取目錄的層次結構視圖
• search_files：查找符合特定模式的文件
• get_file_info：獲取特定文件或目錄的元數據
• find_assets_by_type：根據類型查找所有資源（例如 Material、Prefab）
• list_scripts：獲取項目中所有 C# 腳本的列表

文件路徑可以是絕對路徑，也可以是相對於 Unity 項目 Assets 文件夾的相對路徑。例如，"Scenes/MyScene.unity" 實際指向 <project>/Assets/Scenes/MyScene.unity。

🏷️ 環境要求

📦 安裝指南

使用 npm 安裝

npm install @quaza/unitymcpintegration

🛠️ 開發環境安裝

Unity 插件

1. 在 Unity 中打開項目。
2. 修改 UnityMCPConnection/Editor 目錄下的 C# 腳本。

MCP 服務器端

1. 切換到 mcpServer 目錄。
2. 安裝依賴：npm install。
3. 編譯服務器：npm run build。
4. 運行服務器：node build/index.js。

💻 使用示例

基礎用法

在 Unity 中使用

using MCPIntegration;

public class MCPExample : MonoBehaviour {
    void Start() {
        // 初始化 MCP 客戶端
        MCPClient.Initialize("localhost", 3000);
        
        // 獲取編輯器狀態
        EditorState state = MCPClient.GetEditorState();
        Debug.Log($"Editor Version: {state.Version}");
    }
}

在 Node.js 中使用

const mcpServer = require('@quaza/unitymcpintegration');

// 初始化服務器
mcpServer.initialize('localhost', 3000);

// 監聽文件變化事件
mcpServer.on('fileChanged', (event) => {
    console.log(`File changed: ${event.path}`);
});

📚 詳細文檔

📈 調試與監控

在 Unity 中打開 MCP 調試窗口以監控連接狀態和測試功能：

1. 進入 Window > MCP Debug。
2. 在調試窗口中：
   • 檢查連接狀態。
   • 測試代碼執行。
   • 查看日誌。
   • 監控事件。

🎯 可用工具

Unity 編輯器工具

• get_editor_state：獲取關於 Unity 項目和編輯器狀態的詳細信息
• get_current_scene_info：獲取當前場景的詳細信息
• get_game_objects_info：獲取特定遊戲對象的信息
• execute_editor_command：在 Unity 編輯器中直接執行 C# 代碼
• get_logs：檢索並過濾 Unity 控制檯日誌
• verify_connection：檢查與 Unity 編輯器是否存在有效連接

文件系統工具

• read_file：讀取項目中的文件內容
• read_multiple_files：一次性讀取多個文件
• write_file：創建或覆蓋指定文件
• edit_file：對現有文件進行針對性編輯，帶有預覽功能
• list_directory：獲取目錄中的文件和文件夾列表
• directory_tree：獲取目錄的層次結構視圖
• search_files：查找符合特定模式的文件
• get_file_info：獲取特定文件或目錄的元數據
• find_assets_by_type：根據類型查找所有資源（例如 Material、Prefab）
• list_scripts：獲取項目中所有 C# 腳本的列表

📄 許可證

該庫採用 MIT 許可證，詳情請查閱 LICENSE 文件。

🔗 鏈接

• GitHub 倉庫：https://github.com/quaza/unitymcpintegration
• 文檔網站：https://docs.quaza.com/unity-mcp-integration