Godot Script Integration

🚀 Godot MCP（模型上下文協議）

Godot MCP 是一款強大的插件，它基於 Model Context Protocol (MCP)，實現了 Godot 引擎與 AI 助手的全面集成。藉助該插件，AI 助手能夠無縫與您的 Godot 項目交互，為您提供代碼輔助、場景操作和項目管理等一系列強大功能。

✨ 主要特性

• 完整 Godot 項目訪問：AI 助手可自由訪問並修改項目中的腳本、場景、節點以及各類資源。
• 雙向通信：既能將項目數據發送給 AI 助手，又能直接在編輯器中應用其給出的修改建議。
• 豐富的命令類別：
  • 節點命令：可輕鬆創建、修改和管理場景中的節點。
  • 腳本命令：支持編輯、分析和創建 GDScript 文件。
  • 場景命令：方便操作場景及其結構。
  • 項目命令：能訪問項目的設置和資源。
  • 編輯器命令：可控制各種編輯器功能。

🚀 快速開始

📦 安裝指南

1. 克隆倉庫

git clone https://github.com/ee0pdt/godot-mcp.git
cd godot-mcp

2. 設置 MCP 服務器

cd server
npm install
npm run build
# 返回項目根目錄
cd ..

3. 設置 Claude 桌面版

1. 編輯或創建 Claude 桌面版配置文件：

   # 對於 macOS
   nano ~/Library/Application\ Support/Claude/claude_desktop_config.json
   

2. 添加以下配置（或參考 included claude_desktop_config.json 作為示例）：

   {
     "mcpServers": {
       "godot-mcp": {
         "command": "node",
         "args": [
           "PATH_TO_YOUR_PROJECT/server/dist/index.js"
         ],
         "env": {
           "MCP_TRANSPORT": "stdio"
         }
       }
     }
   }
   

   ⚠️ 重要提示

   將 PATH_TO_YOUR_PROJECT 替換為您存儲此倉庫的實際路徑。

3. 重啟 Claude 桌面版。

4. 在 Godot 中打開示例項目

1. 打開 Godot 引擎。
2. 選擇 "導入" 並導航到克隆的倉庫。
3. 打開 project.godot 文件。
4. MCP 插件在此示例項目中已啟用。

💻 使用示例

使用 MCP 與 Claude 桌面版

• 啟動插件：在 Godot 中，進入 Project > Project Settings > Plugins 並啟用 "Godot MCP"。
• 連接 AI 助手：確保 Claude 桌面版正在運行，並且 MCP 服務器已正確配置。

創建新場景

1. 打開 Godot 並加載項目。
2. 在編輯器中，右鍵點擊場景樹，選擇 "Create New Scene"。
3. 配置場景設置並保存。

導出項目

# 在終端中運行以下命令以導出為 HTML5
export_project ../export/html5/

📚 詳細文檔

資源端點

• 腳本：*.gd
• 場景：*.tscn
• 圖片：*.png, *.jpg

命令參考

場景命令

• scene/create：創建新場景
• scene/open：打開現有場景
• scene/save：保存當前場景

節點命令

• node/add：添加節點到場景
• node/remove：刪除指定節點
• node/edit：修改節點屬性

🔧 技術細節

故障排除

• 插件未工作：
  • 在任何配置更改後重新加載 Godot 項目。
  • 檢查 Godot 控制檯中的錯誤信息。
  • 確保 Claude 桌面版配置中的路徑正確無誤。

自定義項目集成

1. 將 addons/godot_mcp 文件夾複製到您的 Godot 項目的 addons 目錄。
2. 啟動項目，進入 Project > Project Settings > Plugins 並啟用 "Godot MCP"。

📄 許可證

本項目採用 MIT License 許可證，具體內容請參閱 LICENSE 文件。

貢獻

歡迎貢獻！請隨意提交 Pull Request。

更多文檔

有關詳細信息，請查閱 docs 文件夾中的文檔：

• 開始使用
• 安裝指南
• 命令參考
• 架構