Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lihop/godot-setup
GitHub action to setup the Godot game engine so it can run in graphical mode (i.e. non-headless) on Linux, Windows, and macOS.
https://github.com/lihop/godot-setup
continuous-integration game-ci godot
Last synced: 15 days ago
JSON representation
GitHub action to setup the Godot game engine so it can run in graphical mode (i.e. non-headless) on Linux, Windows, and macOS.
- Host: GitHub
- URL: https://github.com/lihop/godot-setup
- Owner: lihop
- License: mit
- Created: 2021-07-19T11:41:10.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T01:48:41.000Z (3 months ago)
- Last Synced: 2024-11-10T06:36:26.176Z (about 2 months ago)
- Topics: continuous-integration, game-ci, godot
- Language: JavaScript
- Homepage:
- Size: 27.7 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Godot Setup
[](https://github.com/lihop/setup-godot/actions/workflows/demo.yml)
GitHub action to setup the Godot game engine so it can run in graphical mode (i.e. non-headless) on Linux, Windows, and macOS.
This can be useful if you want to test something graphical or platform-specific.
The downloaded Godot executable will is cached for subsequent runs if the `cache` input is set to `true` (default).
## Usage
```yaml
- name: Setup Godot
uses: lihop/setup-godot@v2
# You can now run the downloaded version of godot using the `godot` command in your other steps.
# For example, run Gut tests:
- name: Run tests
shell: bash
run: godot --no-window -s addons/gut/gut_cmdln.gd -gexit
# You can use the `alias` input if you want to use a different name for the Godot executable
# or use different names for different versions. For example:
- name: Install Godot Mono v3.4-beta5
uses: lihop/setup-godot@v2
with:
mono: true
version: 3.4-beta5
alias: my-custom-name
# Now you can execute the Godot version above using `my-custom-name`.
- name: Print version
run: my-custom-name --version
# Will print: `3.4.beta5.mono.official.dd0ee4872`.
# You can also download export templates if you plan to export projects.
# The downloaded export templates will be cached along with the Godot executable if the `cache` input is set to `true` (default).
- name: Install Godot 3.4.4-stable
uses: lihop/setup-godot@v2
with:
version: 3.4.4-stable
export-templates: true
# Now you can export a run a godot project (this example uses named exports specified in the projects export_presets.cfg file).
- name: Export project
run: godot --no-window --export "Linux/X11"
# For Linux runners the setup-godot action will start an Xserver and export the DISPLAY environment variable as appropriate.
# This means you can run the exported project without having to set up an Xserver or use `xvfb-run`.
# For Windows runners the action will setup OpenGL using [mesa-dist-win](https://github.com/pal1000/mesa-dist-win).
# macOS runners support OpenGL applications out of the box.
- name: Run exported project
run: ./exports/linux.64/MyCoolGame.x86_64
```
## Options
| Name | Default | Description |
| ---------------- | ------------ | -------------------------------------------------------------------------------- |
| version | "3.5-stable" | Godot version to use |
| bits | 64 | 64 or 32 bit build |
| mono | false | Use the Mono build |
| alias | "godot" | Name of the Godot executable that will be added to PATH |
| cache | true | Whether to save/restore Godot (and export templates if downloaded) to/from cache |
| export-templates | false | Download export templates |