defold-mcp

defold-mcp

注意： 这是我第一次尝试创建 MCP（Model Context Protocol）服务。它并不完美，实际上还缺少很多功能，但我希望比我更聪明的人能接过我的工作，并将其发扬光大！

---

🚀 什么是 defold-mcp？

defold-mcp 是一个开源的 Model Context Protocol（MCP）服务，旨在将 Defold 游戏引擎与现代开发工具及 AI 驱动的工作流连接起来。它提供了一系列强大的工具，可通过编程方式自动化、检查和管理 Defold 项目，让开发者能够更轻松地：

• 启动和调试 Defold 项目
• 生成和编辑 Lua 脚本及模块
• 创建集合、精灵、图块地图等
• 管理项目设置和依赖项
• 启用热重载和实时分析
• 集成 Cursor 等工具，辅助 AI 游戏开发

✨ 功能

• 全面的工具集： 将各种 Defold 项目操作作为 MCP 工具提供（完整列表见下文）。
• 支持 Apple Silicon 和 Dotenv： 可在 Apple Silicon Mac 上开箱即用，并支持通过 .env 文件配置环境。
• 自动化项目管理： 通过命令行或兼容的客户端轻松创建、列出和配置 Defold 项目。
• 脚本和资源自动化： 通过编程方式生成脚本、集合、精灵等。
• 调试和分析： 在调试模式下运行项目、捕获控制台输出，并获取项目修改分析数据。
• 可扩展： 为他人改进、扩展并适配新的工作流而构建。

🛠️ 提供的工具

defold-mcp 提供以下 MCP 工具：

• launch_defold：为项目启动 Defold 编辑器
• run_project：在调试模式下运行 Defold 项目并捕获输出
• create_project：创建具有基本结构的新 Defold 项目
• list_projects：列出目录中的所有 Defold 项目
• get_project_settings：读取 game.project 中的设置
• update_project_settings：更新 game.project 中的设置
• create_script：创建新的 Lua 脚本
• edit_script：编辑现有 Lua 脚本
• create_lua_module：创建可复用的 Lua 模块
• create_collection：创建新的集合
• add_game_object：向集合添加游戏对象
• add_component：向游戏对象添加组件（精灵、脚本等）
• create_sprite：创建并添加精灵资源
• create_tilemap：创建并添加图块地图资源
• create_particlefx：创建并添加粒子效果
• create_camera：创建并添加摄像机组件
• create_factory：创建用于生成游戏对象的工厂组件
• create_gui：创建 GUI 场景和脚本
• setup_physics：为碰撞对象配置物理属性
• build_project：为目标平台构建项目
• enable_hot_reload：通过监视项目文件启用热重载
• add_native_extension：添加原生扩展
• get_project_analytics：获取项目修改分析数据

……以及更多！完整列表和详细信息请参阅 index.js。

⚡️ 快速开始

1. 克隆仓库：

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

2. 安装依赖项：

   npm install
   

3. 配置环境（可选）： 创建 .env 文件以覆盖默认值（变量包括 DEFOLD_PATH、MCP_PORT 等，详见 index.js）。
4. 运行服务：

   node index.js
   

5. 连接到你喜爱的 MCP 兼容客户端（例如 Cursor）。

---

🛠️ 与 Cursor 或 Windsurf 搭配使用

如果你使用 Cursor 或 Windsurf，无需手动运行服务。只需在项目中添加配置文件 .cursor/mcp.json，客户端就会自动启动并管理服务。

配置示例如下：

{
  "mcpServers": {
    "defold-mcp": {
      "command": "/path/to/your/node/binary", // e.g., ~/.nvm/versions/node/v22.14.0/bin/node
      "args": ["/path/to/where/you/cloned/defold-mcp/index.js"], // e.g., ~/git/defold-mcp/index.js
      "env": {
        "MCP_TRANSPORT": "stdio",
        "DEFOLD_PATH": "/Applications/Defold.app/Contents/MacOS/Defold",
        "MCP_PORT": "3000",
        "MCP_HOST": "localhost",
        "BOB_PATH": "/desired/path/for/bob.jar" // e.g., ~/defold/bob-1.9.6.jar
      }
    }
  }
}

• command：Node.js 二进制文件的路径。你可以在终端中运行 which node 来查找。
• args：此项目中 index.js 文件的路径，即你克隆项目的位置。
• BOB_PATH：你希望安装或查找 Defold bob.jar 文件的路径。

这样，每次打开项目时，Cursor 或 Windsurf 都会自动启动、停止并连接到 defold-mcp 服务。请根据你的设置调整路径和环境变量。

💡 为什么创建这个项目？

我创建 defold-mcp，是为了首次尝试构建 MCP 服务并将其与 Defold 游戏引擎集成。我的目标是让 Defold 更容易用于自动化和 AI 驱动的工作流。我知道项目还有一些不足之处，也有不少可以改进的地方，但我希望这个项目能激励其他人参与贡献、持续改进，并将它发展得更好！

如果你发现可以改进的地方，欢迎 Fork、贡献代码或联系我。让我们携手为 Defold 社区打造出色的成果。

🤝 参与贡献

欢迎贡献代码、报告 Bug 和提出功能请求！请创建 issue 或提交 pull request。

📄 许可证

本项目采用 MIT 许可证。

---

怀着好奇心与对游戏开发的热爱创建。