Version 2.0.0

.github/workflows/main.yml

@@ -2,33 +2,38 @@ name: Compile and release
 
 on:
   push:
-    branches:
-      - master
+  pull_request:
+  workflow_dispatch:
 
 env:
   PLUGIN_NAME: chaos
   SCRIPTS_PATH: addons/sourcemod/scripting
+  SM_VERSION: '1.12.x'
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        sm-version: [ '1.12.x' ]
+    permissions:
+      contents: write
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
-      - name: Prepare include directory
-        run: mkdir -p ${{ env.SCRIPTS_PATH }}/include
+      - name: Cache include files
+        id: cache-includes
+        uses: actions/cache@v5
+        with:
+          path: ${{ env.SCRIPTS_PATH }}/include
+          key: includes-${{ hashFiles('.github/workflows/main.yml') }}
 
       - name: Download include files
+        if: steps.cache-includes.outputs.cache-hit != 'true'
         run: |
+          set -e
           includes=(
             "https://raw.githubusercontent.com/DoctorMcKay/sourcemod-plugins/master/scripting/include/morecolors.inc"
             "https://raw.githubusercontent.com/FlaminSarge/tf2attributes/refs/heads/master/scripting/include/tf2attributes.inc"
-            "https://raw.githubusercontent.com/nosoop/SMExt-SourceScramble/refs/heads/master/scripting/include/sourcescramble.inc"
             "https://raw.githubusercontent.com/asherkin/TF2Items/refs/heads/master/pawn/tf2items.inc"
             "https://raw.githubusercontent.com/nosoop/SM-TFUtils/refs/heads/master/scripting/include/tf2utils.inc"
             "https://raw.githubusercontent.com/FortyTwoFortyTwo/VScript/refs/heads/main/scripting/include/vscript.inc"
@@ -39,47 +44,29 @@ jobs:
 
           for url in "${includes[@]}"; do
             echo "Downloading $url"
-            curl -sSL -O --output-dir "${{ env.SCRIPTS_PATH }}/include" "$url"
+            curl --fail -sSL -O --output-dir "${{ env.SCRIPTS_PATH }}/include" "$url"
           done
 
-      - name: Setup SourcePawn compiler ${{ matrix.sm-version }}
+      - name: Setup SourcePawn compiler
         id: setup_sp
         uses: rumblefrog/setup-sp@master
         with:
-          version: ${{ matrix.sm-version }}
+          version: ${{ env.SM_VERSION }}
           version-file: ${{ env.SCRIPTS_PATH }}/${{ env.PLUGIN_NAME }}.sp
           define-name: PLUGIN_VERSION
 
       - name: Compile plugin
         run: |
           mkdir -p ../plugins
           spcomp -v2 -E -i "include" -o "../plugins/${{ env.PLUGIN_NAME }}.smx" "${{ env.PLUGIN_NAME }}.sp"
-          echo "=== OUT FILES ==="
-          ls ../plugins
-          echo "=== VERSION ==="
-          echo ${{ steps.setup_sp.outputs.plugin-version }}
         working-directory: ${{ env.SCRIPTS_PATH }}
 
-      - name: Install zip utility
-        uses: montudor/action-zip@v1
-
       - name: Zip output
-        run: |
-          zip -qq -r ${{ github.event.repository.name }}.zip addons/sourcemod scripts
-
-      - name: List build outputs
-        run: |
-          echo "::group::Directory contents"
-          ls -R
-          echo "::endgroup::"
-          echo "::group::Zip contents"
-          unzip -l ${{ github.event.repository.name }}.zip
-          echo "::endgroup::"
+        run: zip -qq -r ${{ github.event.repository.name }}.zip addons materials scripts shaders
 
       - name: Create GitHub release
+        if: github.ref_name == 'master'
         uses: ncipollo/release-action@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           tag: ${{ steps.setup_sp.outputs.plugin-version }}

README.MD

@@ -1,14 +1,17 @@
 # TF2 Chaos Mod
 
-**As seen on [TFConnect 2023](https://tfconnect.org)!**
+<img alt="TF2 Chaos Mod Logo" src="https://user-images.githubusercontent.com/25514044/216839199-de0a68ae-27d4-44c6-b394-54c98c85d701.png" width="540"/>
 
-<img alt="TF2 Chaos Mod Logo" src="https://user-images.githubusercontent.com/25514044/216839199-de0a68ae-27d4-44c6-b394-54c98c85d701.png" width="500"/>
+<sub>Logo created by [RatX](https://steamcommunity.com/profiles/76561198058574997)</sub>
+
+---
 
 **Welcome to the official home of the TF2 Chaos Mod!**
 
-Every couple seconds, one of over 150 different effects is activated. Some effects are good and empower certain classes, but others can be bad, hindering gameplay.
+Every couple of seconds, one of over 150 different effects is activated. Some effects are good and empower certain classes, but others can be bad, hindering gameplay.
 
-You can easily add your own effects using the provided Squirrel (VScript) or SourcePawn API. See [here](https://github.com/Mikusch/ChaosModTF2/wiki) for more information on effect creation.
+You can easily add your own effects using the provided Squirrel (VScript) or SourcePawn API.
+For more information on effect creation, see [here](https://github.com/Mikusch/ChaosModTF2/wiki).
 
 ## Requirements
 
@@ -18,12 +21,12 @@ You can easily add your own effects using the provided Squirrel (VScript) or Sou
 * [nosoop/SM-TFUtils](https://github.com/nosoop/SM-TFUtils)
 * [nosoop/SM-TFEconData](https://github.com/nosoop/SM-TFEconData)
 * [FortyTwoFortyTwo/VScript](https://github.com/FortyTwoFortyTwo/VScript)
-* [DoctorMcKay/MoreColors](https://github.com/DoctorMcKay/sourcemod-plugins/blob/master/scripting/include/morecolors.inc) (compile
+* [DoctorMcKay/MoreColors](https://github.com/DoctorMcKay/sourcemod-plugins/blob/master/scripting/include/morecolors.inc) (
+  compile
   only)
 
 ## Special Thanks
 
-* [ficool2](https://github.com/ficool2) - For assistance in setting up the VScript API
-* [RatX](https://steamcommunity.com/id/ratx15) - For creating the Chaos Mod logo
-* [Red Sun Over Paradise](https://redsun.tf) - For playtesting and giving feedback
-* [TFConnect](https://tfconnect.org) - For featuring Chaos Mod in TFConnect 2023, supporting SpecialEffect's mission to aid & empower gamers with physical disabilities by helping them play video games
+* [ficool2](https://github.com/ficool2) – For assistance in setting up the VScript API
+* [Red Sun Over Paradise](https://redsun.tf) – For playtesting and giving feedback
+* [TFConnect](https://tfconnect.org) – For featuring Chaos Mod on TFConnect, a gaming charity fundraising event supporting SpecialEffect's mission to aid & empower gamers with physical disabilities by helping them play video games