Basic game template addon

2026-01-30 19:45:56 +01:00
parent b923f6bec2
commit 44f251ed66
406 changed files with 12602 additions and 1 deletions
--- a/addons/maaacks_game_template/extras/scripts/build-and-publish.yml
+++ b/addons/maaacks_game_template/extras/scripts/build-and-publish.yml
@@ -0,0 +1,281 @@
+# MIT License
+
+# Copyright (c) 2018 BARICHELLO
+
+# 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.
+
+# Original file: https://github.com/abarichello/godot-ci/blob/master/.github/workflows/godot-ci.yml
+# This edited version is triggered using a Github Release and uploads artifacts to the release.
+# Furthermore, a new job (upload to itch.io using butler) has been added.
+# Modified by: Nicolas Oulianov (github @oulianov) & Marek Belski
+
+name: "Build and Deploy to Itch.io"
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  # Allow release asset uploads
+  contents: write
+
+env:
+  # Set this repository variable to the version to build with (>=4)
+  # This will be used for all container images: barichello/godot-ci:[#.#]
+  # Look at available versions here: https://hub.docker.com/r/barichello/godot-ci/tags
+  GODOT_VERSION: ${{ vars.GODOT_VERSION }}
+  # Set this repository variable to your game name (it will be the filename downloaded)
+  EXPORT_NAME: ${{ vars.EXPORT_NAME }}
+  # NOTE: If your `project.godot` is at the repository root, set `PROJECT_PATH` to "."
+  # If it's in a subdirectory, set it to the subdirectory name (e.g., "your-game")
+  PROJECT_PATH: .
+
+jobs:
+  export-web:
+    name: Web Export
+    runs-on: ubuntu-24.04
+    container:
+      image: barichello/godot-ci:${{ vars.GODOT_VERSION }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup
+        run: |
+          mkdir -v -p ~/.local/share/godot/export_templates/
+          mkdir -v -p ~/.config/
+          mv /root/.config/godot ~/.config/godot || true
+          mv /root/.local/share/godot/export_templates/${GODOT_VERSION}.stable ~/.local/share/godot/export_templates/${GODOT_VERSION}.stable || true
+
+      - name: Web Build
+        run: |
+          mkdir -v -p build/web
+          EXPORT_DIR="$(readlink -f build)"
+          cd $PROJECT_PATH
+          godot --headless --verbose --export-release "Web" "$EXPORT_DIR/web/index.html"
+
+      - name: Prepare web release asset (zip)
+        run: |
+          # ensure zip is available in the container
+          if ! command -v zip >/dev/null 2>&1; then
+            apt-get update && apt-get install -y zip
+          fi
+          # Change to the web directory and zip its contents directly
+          cd build/web
+          zip -r ../${EXPORT_NAME}-web.zip .
+          ls -lh ../${EXPORT_NAME}-web.zip
+        shell: bash
+
+      - name: Upload to GitHub Release (if this run is a release)
+        if: ${{ github.event_name == 'release' }}
+        uses: svenstaro/upload-release-action@v2
+        with:
+          file: build/${{ env.EXPORT_NAME }}-web.zip
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: web
+          path: build/web
+
+  export-windows:
+    name: Windows Export
+    runs-on: ubuntu-24.04
+    container:
+      image: barichello/godot-ci:${{ vars.GODOT_VERSION }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup
+        run: |
+          mkdir -v -p ~/.local/share/godot/export_templates/
+          mkdir -v -p ~/.config/
+          mv /root/.config/godot ~/.config/godot || true
+          mv /root/.local/share/godot/export_templates/${GODOT_VERSION}.stable ~/.local/share/godot/export_templates/${GODOT_VERSION}.stable || true
+
+      - name: Windows Build
+        run: |
+          mkdir -v -p build/windows
+          EXPORT_DIR="$(readlink -f build)"
+          cd $PROJECT_PATH
+          godot --headless --verbose --export-release "Windows Desktop" "$EXPORT_DIR/windows/${EXPORT_NAME}.exe"
+
+      - name: Archive Build
+        run: |
+          # ensure zip is available in the container
+          if ! command -v zip >/dev/null 2>&1; then
+            apt-get update && apt-get install -y zip
+          fi
+          # Change to the web directory and zip its contents directly
+          cd build/windows
+          zip -r ../${EXPORT_NAME}-windows.zip .
+          ls -lh ../${EXPORT_NAME}-windows.zip
+        shell: bash
+
+      - name: Upload to GitHub Release (if this run is a release)
+        if: ${{ github.event_name == 'release' }}
+        uses: svenstaro/upload-release-action@v2
+        with:
+          file: build/${{ env.EXPORT_NAME }}-windows.zip
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: windows
+          path: build/${{ env.EXPORT_NAME }}-windows.zip
+
+  export-linux:
+    name: Linux Export
+    runs-on: ubuntu-24.04
+    container:
+      image: barichello/godot-ci:${{ vars.GODOT_VERSION }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup
+        run: |
+          mkdir -v -p ~/.local/share/godot/export_templates/
+          mkdir -v -p ~/.config/
+          mv /root/.config/godot ~/.config/godot || true
+          mv /root/.local/share/godot/export_templates/${GODOT_VERSION}.stable ~/.local/share/godot/export_templates/${GODOT_VERSION}.stable || true
+
+      - name: Linux Build
+        run: |
+          mkdir -v -p build/linux
+          EXPORT_DIR="$(readlink -f build)"
+          cd $PROJECT_PATH
+          godot --headless --verbose --export-release "Linux" "$EXPORT_DIR/linux/${EXPORT_NAME}.x86_64"
+
+      - name: Archive Build
+        run: |
+          # ensure zip is available in the container
+          if ! command -v zip >/dev/null 2>&1; then
+            apt-get update && apt-get install -y zip
+          fi
+          # Change to the web directory and zip its contents directly
+          cd build/linux
+          zip -r ../${EXPORT_NAME}-linux.zip .
+          ls -lh ../${EXPORT_NAME}-linux.zip
+        shell: bash
+
+      - name: Upload to GitHub Release (if this run is a release)
+        if: ${{ github.event_name == 'release' }}
+        uses: svenstaro/upload-release-action@v2
+        with:
+          file: build/${{ env.EXPORT_NAME }}-linux.zip
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: linux
+          path: build/${{ env.EXPORT_NAME }}-linux.zip
+
+  export-mac:
+    name: macOS Export
+    runs-on: ubuntu-24.04
+    container:
+      image: barichello/godot-ci:${{ vars.GODOT_VERSION }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup
+        run: |
+          mkdir -v -p ~/.local/share/godot/export_templates/
+          mkdir -v -p ~/.config/
+          mv /root/.config/godot ~/.config/godot || true
+          mv /root/.local/share/godot/export_templates/${GODOT_VERSION}.stable ~/.local/share/godot/export_templates/${GODOT_VERSION}.stable || true
+
+      - name: Mac Build
+        run: |
+          mkdir -v -p build/mac
+          EXPORT_DIR="$(readlink -f build)"
+          cd $PROJECT_PATH
+          godot --headless --verbose --export-release "macOS" "$EXPORT_DIR/mac/${EXPORT_NAME}-mac.zip"
+
+      - name: Upload to GitHub Release (if this run is a release)
+        if: ${{ github.event_name == 'release' }}
+        uses: svenstaro/upload-release-action@v2
+        with:
+          file: build/mac/${{ env.EXPORT_NAME }}-mac.zip
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: mac
+          path: build/mac
+
+  deploy-to-itch:
+    name: Deploy to Itch.io
+    needs: [export-web, export-windows, export-linux, export-mac]
+    runs-on: ubuntu-24.04
+    env:
+      BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }} # Create this SECRET on Github
+      ITCH_USERNAME: ${{ vars.ITCH_USERNAME }} # Create this VARIABLE on Github
+      ITCH_GAME: ${{ vars.ITCH_GAME }} # Create this VARIABLE on Github
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: builds
+
+      - name: Install Butler
+        run: |
+          curl -L -o butler.zip https://broth.itch.zone/butler/linux-amd64/LATEST/archive/default
+          unzip butler.zip
+          chmod +x butler
+          ./butler -V
+
+      - name: Get version from tag or set default
+        id: version
+        run: |
+          if [ "${{ github.event_name }}" = "release" ]; then
+            VERSION="${{ github.event.release.tag_name }}"
+          else
+            VERSION="dev-${{ github.run_number }}"
+          fi
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Deploying version: $VERSION"
+
+      - name: Upload to Itch.io - Web
+        run: |
+          ./butler push builds/web ${{ env.ITCH_USERNAME }}/${{ env.ITCH_GAME }}:html5 --userversion "${{ steps.version.outputs.version }}"
+
+      - name: Upload to Itch.io - Windows
+        run: |
+          ./butler push builds/windows ${{ env.ITCH_USERNAME }}/${{ env.ITCH_GAME }}:windows --userversion "${{ steps.version.outputs.version }}"
+
+      - name: Upload to Itch.io - Linux
+        run: |
+          ./butler push builds/linux ${{ env.ITCH_USERNAME }}/${{ env.ITCH_GAME }}:linux --userversion "${{ steps.version.outputs.version }}"
+
+      - name: Upload to Itch.io - macOS
+        run: |
+          ./butler push builds/mac ${{ env.ITCH_USERNAME }}/${{ env.ITCH_GAME }}:mac --userversion "${{ steps.version.outputs.version }}"