How to set up godot-ci for GitHub Pages deployment?

Copy the .github/workflows/godot-ci.yml file to your repo, then add secrets like REMOTE_URL and GIT_EMAIL in GitHub settings, following the environment configuration guide for web exports.

Does godot-ci support Godot 4.0 or only older versions?

It primarily uses version-tagged Docker images (e.g., 3.2.1), so you need to check Docker Hub for the latest supported Godot versions; updates may lag behind Godot releases.

What's better: godot-ci or manually exporting Godot games?

godot-ci is better for automated, frequent deployments to platforms like Itch.io, saving time, while manual exports offer more control for one-off builds or complex custom setups.

How to deploy a Godot game to Itch.io using CI/CD?

Configure the Itch.io job in your CI file, set ITCHIO_USERNAME, ITCHIO_GAME, and BUTLER_API_KEY as secrets, and ensure export preset names match, as per the Itch.io deployment instructions.

Can I use godot-ci with a custom Godot build that has extra modules?

Yes, but you must first compile Godot with modules using external tools like Calinou's repository, then integrate that build into the CI, as referenced in the Modules section.

What are common errors when using godot-ci and how to fix them?

Authentication failures with Butler often occur if secrets are misconfigured; also, ensure export_presets.cfg is committed and preset names match exactly, as highlighted in troubleshooting.

godot-ci

MITDockerfile4.6.2-stable

A Docker image and CI/CD templates for exporting Godot Engine games and deploying them to GitLab Pages, GitHub Pages, and Itch.io.

Visit Website

What is godot-ci?

godot-ci is a Docker image and CI/CD template collection that automates the export and deployment of Godot Engine games. It provides pre-configured workflows for GitLab CI and GitHub Actions to build games and deploy them to platforms like GitLab Pages, GitHub Pages, and Itch.io. The project solves the problem of manual, repetitive export tasks by integrating Godot into continuous integration pipelines.

Target Audience

Godot game developers and small teams who want to automate their build and deployment process using GitLab CI or GitHub Actions. It is particularly useful for developers releasing web-based games or distributing via Itch.io.

Value Proposition

Developers choose godot-ci because it offers a ready-to-use, well-documented solution that significantly reduces setup time for automated Godot exports. Its clear templates and support for multiple deployment targets provide a reliable and maintainable CI/CD pipeline out of the box.

Overview

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

Use Cases

Best For

Automating Godot game exports for web deployment to GitHub Pages

Related Projects

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

GitHub

1.1k stars162 forks0 contributors

Setting up continuous deployment to Itch.io from a Git repository

Integrating Godot projects into GitLab CI pipelines

Building Godot projects with Mono (C#) support in CI/CD

Exporting Android debug builds automatically

Streamlining deployment workflows for indie game developers

Not Ideal For

Projects targeting iOS exports for Apple devices
Teams needing integrated GDNative C++ compilation within the same CI pipeline
Environments restricted to CI platforms other than GitLab CI or GitHub Actions, such as Jenkins or CircleCI

Pros & Cons

Pros

Pre-configured CI Workflows

Includes ready-to-use .gitlab-ci.yml and GitHub Actions templates, allowing developers to set up automated exports quickly without writing custom scripts from scratch.

Multi-Target Deployment

Supports deploying web builds to GitLab Pages and GitHub Pages, and game builds to Itch.io, streamlining distribution for indie developers with clear configuration guides.

Mono and Android Support

Offers separate Docker tags for C# projects and detailed steps for Android debug and release builds, including keystore handling via environment variables.

Comprehensive Troubleshooting

Provides specific advice, such as ensuring export_presets.cfg is committed and matching preset names case-sensitively, reducing common CI/CD errors.

Cons

Limited Platform Coverage

iOS exports are not supported yet, and GDNative C++ compilation requires a separate repository, making it less seamless for projects with those requirements.

Complex Secret Management

Deploying to targets like Itch.io involves setting multiple secrets and variables (e.g., BUTLER_API_KEY), which can be error-prone and requires careful CI/CD configuration.

Dependency on External Tools

For custom Godot builds with modules, users must compile Godot separately using other projects, adding extra steps and potential maintenance overhead.

Frequently Asked Questions

Home

Godot

zfoo

💡Extremely fast enterprise server framework, can be used in RPC, game server, web server.

Stars1,995

Forks416

Last commit1 month ago

godot-gdscript-toolkit

Independent set of GDScript tools - parser, linter, formatter, and more

Stars1,524

Forks104

Last commit6 months ago

#gitlab-ci

#continuous-integration

#continuous-deployment