damien/godot_template
1
1
Fork 0
mirror of https://github.com/D4M13N-D3V/godot_template.git synced 2025-03-14 10:04:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: damien:0.1.12
Branches Tags
damien:main
damien:gh-pages
damien:3-implement-global-event-system
damien:0.1.14
damien:0.1.13
damien:0.1.12
damien:0.1.11
damien:0.1.10
damien:0.1.9
damien:0.1.8
damien:0.1.7
damien:0.1.6
damien:0.1.5
damien:0.1.4
damien:0.1.3
damien:0.1.2
damien:0.1.1
damien:0.1.0
...
compare: damien:main
Branches Tags
damien:gh-pages
damien:main
damien:3-implement-global-event-system
damien:0.1.14
damien:0.1.13
damien:0.1.12
damien:0.1.11
damien:0.1.10
damien:0.1.9
damien:0.1.8
damien:0.1.7
damien:0.1.6
damien:0.1.5
damien:0.1.4
damien:0.1.3
damien:0.1.2
damien:0.1.1
damien:0.1.0

3 Commits
0.1.12 ... main

Author SHA1 Message Date
Damien Ostler
023a4d03c3
Update README.md 2024-01-14 14:54:20 -05:00
Damien Ostler
5305ec8241 Merge branch 'main' of https://github.com/DamienTehDemon/godot_template 2024-01-14 00:31:01 -05:00
Damien Ostler
84955b8d1b fix readme 2024-01-14 00:30:55 -05:00
1 changed files with 7 additions and 2 deletions
Show Stats Expand all files Collapse all files

9
README.md
View File

@ -1,12 +1,17 @@
# Overview
This is a repository that provides a template for you to start your Godot repositories on GitHub. This repository contains a basic project setup along with CI/CD. By default it will build for windows, linux and the web and upload their artifacts, along with deploying a build to GitHub Pages.
This is a repository that provides a template for you to start your Godot repositories on GitHub. This repository contains a basic project setup along with CI/CD. By default it will build for windows, linux and the web and upload their artifacts, along with deploying a build to GitHubDock Pages.
# Docker Image
This uses a open source docker image made for exporting from godot, it can be found here.
https://github.com/abarichello/godot-ci
# How to deploy to GitHub Pages
Go to the settings of your repository, and then on the left hand side click pages. You should then be able to click a drop down near the top of the page to deploy from a branch, deploy from the gh-pages branch once the workflow has executed.
Example Deployment https://D4M13N-D3V.github.io/godot_template/
![image](https://github.com/DamienTehDemon/godot_template/assets/13697702/80a76d39-65be-4de4-ab47-91fbeb3eabd2)
# Changing the Godot version
You can do this by making a small change to the workflow file in `/.github/workflows/game_ci.yaml`. At the top of the file you will see a environment variable for the godot version, just change this to whatever version you want to use to build your game.
You can do this by making a small change to the workflow file in `/.github/workflows/game_ci.yaml`. At the top of the file you will see a environment variable for the godot version, just change this to whatever version you want to use to build your game. By default this is 4.2 right now.
# Recommended Flow
To use this properly we recommend creating pull requests into the main branch, and merging your changes in that way. This is to prevent using all of your action runner quota. We recommend making a small change to the workflow file in `/.github/workflows/game_ci.yaml` and changing line `169` from `prerelease: false` to `prerelease: true`. Whenever you want to do a proper release, you can go to the list of releases on your repository and change it to be a full release instead of pre-release. This will allow you to have builds for every version of the game, while also maintaining a selection of stable builds.
# Requirments