godot-mcp

🚀 Godot MCP服务器配置指南

Godot MCP（Magic Command Processor）服务器是一款用于自动化和增强Godot游戏引擎开发流程的工具。借助MCP，你能够让AI助手直接执行与Godot项目相关的复杂操作，例如创建场景、添加节点、导出资源等。本指南将为你详细介绍如何配置和使用Godot MCP服务器，并提供具体的实现细节和技术支持信息。

🚀 快速开始

下载与构建

1. 克隆代码仓库：

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

2. 安装依赖项：

npm install

3. 构建项目：

npm run build

构建完成后，你会在build/目录下找到可执行文件。

配置环境变量

• GODOT_PATH：指定Godot executable的路径（可选）
• DEBUG：设置为"true"以启用详细日志记录

✨ 主要特性

• 可让AI助手直接执行与Godot项目相关的复杂操作，如创建场景、添加节点、导出资源等。
• 采用特定架构，具有无临时文件、简化代码维护、统一错误处理、减少I/O开销等优势。

📦 安装指南

下载与构建

1. 克隆代码仓库：

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

2. 安装依赖项：

npm install

3. 构建项目：

npm run build

构建完成后，可在build/目录下找到可执行文件。

配置环境变量

• GODOT_PATH：指定Godot executable的路径（可选）
• DEBUG：设置为"true"以启用详细日志记录

💻 使用示例

基础用法

以下是一些使用场景的例子：

"启动我在/path/to/project位置的游戏项目"

"运行我的Godot项目并显示任何错误信息"

"获取我的Godot项目的结构信息"

"分析我的Godot项目结构并提供建议"

"帮我调试这个错误：[粘贴错误信息]"

"为我编写一个带有双跳和滑墙功能的字符控制器脚本"

🔧 技术细节

架构设计

1. 直接命令：如启动编辑器或获取项目信息等简单操作使用Godot的内置CLI命令。
2. GDScript脚本：复杂操作（如创建场景、添加节点）通过单个godot_operations.gd脚本实现。

这种架构的优势：

• 无临时文件
• 简化代码维护
• 统一错误处理
• 减少I/O开销

📚 详细文档

故障排除

常见问题及解决方案： | 问题 | 解决方法 | |------|----------| | Godot未找到 | 设置GODOT_PATH环境变量 | | 连接问题 | 确保服务器正在运行并重新启动AI助手 | | 无效路径 | 确保路径指向包含project.godot文件的目录 |

📄 许可证

此项目使用MIT许可证，详细信息请参阅LICENSE文件。