summaryrefslogtreecommitdiffhomepage
path: root/README.md
blob: 4dd6d29363a162f4949ff2cff8e12282c3f4586c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Github Actions Template For Raylib HTML5 Games

[![MIT License](https://img.shields.io/github/license/realtradam/raylib-template)](https://github.com/realtradam/raylib-template/blob/master/LICENSE)
[![Ko-Fi](https://img.shields.io/static/v1?message=Buy%20me%20a%20coffee&logo=kofi&labelColor=ff5e5b&color=434B57&logoColor=white&label=%20)](https://ko-fi.com/tradam)

This template allows you to automatically build your game and then upload it to itch.io when you push to master.

### How modify for your use
1. Create a copy of this template.
2. Edit `.github/workflows/raylib-to-itch.yml`
    - on line 57 you need to edit to use your username and game name 
3. Add your Itch API key to:
    - Settings > Secrets > Actions > New Repository Secret
    - Name it `BUTLER_API_KEY`
4. Make sure to set a viewport size for your game on Itch.io

And that should be it, your game should automatically compile and upload to itch when you push to master.

### Demo

Here is the raylib "game" automatically created and pushed from this repo: https://tradam.itch.io/raylib-template-test?secret=BzB8ElHics20nzvYSQgqfaha2Q0