README
🚀 Godot 机器人流程自动化 (RPA) 服务器
Godot RPA 服务器借助命令行接口(CLI)与 Godot 引擎进行交互,能够实现一系列功能,如检测和启动 Godot 实例、获取项目信息、操作文件和数据库、修改配置文件等,极大提升了与 Godot 引擎交互的效率。
🚀 快速开始
Godot RPA 服务器可帮助你自动化处理与 Godot 引擎交互的各类任务。以下是使用前的安装与配置步骤:
1. 安装 Node.js 和 npm
确保已安装 LTS 版本的 Node.js 和 npm:
curl -o- https://raw.githubusercontent.com/nvm-sh/install/v0.39.5/install.sh | bash
nvm install --lts
npm install -g npm
2. 克隆仓库并构建
git clone https://github.com/yourusername/godot-rpa.git
cd godot-rpa
npm install
3. 设置环境变量
- GODOT_PATH:设置为你的 Godot 可执行文件路径(可选)
- DEBUG:设为 "true" 启用详细日志记录(可选)
使用示例
# 最简单的使用方式
npm start
# 以调试模式运行
DEBUG=true npm start
# 指定 Godot 路径
GODOT_PATH=/path/to/godot npm start
✨ 主要特性
- 零临时文件:所有操作通过内存完成,无需写入磁盘
- 内置错误处理:自动捕获并报告 Godot CLI 错误
- 可扩展架构:支持添加新的命令处理器
- 异步执行:多个操作可以并发运行
- 详细日志记录:提供调试信息以解决问题
📦 安装指南
1. 安装 Node.js 和 npm
确保已安装 LTS 版本的 Node.js 和 npm:
curl -o- https://raw.githubusercontent.com/nvm-sh/install/v0.39.5/install.sh | bash
nvm install --lts
npm install -g npm
2. 克隆仓库并构建
git clone https://github.com/yourusername/godot-rpa.git
cd godot-rpa
npm install
3. 设置环境变量
- GODOT_PATH:设置为你的 Godot 可执行文件路径(可选)
- DEBUG:设为 "true" 启用详细日志记录(可选)
💻 使用示例
基本用法
# 最简单的使用方式
npm start
# 以调试模式运行
DEBUG=true npm start
# 指定 Godot 路径
GODOT_PATH=/path/to/godot npm start
高级用法
# 以下是一些高级使用场景示例
# 例如,结合不同的环境变量和参数进行操作
GODOT_PATH=/path/to/godot DEBUG=true npm start
📚 详细文档
命令参考
基本命令
-
launch
godot-rpa launch [--project-path PATH] [--]启动 Godot 编辑器。可指定项目路径,
--表示传递额外 CLI 参数。 -
run
godot-rpa run [-p|--project-path] PATH [-m|--monitor]运行 Godot 项目。支持监控模式(自动重新加载)。
文件操作
-
create-folder
godot-rpa create-folder [-p|--parent] PATH NAME创建新文件夹。
-
delete-folder
godot-rpa delete-folder PATH删除文件夹。
🔧 技术细节
架构概述
服务器使用命令处理器模式,每个操作由专门的处理器处理。复杂任务通过链式调用多个处理器完成。
命令处理器
- FileOperationsProcessor:处理与文件系统相关的所有操作。
- ProjectInfoProcessor:提取和修改项目信息。
- DatabaseProcessor:执行数据库相关操作。
- ConfigurationProcessor:管理配置文件。
📚 故障排除
1. Godot 未检测到
- 确保 Godot 可执行文件存在并可执行
- 设置 GODOT_PATH 环境变量指向正确路径
2. 权限问题
- 检查文件和目录的权限设置
- 使用
chmod命令调整权限
3. 日志不足
- 启用调试模式 (
DEBUG=true) - 查看
debug.log文件获取更多信息
4. 性能问题
- 优化操作顺序
- 考虑增加资源限制
📄 许可证
本项目遵循 MIT 许可证。查看 LICENSE 文件获取详细信息。
通过 Godot RPA 服务器,你可以自动化处理与 Godot 引擎交互的各种任务,提升开发效率并简化工作流程。
Scan to contact