用途
cli-anything-godot 是 Godot 引擎的 Agent 原生命令行工具(CLI),让智能体或开发者通过命令行完成 Godot 项目管理、场景操作、导出和 GDScript 执行等任务。
主要能力
项目管理
- 创建新的 Godot 项目:
cli-anything-godot project create <path> [--name "My Game"] - 获取项目信息(名称、特性、主场景):
cli-anything-godot --json -p <project> project info - 列出所有场景:
cli-anything-godot --json -p <project> project scenes - 列出所有脚本:
cli-anything-godot --json -p <project> project scripts - 列出所有资源:
cli-anything-godot --json -p <project> project resources - 重新导入项目资源:
cli-anything-godot -p <project> project reimport
场景操作
- 创建带根节点类型的新场景:
cli-anything-godot -p <project> scene create scenes/Level1.tscn --root-type Node3D - 读取场景结构(节点、资源、连接):
cli-anything-godot --json -p <project> scene read scenes/Level1.tscn - 向场景添加子节点:
cli-anything-godot -p <project> scene add-node scenes/Level1.tscn --name Player --type CharacterBody3D --parent .
GDScript 执行
- 运行 GDScript 文件(必须继承 SceneTree):
cli-anything-godot -p <project> script run tools/build_navmesh.gd - 运行内联 GDScript 代码:
cli-anything-godot -p <project> script inline 'print(ProjectSettings.get_setting("application/config/name"))' - 校验 GDScript 语法:
cli-anything-godot -p <project> script validate scripts/player.gd
导出
- 列出已配置的导出预设:
cli-anything-godot --json -p <project> export presets - 导出所有预设:
cli-anything-godot -p <project> export build - 导出指定预设:
cli-anything-godot -p <project> export build --preset "Windows Desktop" --output build/game.exe
引擎
- 检查 Godot 可用性与二进制路径:
cli-anything-godot --json engine status - 获取引擎版本:
cli-anything-godot engine version
使用方式
安装
pip install git+https://github.com/HKUDS/CLI-Anything.git#subdirectory=godot/agent-harness
要求
Godot 4.x 位于 PATH(或设置 GODOT_BIN 环境变量)。
JSON 模式
在任意命令中添加 --json 标志可获得结构化 JSON 输出,适合智能体消费:
cli-anything-godot --json -p ./my-game project info
交互式 REPL
cli-anything-godot -p ./my-game session
适用场景
- 智能体自动化管理 Godot 项目与场景
- 在 CI 或脚本中批量执行 GDScript、校验语法
- 通过命令行完成项目导出
- 需要结构化 JSON 输出的自动化流程
限制
- 需要 Godot 4.x 环境,且必须位于 PATH 或通过 GODOT_BIN 指定
- 运行 GDScript 文件时必须继承 SceneTree
- 其他限制暂未提供。