Godot_to_itch_GitHub_Action

KO | EN

gitlite — search

#react #typescript #llm #machine-learning #docker #nodejs #java #windows #awesome #cli #kubernetes #awesome-list #vue #ios

Godot_to_itch_GitHub_Action

(★ 9)

Example Godot 4.7.1 project that uses GitHub Actions and butler to automatically build then deploy your web project to itch.io on any commit to the master branch.

Godot_to_itch_GitHub_Action Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Auto Build + Publish your Godot HTML game to Itch.io with GitHub Actions

*Updated July 2026, using Godot 4.7.1*

![GHActions](https://github.com/user-attachments/assets/46f22a85-47c8-4a4e-b2e6-b320a19ea934)

Watch the offical video tutorial on YouTube: https://youtu.be/ROIMh3aHjMk

## Prerequisites
- Your game code is in a GitHub repo
- You already created your project page on itch.io
- ⚠️⚠️⚠️Follow **ALL** the steps below ⚠️⚠️⚠️

## Step 1: itch.io Token
First we need an API Token for itch.io. Head to the `Account Settings > Developer > API Keys` section. This [link](https://itch.io/user/settings/api-keys) should also take you there. Generate a new API key specifically for Github Actions.

## Step 2: Repository Action Secrets
Go to your game project’s GitHub repo. In the **repository settings** add the following tokens secrets to be accessible in Actions.  Make sure you name them exactly as below:

`ITCHIO_TOKEN`

## Step 3: Create and configure export settings in Godot
If you export your project at least once, Godot will create a `export_presets.cfg` file in the root of the project. You can find the export settings in `Project > Export`.

> [!IMPORTANT]
> Important step.

Give a name to the export template. End the name with `-web`, because it’s a HTML export. 
Alternatively you could do `-windows`, `-macos`, `-linux`, etc. 
This is because the GitHub action we will be using uses this suffix to determine to which [channel](https://itch.io/docs/butler/pushing.html#channel-names) on itch should the build be pushed.

Make sure you setup the export path `exports/web/index.html` as seen on the screen below:

## Step 4: GitHub Action setup

Add this action to the `.github/workflows` directory in your game's GitHub repository. Create the directory on the repository website or create it locally and then push.

```bash
mkdir -p .github/workflows
touch .github/workflows/itchio-publish.yml
```

Add the following code to the `itchio-publish.yml` file:

```yml
name: Publish to Itch.io

on:
  push:
    branches: ["master"]
    paths-ignore:
      - 'README.md'          # Ignore changes to README.md
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source code
        uses: actions/checkout@v5

- name: Godot Export
        id: export
        uses: firebelley/godot-export@v8.0.0
        with:
          godot_executable_download_url: https://github.com/godotengine/godot/releases/download/4.7.1-stable/Godot_v4.7.1-stable_linux.x86_64.zip
          godot_export_templates_download_url: https://github.com/godotengine/godot/releases/download/4.7.1-stable/Godot_v4.7.1-stable_export_templates.tpz
          relative_project_path: ./
          archive_output: true
        #env:
          #GITHUB_TOKEN: ${{secrets.GH_TOKEN}}
      - name: Publish to Itch
        uses: Ayowel/butler-to-itch@v1.3.1
        with:
          butler_key: ${{secrets.ITCHIO_TOKEN}}
          itch_user: antzgames
          itch_game: test-project
          version: ${{ github.ref_name }}
          files: "${{ steps.export.outputs.archive_directory }}/test-web.zip"
```

## Step 5: GitHub Action CONFIG changes

Make the appropiate changes to  `itch_user` and `itch_game` in the `itchio-publish.yml` file:

```yml
          itch_user: replace_with_your_itch_user
          itch_game: replace_with_your_itch_game_name
```

## This repo is a test project

This repository deploys a web test project using the limboAI C++ GDExtension to itch.io at:

https://antzgames.itch.io/test-project?secret=YtwaXmKha1xKVDZSxJCw0HMKOU

Godot_to_itch_GitHub_Action

Godot_to_itch_GitHub_Action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Godot_to_itch_GitHub_Action

Godot_to_itch_GitHub_Action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README