Godot引擎AI插件

Godot MCP是一个将Godot引擎与AI助手集成的插件,提供代码辅助、场景操作和项目管理功能。

  • by fbdeme
  • GDScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 fbdeme/godot-mcp-rigging

使用说明

Godot MCP(模型上下文协议)

使用模型上下文协议(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
# Return to project root
cd ..

3.设置克劳德桌面

  1. 编辑或创建Claude Desktop配置文件:

    # For macOS
    nano ~/Library/Application\ Support/Claude/claude_desktop_config.json
    
  2. 添加以下配置(或使用附带的 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. 重新启动克劳德桌面

4.在Godot中打开示例项目

  1. 打开Godot引擎
  2. 选择“导入”并导航到克隆的存储库
  3. 打开 project.godot 文件
  4. 此示例项目中已启用MCP插件

与Claude一起使用MCP

设置后,您可以使用自然语言直接从Claude使用Godot项目。以下是一些示例:

示例提示

@mcp godot-mcp read godot://script/current

I need help optimizing my player movement code. Can you suggest improvements?
@mcp godot-mcp run get-scene-tree

Add a cube in the middle of the scene and then make a camera that is looking at the cube.
@mcp godot-mcp read godot://scene/current

Create an enemy AI that patrols between waypoints and attacks the player when in range.

克劳德可以执行的自然语言任务

  • 创建一个包含播放、选项和退出按钮的主菜单
  • “为玩家角色添加碰撞检测”
  • “实施昼夜循环系统”
  • “重构此代码以使用信号而不是直接引用”
  • “调试为什么我的玩家角色有时会掉到地板上”

可用资源和命令

资源端点:

  • godot://script/current -当前打开的脚本
  • godot://scene/current -当前打开的场景
  • godot://project/info -项目元数据和设置

命令类别:

节点命令

  • get-scene-tree -返回场景树结构
  • get-node-properties -获取特定节点的属性
  • create-node -创建新节点
  • delete-node -删除节点
  • modify-node -更新节点属性

脚本命令

  • list-project-scripts -列出项目中的所有脚本
  • read-script -读取特定脚本
  • modify-script -更新脚本内容
  • create-script -创建新脚本
  • analyze-script -提供脚本分析

场景命令

  • list-project-scenes -列出项目中的所有场景
  • read-scene -读取场景结构
  • create-scene -创建新场景
  • save-scene -保存当前场景

项目命令

  • get-project-settings -获取项目设置
  • list-project-resources -列出项目资源

编辑器命令

  • get-editor-state -获取当前编辑器状态
  • run-project -运行项目
  • stop-project -停止正在运行的项目

故障排除

连接问题

  • 确保在Godot的项目设置中启用该插件
  • 检查Godot控制台是否有任何错误消息
  • 验证服务器在Claude Desktop启动时是否正在运行

插件不工作

  • 在任何配置更改后重新加载Godot项目
  • 检查Godot控制台中的错误消息
  • 确保Claude Desktop配置中的所有路径都是绝对正确的

将插件添加到您自己的Godot项目中

如果你想在自己的Godot项目中使用MCP插件:

  1. 复制 addons/godot_mcp 将文件夹添加到Godot项目的 addons 目录
  2. 在Godot中打开您的项目
  3. 转到项目>项目设置>插件
  4. 启用“Godot MCP”插件

贡献

欢迎投稿!请随时提交拉取请求。

文档

有关更多详细信息,请查看 docs 文件夹:

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。