Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
bend-n committed Nov 2, 2022
0 parents commit 1b75fd7
Show file tree
Hide file tree
Showing 10 changed files with 841 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ko_fi: bendn
30 changes: 30 additions & 0 deletions .github/workflows/export.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: "export" # name of the workflow
on: # when it is triggered
workflow_dispatch: # manually or
push: # on a push
branches:
- main # to this branch
paths: # with modifications to these files
- "**.gd" # all gdscript files
- "**.tscn" # scene files
- "**.import" # this means a png changed
- "**.tres" # godot resources
- "**.ttf" # fonts in godot3 dont have their own .import
- ".github/workflows/export.yml" # this workflow
- "export_presets.cfg" # the export template

jobs: # the things to do
export: # a thing to do
uses: bend-n/godot-actions/.github/workflows/callable-export.yml@main
with: # variables
godot-version: 3.5 # the godot version
image: ghcr.io/bend-n/godot-2d:3.5 # the container to use
export-name: ${{ github.event.repository.name }} # the name of the exec. ($export-name.exe)
platforms: "windows linux web android mac" # space seperated list of platforms to build
project-root-path: "." # the directory that project.godot is in
github-pages: "true" # to deploy to github pages or not (anything besides 'true' == false)
itch-path: "${{ github.repository_owner }}/${{ github.event.repository.name }}" # required for itch.io deployment.
secrets: # secrets
butler-api-key: ${{ secrets.BUTLER_CREDENTIALS }} # required for itch.io deployment
android-keystore-base64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }} # for signing the apk, not required
android-keystore-password: ${{ secrets.ANDROID_KEYSTORE_PASSWORD }} # ditto
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.import/
logs/
*.sh
*.py
*.pgn
.vscode/
exports/
*.x86_64
addons/
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 bendn

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
3 changes: 3 additions & 0 deletions Main.tscn
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[gd_scene format=2]

[node name="Main" type="Node2D"]
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# godot-template

[![version](https://img.shields.io/badge/3.x-blue?logo=godot-engine&logoColor=white&label=godot&style=for-the-badge)](https://godotengine.org "Made with godot")
<a href='https://ko-fi.com/bendn' title='Buy me a coffee' target='_blank'><img height='28' src='https://storage.ko-fi.com/cdn/brandasset/kofi_button_red.png' alt='Buy me a coffee'> </a>

Godot template repository for my programs

---

## How to use

> **Note**
> This template uses the [gpm](https://github.com/you-win/godot-package-manager).
- Click use this template button
- Clone your new repository
- Run install_addons.sh
- Add your files & change `FUNDING.yml`
- Commit & push

<details>
<summary>For itch.io depoloyment</summary>
<br>

Add a secret called `BUTLER_CREDENTIALS` with your [butler api key](https://itch.io/user/settings/api-keys).

</details>

<details>
<summary>For android builds</summary>
<br>

> **Note**
> The keystore user/alias is found automatically.
> If the `ANDROID_KEYSTORE_BASE64` field is not filled, the action will use the android debug keystore.
Add two secrets:

- `ANDROID_KEYSTORE_BASE64`
- `ANDROID_KEYSTORE_PASSWORD`

</details>

---

### CI Availability

| windows | ios | linux | android | mac | html | |
| :----------------: | :-: | :----------------: | :----------------: | :----------------: | :----------------: | :-----------: |
| :x: | :x: | :x: | :x: | :x: | :heavy_check_mark: | github pages |
| :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | itch.io |
| :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | godot exports |
Loading

0 comments on commit 1b75fd7

Please sign in to comment.