这个项目能做什么
Godot MCP 是一个模型上下文协议(MCP)服务器,将 AI 代理与 Godot 游戏引擎连接起来。它使 AI 助手能够通过启动编辑器、以调试模式运行项目、捕获控制台输出以及控制执行流程,直接与 Godot 项目交互。该服务器还提供场景管理功能,包括创建场景、添加具有自定义属性的节点、加载精灵、将 3D 场景导出为 MeshLibrary 资源,以及管理 Godot 4.4+ 的 UID 引用。
## 主要特性
- **编辑器与项目控制**:启动 Godot 编辑器,以调试模式运行项目,并以编程方式停止它们
- **调试输出捕获**:检索控制台输出和错误消息,以提供实时反馈
- **项目分析**:列出目录中的项目,获取详细的项目结构信息,并检索已安装的 Godot 版本
- **场景管理**:
- 使用指定的根节点类型创建新场景
- 向现有场景添加具有可自定义属性的节点
- 将精灵/纹理加载到 Sprite2D 节点中
- 将 3D 场景导出为用于 GridMap 的 MeshLibrary 资源
- 使用变体选项保存场景
- **UID 管理**(Godot 4.4+):获取文件的 UID,并通过重新保存资源来更新 UID 引用
## 架构
该服务器采用混合方法:
1. **直接命令**:简单操作(启动编辑器、获取版本)使用 Godot 的内置 CLI 命令
2. **捆绑操作脚本**:复杂操作(场景创建、节点操作)使用一个全面的 GDScript 文件(`godot_operations.gd`),该文件接受操作类型和参数作为 JSON,从而无需生成临时文件即可灵活执行
## 要求
- 已安装 Godot 引擎
- Node.js(>=18.0.0)和 npm
- 兼容 MCP 的 AI 代理(例如,Claude Code、Cursor)
## 快速开始
对于 Claude Code:
```bash
claude mcp add godot -- npx @coding-solo/godot-mcp
```
对于 Cursor,请在设置中添加 MCP 服务器,命令为 `npx @coding-solo/godot-mcp`。
## 配置
环境变量:
- `GODOT_PATH`:Godot 可执行文件的路径(覆盖自动检测)
- `DEBUG`:设置为 `"true"` 以获取详细的服务器端日志
## 故障排除
- **未找到 Godot**:设置 `GODOT_PATH` 环境变量
- **连接问题**:确保服务器正在运行,并重启您的 AI 助手
- **无效的项目路径**:确保路径包含 `project.godot` 文件
- **构建问题**:运行 `npm install` 以安装依赖项
## 许可证
MIT 许可证
评论
0 评分人数达到10人后显示
登录后参与讨论。