From 9d976e6ff03a953620680b17bc8970c979d38691 Mon Sep 17 00:00:00 2001 From: Minimata Date: Wed, 28 Jan 2026 16:11:13 +0100 Subject: [PATCH] README --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9096e94 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# Setup Godot Action + +This GitHub Action automates the setting up of Godot Mono. + +## Requirements + +### Godot Compatibility +- Godot 4.x (4.0.0 and above) +- .NET versions supported + +### System Requirements +- GitHub Actions runner (Ubuntu latest recommended) +- Git with LFS support for larger projects + +## Usage + +The action can be configured using various inputs to suit your testing needs. Here's a basic usage pattern: + +```yaml +- uses: https://git.game-dev.space/minimata/setup-godot.git@main + with: + godot-version: '4.6' # Required: Godot version to use + dotnet-version: 'net9.0' # Optional: Dotnet framework version +``` + +## Configuration + + +### Godot Configuration + +| Parameter | Required | Default | Description | +|-----------------|----------|---------|---------------------------------------------| +| godot-version | Yes | | Godot version (e.g., "4.2.1") | +| godot-status | No | stable | Godot status (stable/rc1/dev1) | +| project_dir | No | ./ | The project directory in which the action is to be executed. The specified directory must end with a path separator. e.g. ./MyProject/ | + +### .NET Configuration + +| Parameter | Required | Default | Description | +|-------------------|----------|---------|-------------| +| dotnet-version | No | net8.0 | .NET version (net7.0/net8.0) | + + +## Performance Optimization + +### Caching +The action automatically caches: +- Godot binaries +- .NET packages +- Project cache + +### Related Projects + +- [GdUnit4](https://github.com/godot-gdunit-labs/gdUnit4) +- [Godot Engine](https://godotengine.org)