Port from FF client to XNA

.gitattributes

@@ -0,0 +1,30 @@
+# Shell scripts require LF
+*.sh  text eol=lf
+*.ps1 text eol=lf
+*.ts text eol=lf
+# Batch scripts require CRLF
+*.cmd text eol=crlf
+*.bat text eol=crlf
+*.cfg text eol=crlf
+*.ini text eol=crlf
+*.map text eol=crlf
+*.txt text eol=crlf
+*.xdp text eol=crlf
+preupdateexec text eol=crlf
+updateexec    text eol=crlf
+version       text eol=crlf
+# Ensure binary assets keep original byte content
+*.exe binary
+*.dll binary
+*.ico binary
+*.cur binary
+*.xnb binary
+*.zip binary
+*.7z binary
+*.gz binary
+*.tgz binary
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.bmp binary
+*.psd binary

.github/workflows/deployment.yml

@@ -0,0 +1,237 @@
+name: build-and-deploy
+
+on:
+  # Run on push to any branches listed
+  # Any new features that should be auto built and deployed should be in a branch under "feature/"
+  # example: feature/port-to-xna
+  # NOTE: Currently limited to dev/feature builds only
+  push:
+    branches:
+      # - master  # Disabled for dev builds only
+      # - pre-release  # Disabled for dev builds only
+      - feature/*
+      # - hotfix/*  # Disabled for dev builds only
+
+  # Run when there is a release published
+  # NOTE: Disabled for dev builds only
+  # release:
+  #   types: [published]
+
+  # Allows for this workflow to be run manually
+  workflow_dispatch:
+
+jobs:
+  # This job is responsible for building the package that will be deployed to the server.
+  # It is run in a windows container so that Version.exe and other Windows based tools are able to be executed.
+  build-package:
+    runs-on: windows-2022
+    environment: cncnet
+    outputs:
+      # This the fully qualified version string that is used for deploy purposes.
+      packageUploadVersion: ${{ env.GitVersion_MajorMinorPatch }}${{ env.GitVersion_PreReleaseLabelWithDash }}
+      mirrorLinkName: ${{ env.GitVersion_PreReleaseLabel }}
+
+    steps:
+      # Checkout the repo
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+          fetch-depth: 0 # required for gitversion
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: npm
+          cache-dependency-path: tools/package-lock.json
+
+      # Ensure Inno Setup is installed on the runner (x64), and upgrade to a version that supports ExecAndCaptureOutput (>= 6.3)
+      - name: Install Inno Setup (x64)
+        shell: pwsh
+        run: |
+          choco install innosetup --yes --no-progress
+          function Set-InnoPath {
+            param([string[]]$Candidates)
+            $cand = $Candidates | Where-Object { Test-Path $_ } | Select-Object -First 1
+            if (-not $cand) { throw 'ISCC.exe not found after Chocolatey install.' }
+            echo "INNO_SETUP_ISCC=$cand" | Out-File -FilePath $env:GITHUB_ENV -Append
+            return $cand
+          }
+          $cands = @(
+            'C:/Program Files/Inno Setup 6/ISCC.exe',
+            'C:/Program Files (x86)/Inno Setup 6/ISCC.exe'
+          )
+          $iscc = Set-InnoPath -Candidates $cands
+          $ver = ([System.Diagnostics.FileVersionInfo]::GetVersionInfo($iscc)).FileVersion
+          try { $verObj = [version]$ver } catch { $verObj = $null }
+          if (-not $verObj -or ($verObj.Major -lt 6 -or ($verObj.Major -eq 6 -and $verObj.Minor -lt 3))) {
+            Write-Host "Detected Inno Setup version $ver (path: $iscc). Upgrading to latest..."
+            choco upgrade innosetup --yes --no-progress
+            # Re-select after upgrade
+            Remove-Item Env:\INNO_SETUP_ISCC -ErrorAction SilentlyContinue
+            $iscc = Set-InnoPath -Candidates $cands
+            $ver = ([System.Diagnostics.FileVersionInfo]::GetVersionInfo($iscc)).FileVersion
+            Write-Host "Using Inno Setup version $ver at $iscc"
+          } else {
+            Write-Host "Using Inno Setup version $ver at $iscc"
+          }
+
+      - name: Install Tools NPM Libs
+        working-directory: tools
+        run: npm ci --omit=dev
+
+      - name: Run Mix Packer
+        working-directory: tools
+        run: npm run mix-packer
+
+      # This step validates the format of the tag created, if this was a published release.
+      # Currently, it must be in the format "ra-X.Y" or "ra-X.Y.Z"
+      - name: Validate Tag Name
+        if: github.event_name == 'release'
+        working-directory: tools
+        run: |
+          npm run release-tag-validator
+
+      - name: Install GitVersion
+        uses: gittools/actions/gitversion/setup@v0.9.15
+        with:
+          versionSpec: "5.x"
+
+      # Run Gitversion - https://gitversion.net/docs/
+      - name: Run GitVersion
+        uses: gittools/actions/gitversion/execute@v0.9.15
+
+      # Update versionconfig.ini with gitversion version info
+      - name: Update versionconfig.ini
+        # replace the second line in the file with the proper version number (X.Y.Z-dev.N)
+        run: sed -i "2 s/.*/${{env.GitVersion_SemVer}}/" ./package/versionconfig.ini
+
+      - name: Version Writer
+        working-directory: tools
+        run: npm run version-writer
+
+      # Create package archive
+      - name: Create package artifact (tar.gz)
+        run: tar -C ./package -czvf package.tar.gz .
+
+      - name: Create package artifact (zip)
+        run: 7z.exe a package.zip ./package
+
+      # Create installer
+      - name: Build Installer
+        working-directory: tools
+        env:
+          INNO_SETUP_ISCC: ${{ env.INNO_SETUP_ISCC }}
+        run: npm run build-installer
+
+      - name: Check installer exists
+        shell: pwsh
+        run: |
+          if (Test-Path './CnCNet5_RA_Installer.exe') {
+            Write-Host 'Installer found at repo root.'
+            Get-Item './CnCNet5_RA_Installer.exe' | Select-Object FullName,Length,LastWriteTime | Format-Table -AutoSize
+          } else {
+            Write-Warning 'Installer not found at ./CnCNet5_RA_Installer.exe. Searching...'
+            Get-ChildItem -Recurse -File -Filter 'CnCNet5_RA_Installer*.exe' | Select-Object FullName,Length,LastWriteTime | Format-Table -AutoSize
+            throw 'Installer missing!'
+          }
+
+      # Upload package archive as a workflow artifact
+      - name: Upload Package Workflow Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: package
+          path: ./package.tar.gz
+          if-no-files-found: error
+
+      # Upload installer as a workflow artifact
+      - name: Upload Installer Workflow Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: installer
+          path: ./CnCNet5_RA_Installer.exe
+          if-no-files-found: error
+
+      # Upload package archive (tar.gz) to any relevant releases for current tag
+      # If there is no release/tag, this will not do anything
+      - name: Upload Package Release Asset (tar.gz)
+        if: github.event_name == 'release'
+        working-directory: tools
+        run: npm run release-asset-uploader -- --token ${{ secrets.GITHUB_TOKEN }} --assetName "package_${{env.GitVersion_SemVer}} (tar.gz)" --assetPath ../package.tar.gz
+
+      # Upload package archive (zip) to any relevant releases for current tag
+      # If there is no release/tag, this will not do anything
+      - name: Upload Package Release Asset (zip)
+        if: github.event_name == 'release'
+        working-directory: tools
+        run: npm run release-asset-uploader -- --token ${{ secrets.GITHUB_TOKEN }} --assetName "package_${{env.GitVersion_SemVer}} (zip)" --assetPath ../package.zip
+
+      # Upload installer to any relevant releases for current tag
+      # If there is no release/tag, this will not do anything
+      - name: Upload Installer Release Asset
+        if: github.event_name == 'release'
+        working-directory: tools
+        run: npm run release-asset-uploader -- --token ${{ secrets.GITHUB_TOKEN }} --assetName "CnCNet5_RA_Installer_${{env.GitVersion_SemVer}} (exe)" --assetPath ../CnCNet5_RA_Installer.exe
+
+  # This job downloads the package artifact from the previous job and deploys it to the server.
+  deploy-package:
+    # if previous job was successful
+    if: ${{ success() }}
+    runs-on: ubuntu-22.04
+    environment: cncnet
+    needs: build-package
+
+    steps:
+      # Download the package artifact from previous job
+      - name: Get artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: package
+
+      # Deploy the package to the server
+      - name: Deploy package
+        uses: appleboy/scp-action@master
+        with:
+          host: ${{ secrets.SSH_HOST }}
+          username: ${{ secrets.SSH_USER }}
+          passphrase: ${{ secrets.SSH_PASS }}
+          key: ${{ secrets.SSH_KEY }}
+          port: ${{ secrets.SSH_PORT }}
+          overwrite: true
+          source: "package.tar.gz"
+          target: "${{ secrets.SSH_PATH_UPDATES }}/${{ needs.build-package.outputs.packageUploadVersion }}/"
+
+      # Extract the deployed package on the server
+      - name: Extract the deployed package
+        uses: appleboy/ssh-action@v0.1.7
+        with:
+          host: ${{ secrets.SSH_HOST }}
+          username: ${{ secrets.SSH_USER }}
+          passphrase: ${{ secrets.SSH_PASS }}
+          key: ${{ secrets.SSH_KEY }}
+          port: ${{ secrets.SSH_PORT }}
+          script: |
+            cd ${{ secrets.SSH_PATH_UPDATES }}/${{ needs.build-package.outputs.packageUploadVersion }}
+            tar -xzvf ${{ secrets.SSH_PATH_UPDATES }}/${{ needs.build-package.outputs.packageUploadVersion }}/package.tar.gz
+            rm ${{ secrets.SSH_PATH_UPDATES }}/${{ needs.build-package.outputs.packageUploadVersion }}/package.tar.gz
+            chmod 777 --recursive ${{ secrets.SSH_PATH_UPDATES }}/${{ needs.build-package.outputs.packageUploadVersion }}/*
+
+      # Create/update a mirror link for client update purposes, using the GitVersion pre release label as the link name.
+      # See the file "GitVersion.yml" for more details on the name that will be used for a given branch.
+      # Ex: if the branch name is "feature/port-to-xna", it will create a link using the sanitized branch name to point to the directory "updates/X.Y.Z-port-to-xna".
+      # Then, client users can use the path "/updates/games/ra/<branch>/" for their UpdaterConfig.ini file.
+      # This will keep develop and feature branch update mirror links up to date as soon as the deploy has occurred.
+      - name: Update mirror link
+        uses: appleboy/ssh-action@v0.1.7
+        # RUN ON NON-RELEASES ONLY. RELEASE VERSION LINKS SHOULD CONTINUE TO BE UPDATED MANUALLY, FOR NOW.
+        if: github.event_name != 'release' && needs.build-package.outputs.mirrorLinkName != ''
+        with:
+          host: ${{ secrets.SSH_HOST }}
+          username: ${{ secrets.SSH_USER }}
+          passphrase: ${{ secrets.SSH_PASS }}
+          key: ${{ secrets.SSH_KEY }}
+          port: ${{ secrets.SSH_PORT }}
+          script: |
+            cd ${{ secrets.SSH_PATH_GAMES_RA }}
+            ln -sfn updates/${{ needs.build-package.outputs.packageUploadVersion }} ${{ needs.build-package.outputs.mirrorLinkName }}

.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: publish-release
+
+on:
+  # Only run this workflow manually
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-22.04
+    environment: cncnet
+
+    steps:
+      # Checkout the repo
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: npm
+          cache-dependency-path: tools/package-lock.json
+
+      - name: Install Tools NPM Libs
+        working-directory: tools
+        run: npm ci --omit=dev
+
+      # This looks for the latest release in our repo and does the following: 
+      # - updates our /live mirror path to point to it
+      # - posts an update message to an IRC channel notifying user clients of the newly published update
+      - name: Publish Latest Release
+        working-directory: tools
+        run: npm run publish-release -- --token ${{ secrets.GITHUB_TOKEN }} --sshHost ${{ secrets.SSH_HOST }} --sshUsername ${{ secrets.SSH_USER }} --sshPort ${{ secrets.SSH_PORT }} --sshPassphrase ${{ secrets.SSH_PASS }} --sshKeyBase64 ${{ secrets.SSH_KEY_BASE64 }} --raGamePath ${{ secrets.SSH_PATH_GAMES_RA }} --ircServer ${{ secrets.IRC_SERVER }} --ircChannel ${{ secrets.IRC_CHANNEL }} --ircNick ${{ secrets.IRC_NICK }} --ircUserName ${{ secrets.IRC_USERNAME }} --ircPassword ${{ secrets.IRC_PASSWORD }} --ircRealName ${{ secrets.IRC_REALNAME }}
+
+