MCP Unity

🚀 MCP Unity 項目文檔

MCP Unity 項目提供了一個強大的插件，用於在 Unity 環境中實現模型上下文支持和 WebSocket 通信等功能，幫助開發者優化編輯器性能，實現模型間的數據交互。

🚀 快速開始

安裝與配置

下載與安裝

1. 下載 MCP Unity 插件。
2. 解壓 文件並將其放置在合適的位置。

配置步驟

1. 打開 Unity 編輯器，進入Edit > Project Settings。
2. 選擇MCP Settings標籤。
3. 在Server Location中指定你的 MCP 服務器路徑。
4. 點擊Apply保存設置。

服務器配置

Node.js 安裝

1. 訪問Node.js 官網下載並安裝最新版本的 LTS 版本。
2. 確保npm命令在終端中可用。

服務端代碼編譯

# 切換到 Server 目錄
cd 絕對路徑/To/mcp-unity/Server

# 安裝依賴項
npm install

# 編譯項目
npm run build

✨ 主要特性

核心功能

• 模型上下文支持：實現模型間的數據交互。
• WebSocket 通信：通過即時通信優化編輯器性能。

使用指南

1. 在 Unity 中創建新場景或打開現有場景。
2. 添加 MCP 組件到目標物體上。
3. 配置組件參數以滿足項目需求。

📦 安裝指南

插件安裝

1. 下載 MCP Unity 插件。
2. 解壓文件並將其放置在合適的位置。

服務器安裝

1. 安裝 Node.js 的 LTS 版本。
2. 編譯服務端代碼：

# 切換到 Server 目錄
cd 絕對路徑/To/mcp-unity/Server

# 安裝依賴項
npm install

# 編譯項目
npm run build

💻 使用示例

基礎用法

在 Unity 中使用 MCP 插件的基本步驟：

1. 在 Unity 中創建新場景或打開現有場景。
2. 添加 MCP 組件到目標物體上。
3. 配置組件參數以滿足項目需求。

📚 詳細文檔

插件調試

調試配置

1. 在 Unity 編輯器中啟用調試模式。
2. 使用瀏覽器訪問localhost:8080查看調試信息。

日誌記錄

• 控制檯日誌：默認啟用，輸出到終端或指定文件。
• 詳細日誌：通過設置環境變量DEBUG=*啟用詳細日誌。

常見問題

連接問題

1. 確保服務器正在運行（檢查 Unity 控制檯）。
2. 檢查防火牆設置，確保端口未被阻止。
3. 驗證端口號是否正確（默認為 8080）。

服務啟動失敗

• 檢查 Unity 控制檯中的錯誤信息。
• 確保 Node.js 已正確安裝並添加到路徑中。
• 核對服務器目錄下所有依賴項是否齊全。

支持與反饋

如需幫助或有任何建議，請在GitHub 倉庫中提交問題。

聯繫方式：

• LinkedIn：Miguel Tomás
• Discord：gamester7178
• 郵箱：game.gamester@gmail.com

貢獻指南

歡迎貢獻！請遵循Conventional Commits格式提交 Pull Request 或 Issues。

📄 許可證

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

致謝

感謝以下項目的貢獻：

• Model Context Protocol
• Unity Technologies
• Node.js
• WebSocket-Sharp