Godot

🚀 Godot Robotic Process Automation (RPA) Server

The Godot RPA Server interacts with the Godot engine through a Command Line Interface (CLI), offering functionalities to streamline Godot - related tasks and enhance development efficiency.

🚀 Quick Start

The Godot RPA Server enables seamless interaction with the Godot engine via the CLI. It comes equipped with a variety of features to handle different Godot - related operations.

✨ Features

• Zero Temporary Files: All operations are performed in memory, eliminating the need to write to disk.
• Built - in Error Handling: Automatically captures and reports Godot CLI errors.
• Scalable Architecture: Supports the addition of new command processors.
• Asynchronous Execution: Multiple operations can run concurrently.
• Detailed Logging: Provides debugging information for issue resolution.

📦 Installation

1. Install Node.js and npm

Ensure you have the LTS version of Node.js and npm installed:

curl -o- https://raw.githubusercontent.com/nvm-sh/install/v0.39.5/install.sh | bash
nvm install --lts
npm install -g npm

2. Clone the repository and build

git clone https://github.com/yourusername/godot-rpa.git
cd godot-rpa
npm install

3. Set environment variables

• GODOT_PATH: Set it to the path of your Godot executable file (optional).
• DEBUG: Set it to "true" to enable detailed logging (optional).

💻 Usage Examples

Basic Usage

# The simplest way to use
npm start

Advanced Usage

# Run in debug mode
DEBUG=true npm start

# Specify the Godot path
GODOT_PATH=/path/to/godot npm start

📚 Documentation

Command Reference

Basic Commands

• launch

godot-rpa launch [--project-path PATH] [--]

Launch the Godot editor. You can specify the project path, and -- is used to pass additional CLI parameters.

• run

godot-rpa run [-p|--project-path] PATH [-m|--monitor] 

Run a Godot project. Supports the monitoring mode (auto - reload).

File Operations

• create - folder

godot-rpa create-folder [-p|--parent] PATH NAME

Create a new folder.

• delete - folder

godot-rpa delete-folder PATH

Delete a folder.

🔧 Technical Details

Architecture Overview

The server uses a command processor pattern, where each operation is handled by a dedicated processor. Complex tasks are accomplished through chained calls to multiple processors.

Command Processors

• FileOperationsProcessor: Handles all operations related to the file system.
• ProjectInfoProcessor: Extracts and modifies project information.
• DatabaseProcessor: Performs database - related operations.
• ConfigurationProcessor: Manages configuration files.

🚧 Troubleshooting

Godot not detected

• Ensure the Godot executable file exists and is executable.
• Set the GODOT_PATH environment variable to the correct path.

Permission issues

• Check the permission settings of files and directories.
• Use the chmod command to adjust permissions.

Insufficient logs

• Enable debug mode (DEBUG=true).
• Check the debug.log file for more information.

Performance issues

• Optimize the operation sequence.
• Consider increasing resource limits.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

With the Godot RPA Server, you can automate various tasks interacting with the Godot engine, improving development efficiency and simplifying the workflow.