This addon automatically generates a github workflow to publish your game to your itch.io project. Great for use in jams so you can have your playable code live within a couple minutes of pushing to github.
- When enabling the addon a window will popup with instructions on how to setup your
BUTLER_API_KEYso you can actually push to itch. - You'll also need to configure your Itch Username and Project Name in the popup window so butler will push to the correct account and project.
- Create an export preset in
Project > Exportif you don't have one and the addon will add it to your workflow. - 🎉 You're ready to go, whenever you push to your
mainbranch this workflow will publish to itch.io To edit the username, or project name go toProject > Tools > Github to Itch Configor in your project settings undergithub_to_itch/config
- When an export preset has
runnable=truethis will automatically adjust your github workflow to export and upload that to itch.io with the proper channel. - The workflow uses Semantic Versioning and Conventional Commits based on your commit messages to automatically handle version number updates.
- The workflow also creates a release on your github repo, useful for keeping working copies of your exports.
The workflow template file is found in addons/github_to_itch/templates You can modify that file to change the workflow if needed (maybe you want to change the branch to a release branch or something)
If you have any ideas or suggestions for the addon please create an issue or fork the project and make a PR!