Godot Template

A batteries-included template for quickly starting a game with the Godot Engine.

Batteries Included 🔋

• Export presets for HTML5, Linux, Windows, and macOS
• Includes GUT for testing
• Provides continuous integration by running tests against pull requests
• Release workflow publishes GitHub Releases and uploads builds to itch.io
• Configuration for Neovim provided in .lazy.lua

Getting Started 🎮

Setup

1. Create a new project on itch.io.
2. Create a new repository from this template.
3. In GitHub, add the following repository secret: Settings → Secrets and variables → Actions → Secrets

# Find this in itch.io: Account → Settings → API Keys
BUTLER_API_KEY=YourButlerAPIKey

4. Add the following repository variables: Settings → Secrets and variables → Actions → Variables

ITCH_NAME=YourItchUsername
ITCH_GAME=YourItchProject

Publishing

Now you can publish new releases of your game by pushing git tags.

Note

Only tags that start with v will trigger a release

git checkout <your-git-commit>
git tag v1.0.0
git push --tags

This creates a GitHub Release with build artifacts and uploads them to your itch.io project. After the first upload, you can configure the project to be web-playable.