Various fixes

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "gitsubmodule"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/main.yml

@@ -0,0 +1,165 @@
+name: CLEO 5 Release Build
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+**'
+
+jobs:
+  build:
+    runs-on: windows-2022
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Add msbuild to PATH
+        uses: microsoft/setup-msbuild@v2
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+
+      - name: Read Version Tag
+        id: read_version
+        run: node.exe .github/workflows/version.js
+
+      - name: Core - Build
+        shell: cmd
+        run: |
+          set PLUGIN_SDK_DIR=%GITHUB_WORKSPACE%\third-party\plugin-sdk
+          msbuild -m CLEO5.sln /property:Configuration=Release /property:Platform=GTASA
+
+      - name: Core - Sign
+        uses: x87/code-sign-action@develop
+        with:
+          certificate: '${{ secrets.DIG_KEY_CERT }}'
+          password: '${{ secrets.DIG_KEY_PWD }}'
+          certificatename: 'Seemann'
+          description: 'CLEO 5'
+          timestampUrl: 'http://timestamp.digicert.com'
+          filename: './.output/Release/cleo.asi'
+
+      - name: Core - VirusTotal Scan
+        uses: crazy-max/ghaction-virustotal@v4
+        with:
+          vt_api_key: ${{ secrets.VT_KEY }}
+          files: './.output/Release/CLEO.asi'
+
+      - name: Plugins - Build
+        shell: cmd
+        run: |
+          set PLUGIN_SDK_DIR=%GITHUB_WORKSPACE%\third-party\plugin-sdk
+          msbuild -m cleo_plugins/CLEO_Plugins.sln /property:Configuration=Release /property:Platform=x86
+
+      - name: Plugins - Sign
+        uses: x87/code-sign-action@develop
+        with:
+          certificate: '${{ secrets.DIG_KEY_CERT }}'
+          password: '${{ secrets.DIG_KEY_PWD }}'
+          certificatename: 'Seemann'
+          description: 'CLEO 5 Plugin'
+          timestampUrl: 'http://timestamp.digicert.com'
+          folder: './cleo_plugins/.output'
+
+      - name: Plugins - VirusTotal Scan
+        uses: crazy-max/ghaction-virustotal@v4
+        with:
+          vt_api_key: ${{ secrets.VT_KEY }}
+          files: './cleo_plugins/.output/*.cleo'
+
+      - name: Gather Output Files
+        id: prepare_archive
+        shell: cmd
+        run: |
+          @REM create output directory
+          mkdir .output\Release\cleo
+          mkdir .output\Release\cleo\.config
+          mkdir .output\Release\cleo\cleo_modules
+          mkdir .output\Release\cleo\cleo_plugins
+          mkdir .output\Release\cleo\cleo_saves
+          mkdir .output\Release\cleo\cleo_text
+          mkdir .output\Release\cleo_readme
+
+          @REM copy files
+          copy source\cleo_config.ini .output\Release\cleo\.cleo_config.ini
+          copy cleo_plugins\.output\*.cleo .output\Release\cleo\cleo_plugins
+          copy cleo_plugins\.output\*.ini .output\Release\cleo\cleo_plugins
+          copy cleo_plugins\Audio\bass\bass.dll .output\Release\bass.dll
+          xcopy /E /I tests .output\Release\cleo
+
+          @REM copy SDK
+          copy .output\Release\CLEO.lib cleo_sdk\CLEO.lib
+
+          @REM download Sanny Builder Library json
+          curl https://raw.githubusercontent.com/sannybuilder/library/master/sa/sa.json -o .output\Release\cleo\.config\sa.json
+
+      - name: Convert Markdown to HTML
+        id: md_to_html
+        run: |
+          npm install showdown
+          node.exe .github/workflows/markdown.js
+          move README.html .output\Release\cleo_readme\README.html
+          move CHANGELOG.html .output\Release\cleo_readme\CHANGELOG.html
+
+      - name: Download ASI Loaders
+        id: download_asi_loaders
+        shell: cmd
+        run: |
+          xcopy /E /I .output\Release .output\Release_with_Silent_ASI_Loader
+          xcopy /E /I .output\Release .output\Release_with_Ultimate_ASI_Loader
+
+          @REM install Silent's ASI Loader
+          curl https://silent.rockstarvision.com/uploads/silents_asi_loader_13.zip -o silents_asi_loader_13.zip
+          powershell.exe -NoP -NonI -Command "Expand-Archive '.\silents_asi_loader_13.zip' '.\.output\Release_with_Silent_ASI_Loader'"
+          move .output\Release_with_Silent_ASI_Loader\ReadMe.txt ".output\Release_with_Silent_ASI_Loader\cleo_readme\ASI Loader Readme.txt"
+          rmdir /s /q .output\Release_with_Silent_ASI_Loader\advanced_plugin_management_example
+          rmdir /s /q .output\Release_with_Silent_ASI_Loader\scripts
+
+          @REM install Ultimate ASI Loader
+          curl https://github.com/ThirteenAG/Ultimate-ASI-Loader/releases/download/Win32-latest/vorbisFile-Win32.zip -L -o ual.zip
+          powershell.exe -NoP -NonI -Command "Expand-Archive '.\ual.zip' '.\.output\Release_with_Ultimate_ASI_Loader'"
+          rm .\.output\Release_with_Ultimate_ASI_Loader\vorbisFile-Win32.SHA512
+
+      - name: Pack Base Archive
+        uses: ThirteenAG/zip-release@master
+        with:
+          path: ./.output/Release/*
+          type: "zip"
+          filename: SA.CLEO_${{ github.ref_name }}.zip
+          exclusions: "*.pdb *.lib *.exp"
+
+      - name: Pack Base + Silent's ASI Loader
+        uses: ThirteenAG/zip-release@master
+        with:
+          path: ./.output/Release_with_Silent_ASI_Loader/*
+          type: "zip"
+          filename: SA.CLEO_${{ github.ref_name }}+Silent_ASI_Loader.zip
+          exclusions: "*.pdb *.lib *.exp"
+
+      - name: Pack Base + UAL
+        uses: ThirteenAG/zip-release@master
+        with:
+          path: ./.output/Release_with_Ultimate_ASI_Loader/*
+          type: "zip"
+          filename: SA.CLEO_${{ github.ref_name }}+Ultimate_ASI_Loader.zip
+          exclusions: "*.pdb *.lib *.exp"
+
+      - name: CLEO SDK
+        uses: ThirteenAG/zip-release@master
+        with:
+          path: ./cleo_sdk/*
+          type: "zip"
+          filename: SA.CLEO_${{ github.ref_name }}_SDK.zip
+          exclusions: "*.pdb *.exp"
+
+      - name: Upload Release
+        uses: ncipollo/release-action@main
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          name: ${{ steps.read_version.outputs.version }}
+          bodyFile: 'changes.txt' # generated in read_version
+          tag: ${{ github.ref_name }}
+          prerelease: ${{ contains(github.ref_name, 'beta') || contains(github.ref_name, 'alpha') }}
+          artifacts: "SA.CLEO_*.zip"

.github/workflows/markdown.js

@@ -0,0 +1,16 @@
+const showdown = require('showdown');
+const {readFileSync, writeFileSync} = require('fs');
+
+const md = new showdown.Converter({
+  literalMidWordUnderscores: true,
+  disableForced4SpacesIndentedSublists: true,
+  noHeaderId: true,
+  completeHTMLDocument: true,
+  simplifiedAutoLink: true,
+});
+
+const readme = md.makeHtml(readFileSync('README.md', 'utf8'));
+const changelog = md.makeHtml(readFileSync('CHANGELOG.md', 'utf8'));
+
+writeFileSync('README.html', readme, 'utf8');
+writeFileSync('CHANGELOG.html', changelog, 'utf8');

.github/workflows/test.yml

@@ -0,0 +1,91 @@
+name: CLEO 5 Test Build
+
+on:
+  push:
+    paths-ignore:
+    - ".github/*"
+    - "*.md"
+  pull_request:
+    types: [opened, reopened]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: windows-2022
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Add msbuild to PATH
+        uses: microsoft/setup-msbuild@v2
+
+      - name: Core - Build
+        shell: cmd
+        run: |
+          set PLUGIN_SDK_DIR=%GITHUB_WORKSPACE%\third-party\plugin-sdk
+          msbuild -m CLEO5.sln /property:Configuration=Release /property:Platform=GTASA
+
+      - name: Core - Sign
+        uses: x87/code-sign-action@develop
+        with:
+          certificate: '${{ secrets.DIG_KEY_CERT }}'
+          password: '${{ secrets.DIG_KEY_PWD }}'
+          certificatename: 'Seemann'
+          description: 'CLEO 5'
+          timestampUrl: 'http://timestamp.digicert.com'
+          filename: './.output/Release/cleo.asi'
+
+      - name: Core - VirusTotal Scan
+        uses: crazy-max/ghaction-virustotal@v4
+        with:
+          vt_api_key: ${{ secrets.VT_KEY }}
+          files: './.output/Release/CLEO.asi'
+
+      - name: Plugins - Build
+        shell: cmd
+        run: |
+          set PLUGIN_SDK_DIR=%GITHUB_WORKSPACE%\third-party\plugin-sdk
+          msbuild -m cleo_plugins/CLEO_Plugins.sln /property:Configuration=Release /property:Platform=x86
+
+      - name: Plugins - Sign
+        uses: x87/code-sign-action@develop
+        with:
+          certificate: '${{ secrets.DIG_KEY_CERT }}'
+          password: '${{ secrets.DIG_KEY_PWD }}'
+          certificatename: 'Seemann'
+          description: 'CLEO 5 Plugin'
+          timestampUrl: 'http://timestamp.digicert.com'
+          folder: './cleo_plugins/.output'
+
+      - name: Plugins - VirusTotal Scan
+        uses: crazy-max/ghaction-virustotal@v4
+        with:
+          vt_api_key: ${{ secrets.VT_KEY }}
+          files: './cleo_plugins/.output/*.cleo'
+
+      - name: Gather Output Files
+        id: prepare_archive
+        shell: cmd
+        run: |
+          @REM create output directory
+          mkdir .output\Release\cleo
+          mkdir .output\Release\cleo\cleo_plugins
+
+          @REM copy files
+          copy third-party\bass\bass.dll .output\Release\bass.dll
+          copy source\cleo_config.ini .output\Release\cleo\.cleo_config.ini
+          copy cleo_plugins\.output\*.cleo .output\Release\cleo\cleo_plugins
+          copy cleo_plugins\.output\*.ini .output\Release\cleo\cleo_plugins
+
+      - name: Upload Result
+        uses: actions/upload-artifact@v4
+        with:
+          compression-level: 0
+          name: SA.CLEO5
+          path: |
+            .output\Release\*
+            !.output\Release\*.pdb
+            !.output\Release\*.lib
+            !.output\Release\*.exp

.github/workflows/version.js

@@ -0,0 +1,59 @@
+const { appendFileSync, readFileSync, writeFileSync } = require("fs");
+const { EOL } = require("os");
+const { GITHUB_OUTPUT, GITHUB_REF_NAME } = process.env;
+
+if (GITHUB_REF_NAME) {
+  const version = GITHUB_REF_NAME.startsWith("v") ? GITHUB_REF_NAME.slice(1) : GITHUB_REF_NAME;
+  addOutput("version", version);
+
+  // update cleo.h to replace version
+  const cleoH = readFileSync("cleo_sdk/cleo.h", { encoding: "utf-8" });
+
+  const [, main, major, minor] = version.match(/(\d+)\.(\d+)\.(\d+).*/);
+
+  const newCleoH = cleoH
+    .replace(/#define\s+CLEO_VERSION_MAIN\s+.*/, `#define CLEO_VERSION_MAIN ${main}`)
+    .replace(/#define\s+CLEO_VERSION_MAJOR\s+.*/, `#define CLEO_VERSION_MAJOR ${major}`)
+    .replace(/#define\s+CLEO_VERSION_MINOR\s+.*/, `#define CLEO_VERSION_MINOR ${minor}`)
+    .replace(/#define\s+CLEO_VERSION_STR\s+.*/, `#define CLEO_VERSION_STR "${version}"`);
+  writeFileSync("cleo_sdk/cleo.h", newCleoH, { encoding: "utf-8" });
+}
+
+const changelog = readFileSync("CHANGELOG.md", { encoding: "utf-8" });
+writeFileSync("changes.txt", getChanges().join(EOL), { encoding: "utf-8" });
+
+function addOutput(key, value) {
+  appendFileSync(GITHUB_OUTPUT, `${key}=${value}${EOL}`, { encoding: "utf-8" });
+}
+
+function getChanges() {
+  const lines = changelog.split(EOL);
+  const result = [
+    `## Download Instructions`,
+    `An ASI loader is required for CLEO 5 to work. CLEO 5 comes pre-packaged with several popular ASI Loaders ([Silent's ASI Loader](https://cookieplmonster.github.io/mods/gta-sa/#asiloader) and [Ultimate ASI Loader](https://github.com/ThirteenAG/Ultimate-ASI-Loader)).`,
+    `#### If you don't have an ASI loader installed already or unsure which one to download:`,
+    `- Download [CLEO ${GITHUB_REF_NAME} with Silent's ASI Loader](https://github.com/cleolibrary/CLEO5/releases/download/${GITHUB_REF_NAME}/SA.CLEO_${GITHUB_REF_NAME}+Silent_ASI_Loader.zip)`,
+    `#### If you prefer Ultimate ASI Loader:`,
+    `- Download [CLEO ${GITHUB_REF_NAME} with Ultimate ASI Loader](https://github.com/cleolibrary/CLEO5/releases/download/${GITHUB_REF_NAME}/SA.CLEO_${GITHUB_REF_NAME}+Ultimate_ASI_Loader.zip)`,
+    `#### If you have an ASI loader installed already:`,
+    `- Download [this archive](https://github.com/cleolibrary/CLEO5/releases/download/${GITHUB_REF_NAME}/SA.CLEO_${GITHUB_REF_NAME}.zip) which contains ONLY CLEO 5 library and plugins.`,
+    `## Installation`,
+    `- Unzip the archive to GTA San Andreas game directory.`,
+    `## Changelog`,
+  ];
+
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i];
+    if (line.trimStart().startsWith("## ")) {
+      for (let j = i + 1; j < lines.length; j++) {
+        const line = lines[j];
+        if (line.trimStart().startsWith("## ")) {
+          return result;
+        }
+        result.push(line);
+      }
+    }
+  }
+
+  return result;
+}

.gitignore

@@ -1,5 +1,5 @@
 build/
-output/
+.output/
 *.APS
 *.VC.db
 *.VC.opendb
@@ -38,4 +38,8 @@ output/
 Debug/*
 Release/*
 ipch/
-.vs/
+.vs/
+*.zip
+*.lib
+node_modules/
+tests/**/*.s

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "plugin-sdk"]
+	path = third-party/plugin-sdk
+	url = https://github.com/DK22Pac/plugin-sdk