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 文件夹中的文档：

• 开始使用
• 安装指南
• 命令参考
• 架构