GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → abarichello → godot-ci

abarichello / godot-ci

Licence: MIT license
Docker image to export Godot Engine games. Templates for Gitlab CI and GitHub Actions to deploy to GitLab Pages/GitHub Pages/Itch.io.

Programming Languages

Dockerfile
14818 projects
shell
77523 projects

Labels

dockergithub-pagesdockerfilegithub-pagegitlabgitlab-cici-cdgodotgodot-enginehacktoberfestgitlab-pagesgithub-actions

Projects that are alternatives of or similar to godot-ci

Godot Ci
Docker image to export Godot Engine games. Templates for Gitlab CI and GitHub Actions to deploy to GitLab Pages/GitHub Pages/Itch.io.
Stars: ✭ 168 (-46.84%)
Mutual labels:  github-pages, github-page, gitlab, gitlab-ci, ci-cd, godot, godot-engine
godot-cpp-ci
Docker image and Github Actions to automatically compile Godot C++ GDNative libraries.
Stars: ✭ 21 (-93.35%)
Mutual labels:  gitlab, gitlab-ci, godot, godot-engine
Cml
♾️ CML - Continuous Machine Learning | CI/CD for ML
Stars: ✭ 2,843 (+799.68%)
Mutual labels:  gitlab-ci, ci-cd, github-actions
chicio.github.io
👻 Fabrizio Duroni (me 😄) personal website. Created using GatsbyJS, Styled Components, Storybook, Typescript, tsParticles, GitHub pages, Github Actions, Upptime.
Stars: ✭ 20 (-93.67%)
Mutual labels:  github-pages, github-page, github-actions
chart-testing-action
A GitHub Action to lint and test Helm charts
Stars: ✭ 139 (-56.01%)
Mutual labels:  ci-cd, github-actions
wordpress-skeleton
A base repository structure for rtCamp's WordPress sites, pre-configured to use Github Actions
Stars: ✭ 32 (-89.87%)
Mutual labels:  ci-cd, github-actions
Persistence
Plugin para almacenar datos de forma persistente en Godot Engine 3
Stars: ✭ 20 (-93.67%)
Mutual labels:  godot, godot-engine
release-downloader
Github action to download release assets from private or public repositories
Stars: ✭ 33 (-89.56%)
Mutual labels:  ci-cd, github-actions
GodotTerrainEditorPainter
Heightmap based terrain editor plugin for GODOT with vertex color based terrain shader painting
Stars: ✭ 23 (-92.72%)
Mutual labels:  godot, godot-engine
NextCommunity.github.io
Join FREE: Community of open-source programmers and software engineers.
Stars: ✭ 29 (-90.82%)
Mutual labels:  github-pages, github-actions
godot-shotgun-party
An evolving multiplayer project for Godot Engine 3.
Stars: ✭ 171 (-45.89%)
Mutual labels:  godot, godot-engine
godot-sponza
Sponza demo for Godot 3.x (`master` branch) and 4 (`4.0-dev` branch)
Stars: ✭ 133 (-57.91%)
Mutual labels:  godot, godot-engine
gdosc
OSC module for Godot game engine - it is now discontinued in favor of https://gitlab.com/frankiezafe/gdosc
Stars: ✭ 14 (-95.57%)
Mutual labels:  godot, godot-engine
prettier
🔨 Native, blazingly-fast Prettier CLI on Github Actions
Stars: ✭ 19 (-93.99%)
Mutual labels:  ci-cd, github-actions
lottie
No description or website provided.
Stars: ✭ 18 (-94.3%)
Mutual labels:  godot, godot-engine
godot-kotlin
Kotlin Native bindings for Godot Engine
Stars: ✭ 11 (-96.52%)
Mutual labels:  godot, godot-engine
Godot-3.0-Noise-Shaders
Godot 3.0 Noise Shaders
Stars: ✭ 38 (-87.97%)
Mutual labels:  godot, godot-engine
godopy
[WIP] Python scripting for the Godot game engine
Stars: ✭ 27 (-91.46%)
Mutual labels:  godot, godot-engine
godot-nightly
A program to download the latest version of Godot Nightly Builds
Stars: ✭ 23 (-92.72%)
Mutual labels:  godot, godot-engine
netascode
This repo contains an example of the virtual network of a fictitious company which you can use to play and to learn network automation. Public repository for Network as Code. NaC model.
Stars: ✭ 36 (-88.61%)
Mutual labels:  gitlab-ci, ci-cd
View All Similar Projects ➔

godot-ci

Docker image to export Godot Engine games and deploy to GitLab/GitHub Pages and Itch.io using GitLab CI and GitHub Actions.

Docker Hub

https://hub.docker.com/r/barichello/godot-ci/

How To Use

.gitlab-ci.yml and .github/workflows/godot-ci.yml are included in this project as reference.
For live projects, examples and tutorials using this template check the list below:

Mono/C#

To build a godot project with Mono enabled, change the image tag from barichello/godot-ci:VERSION to barichello/godot-ci:mono-VERSION in .gitlab-ci.yml (Gitlab) or godot-ci.yml (Github). e.g. barichello/godot-ci:mono-3.2.1.

Android

To build a debug release (debug.keystore), use the android_debug job example in the gitlab-ci.yml file.

If you want to export for Android with your own keystore, you can do this with the following steps:

  1. Take your generated keystore and convert it to Base64: Linux & macOS: base64 release.keystore -w 0 Windows: certutil -encodehex -f release.keystore encoded.txt 0x40000001
  2. Go to GitLab Project > Settings > CI/CD > Variables and copy the Base64-encoded keystore value in a new variable SECRET_RELEASE_KEYSTORE_BASE64 as type variable.
  3. Create a second variable SECRET_RELEASE_KEYSTORE_USER as type variable with the alias of your keystore as value.
  4. Create a third variable SECRET_RELEASE_KEYSTORE_PASSWORD as type variable with the password of your keystore as value.
  5. Use the android job example in the gitlab-ci.yml file.

GDNative/C++

See this repository for automating GDNative C++ compilation, which is based off this repository.

Modules

You have to compile Godot with the modules included first. See this excellent repository by Calinou for automating Godot builds.

After that, you would use the custom build to export your project as usual. See this guide by Greenfox on how to use a custom Godot build for automated exports.

iOS

Not available yet. Automating Xcode projects is doable but not trivial, and macOS runners only recently became available for GitHub actions, so it will happen eventually.

Platforms

Here's a mapping between each supported CI service, the template jobs and a live example.

CI Template Example
GitLab CI Godot Exports / GitHub Pages / GitLab Pages / Itch.io GitLab CI Pipelines
GitHub Actions Godot Exports GitHub Actions running

Environment configuration

First you need to remove unused jobs/stages from the .yml file you are using as a template(.gitlab-ci.yml or .github/workflows/godot-ci.yml).
Then you have to add these environments to a configuration panel depending on the chosen CI and jobs:

  • GitHub: https://github.com/<username>/<project-name>/settings/secrets
  • GitLab: https://gitlab.com/<username>/<repo-name>/settings/ci_cd

GitHub Pages

Secrets needed for a GitHub Pages deploy via GitLab CI:

Variable Description Example
REMOTE_URL The git remote where the web export will be hosted (in this case GitHub), it should contain your deploy/personal access token https://<github username>:<deploy token>@github.com/<username>/<repository>.git
GIT_EMAIL Git email of the account that will commit to the gh-pages branch. [email protected]
GIT_USERNAME Username of the account that will commit to the gh-pages branch. username

Others variables are set automatically by the gitlab-runner, see the documentation for predefined variables.

Itch.io

Deployment to Itch.io is done via Butler.
Secrets needed for a Itch.io deploy via GitLab CI:

Variable Description Example
ITCHIO_USERNAME Your username on Itch.io, as in your personal page will be at https://<username>.itch.io username
ITCHIO_GAME the name of your game on Itchio, as in your game will be available at https://<username>.itch.io/<game> game
BUTLER_API_KEY An Itch.io API key is necessary for Butler so that the CI can authenticate on Itch.io on your behalf. Make that API key Masked(GitLab CI) to keep it secret xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Troubleshoot

Problems while exporting

  • Check that the export names on export_presets.cfg match the ones used in your CI script.
  • Check the paths used in your CI script, some commands may be running in the wrong place if you are keeping the project in a folder (like the test-project template) or not.

Authentication errors with Butler

Additional Resources

Greenfox has an excellent repo that is also for automating Godot exports.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].