Git Product home page Git Product logo

brew-for-life's Introduction

Github To Itch (Godot 4.0)

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.

Setup ⚙️

  1. When enabling the addon a window will popup with instructions on how to setup your BUTLER_API_KEY so you can actually push to itch.
  2. 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.
  3. Create an export preset in Project > Export if you don't have one and the addon will add it to your workflow.
  4. 🎉 You're ready to go, whenever you push to your main branch this workflow will publish to itch.io To edit the username, or project name go to Project > Tools > Github to Itch Config or in your project settings under github_to_itch/config

How it works

  • When an export preset has runnable=true this 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.

Customization

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)

Suggestions 👍

If you have any ideas or suggestions for the addon please create an issue or fork the project and make a PR!

brew-for-life's People

Contributors

acropolis914 avatar zatzustudent avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.