feature: nade practice plugin

.github/workflows/ci.yaml

@@ -46,12 +46,16 @@ jobs:
  - 'Directory.Build.props'
  - '.github/workflows/ci.yaml'
  - '.github/workflows/plugin-build.yaml'
+ # each game-server image builds both its match plugin and the
+ # practice plugin, so either source tree rebuilds it
  css:
  - *shared
  - 'apps/counterstrikesharp/**'
+ - 'apps/utility-css/**'
  sw:
  - *shared
  - 'apps/swiftly/**'
+ - 'apps/utility-sw/**'
  validator:
  - 'apps/gamedata-validator/**'
  - 'shared/gamedata/**'
@@ -71,6 +75,7 @@ jobs:
  version_tag_regex: '^(?:css-)?v0\.0\.(\d+)$'
  channel: ${{ needs.changes.outputs.channel }}
  run_tests: true
+ extra_test_dir: apps/utility-css
  secrets: inherit
 
  swiftly:
@@ -86,6 +91,7 @@ jobs:
  version_floor: 41
  channel: ${{ needs.changes.outputs.channel }}
  run_tests: true
+ extra_test_dir: apps/utility-sw
  secrets: inherit
 
  gamedata-validator:

.github/workflows/plugin-build.yaml

@@ -29,6 +29,11 @@ on:
  required: false
  default: false
  type: boolean
+ extra_test_dir:
+ description: "second app whose suite ships in this image (the practice plugin)"
+ required: false
+ default: ""
+ type: string
 
 jobs:
  build:
@@ -47,7 +52,14 @@ jobs:
 
  - name: Test
  if: inputs.run_tests
- run: dotnet test ${{ inputs.app_dir }}/test/FiveStack.Tests.csproj -c Release
+ env:
+ APP_DIR: ${{ inputs.app_dir }}
+ EXTRA_TEST_DIR: ${{ inputs.extra_test_dir }}
+ run: |
+ dotnet test "$APP_DIR/test/FiveStack.Tests.csproj" -c Release
+ if [ -n "$EXTRA_TEST_DIR" ]; then
+ dotnet test "$EXTRA_TEST_DIR/test/FiveStack.Tests.csproj" -c Release
+ fi
 
  - name: Resolve version and tags
  id: resolve

apps/counterstrikesharp/Dockerfile

@@ -1,4 +1,4 @@
-FROM registry.gitlab.steamos.cloud/steamrt/sniper/platform:latest-container-runtime-depot AS build
+FROM registry.gitlab.steamos.cloud/steamrt/sniper/platform:latest-container-runtime-depot AS dotnet-sdk
 
 # Install .NET SDK 10.0
 RUN apt-get update && \
@@ -14,6 +14,8 @@ RUN apt-get update && \
 ENV PATH="/usr/share/dotnet:${PATH}"
 ENV DOTNET_ROOT="/usr/share/dotnet"
 
+FROM dotnet-sdk AS build
+
 WORKDIR /mod
 
 COPY Directory.Build.props ./
@@ -35,6 +37,30 @@ RUN rm /mod/release/CounterStrikeSharp.API.dll
 
 COPY apps/counterstrikesharp/src/lang /mod/release/lang
 
+# The practice plugin is the other half of this image: a server runs either it
+# or the match plugin, never both, so it is built here and symlinked into place
+# only when INSTALL_UTILITY_PRACTICE_PLUGIN is set.
+FROM dotnet-sdk AS utility-build
+
+WORKDIR /mod
+
+COPY Directory.Build.props ./
+COPY apps/utility-css/src/UtilityPractice.csproj apps/utility-css/src/
+
+RUN dotnet restore apps/utility-css/src/UtilityPractice.csproj
+
+COPY shared shared
+COPY apps/utility-css apps/utility-css
+
+ARG RELEASE_VERSION
+ENV RELEASE_VERSION=${RELEASE_VERSION}
+
+RUN sed -i "s/__RELEASE_VERSION__/${RELEASE_VERSION}/" apps/utility-css/src/UtilityPracticePlugin.cs
+
+RUN dotnet build -c Release apps/utility-css/src/UtilityPractice.csproj -o release
+
+RUN rm -f /mod/release/CounterStrikeSharp.API.dll
+
 # New stage for creating the zip file
 FROM debian:bookworm-slim AS zip-creator
 
@@ -60,6 +86,7 @@ ENV AUTOLOAD_PLUGINS=true
 ENV PLUGINS_DIR="/opt/custom-plugins"
 
 ENV INSTALL_5STACK_PLUGIN=true
+ENV INSTALL_UTILITY_PRACTICE_PLUGIN=false
 
 ENV GAME_ID="730"
 ENV GAME_PARAMS=""
@@ -125,6 +152,7 @@ COPY apps/counterstrikesharp/cfg /opt/server-cfg
 COPY shared/scripts /opt/scripts
 COPY apps/counterstrikesharp/scripts /opt/scripts
 COPY --from=build /mod/release /opt/mod
+COPY --from=utility-build /mod/release /opt/utility-practice
 
 RUN mv /opt/metamod/addons /opt/addons && \
 	cp -R /opt/counterstrikesharp/addons/metamod /opt/addons && \

apps/counterstrikesharp/Dockerfile.dev

@@ -11,6 +11,7 @@ ENV AUTOLOAD_PLUGINS=true
 ENV PLUGINS_DIR="/opt/custom-plugins"
 
 ENV INSTALL_5STACK_PLUGIN=true
+ENV INSTALL_UTILITY_PRACTICE_PLUGIN=false
 
 ENV GAME_ID="730"
 ENV GAME_PARAMS=""

apps/counterstrikesharp/scripts/setup.sh

@@ -66,7 +66,10 @@ fi
 
 ln -s "/opt/custom-plugins/addons/counterstrikesharp/configs" "${INSTANCE_SERVER_DIR}/game/csgo/addons/counterstrikesharp/configs"
 
-if [ "$SERVER_TYPE" != "Ranked" ]; then
+# Public-server treatment: every installed custom plugin gets symlinked in,
+# which is what "load on every match" is meant to gate. A practice server is
+# 5stack-managed like a ranked one -- it runs its own plugin and nothing else.
+if [ "$SERVER_TYPE" != "Ranked" ] && [ "$SERVER_TYPE" != "Practice" ]; then
  if [ ! -d "/opt/custom-plugins" ]; then
  mkdir -p "/opt/custom-plugins"
  fi
@@ -129,6 +132,18 @@ if $INSTALL_5STACK_PLUGIN = true ; then
  fi
 fi
 
+# A practice server runs this instead of the match plugin, never alongside it.
+if $INSTALL_UTILITY_PRACTICE_PLUGIN = true ; then
+ echo "---Install Utility Practice---"
+ if [ "${DEV_SWAPPED}" == "1" ]; then
+ # css and sw dev builds share the dev volume; each uses its own subfolder
+ mkdir -p "/opt/dev/utility-css"
+ ln -s "/opt/dev/utility-css" "${INSTANCE_SERVER_DIR}/game/csgo/addons/counterstrikesharp/plugins/UtilityPractice"
+ else
+ ln -s "/opt/utility-practice" "${INSTANCE_SERVER_DIR}/game/csgo/addons/counterstrikesharp/plugins/UtilityPractice"
+ fi
+fi
+
 if [ ! -e "$INSTANCE_SERVER_DIR/game/csgo/addons/counterstrikesharp/configs/core.json" ]; then
  cp "/opt/server-cfg/core.json" "$INSTANCE_SERVER_DIR/game/csgo/addons/counterstrikesharp/configs"
 fi

apps/swiftly/Dockerfile

@@ -1,4 +1,4 @@
-FROM registry.gitlab.steamos.cloud/steamrt/sniper/platform:latest-container-runtime-depot AS build
+FROM registry.gitlab.steamos.cloud/steamrt/sniper/platform:latest-container-runtime-depot AS dotnet-sdk
 
 RUN apt-get update && \
  apt-get install -y --no-install-recommends \
@@ -13,6 +13,8 @@ RUN apt-get update && \
 ENV PATH="/usr/share/dotnet:${PATH}"
 ENV DOTNET_ROOT="/usr/share/dotnet"
 
+FROM dotnet-sdk AS build
+
 WORKDIR /mod
 
 COPY Directory.Build.props ./
@@ -30,6 +32,28 @@ RUN sed -i "s/__RELEASE_VERSION__/${RELEASE_VERSION}/" apps/swiftly/src/FiveStac
 
 RUN dotnet publish -c Release apps/swiftly/src/FiveStack.csproj -o /mod/release
 
+# The practice plugin is the other half of this image: a server runs either it
+# or the match plugin, never both, so it is built here and symlinked into place
+# only when INSTALL_UTILITY_PRACTICE_PLUGIN is set.
+FROM dotnet-sdk AS utility-build
+
+WORKDIR /mod
+
+COPY Directory.Build.props ./
+COPY apps/utility-sw/src/UtilityPractice.csproj apps/utility-sw/src/
+
+RUN dotnet restore apps/utility-sw/src/UtilityPractice.csproj
+
+COPY shared shared
+COPY apps/utility-sw apps/utility-sw
+
+ARG RELEASE_VERSION
+ENV RELEASE_VERSION=${RELEASE_VERSION}
+
+RUN sed -i "s/__RELEASE_VERSION__/${RELEASE_VERSION}/" apps/utility-sw/src/UtilityPracticePlugin.cs
+
+RUN dotnet publish -c Release apps/utility-sw/src/UtilityPractice.csproj -o /mod/release
+
 FROM debian:bookworm-slim AS zip-creator
 
 WORKDIR /zip-content
@@ -54,6 +78,7 @@ ENV AUTOLOAD_PLUGINS=true
 ENV PLUGINS_DIR="/opt/custom-plugins"
 
 ENV INSTALL_5STACK_PLUGIN=true
+ENV INSTALL_UTILITY_PRACTICE_PLUGIN=false
 
 ENV GAME_ID="730"
 ENV GAME_PARAMS=""
@@ -132,6 +157,7 @@ COPY apps/swiftly/cfg /opt/server-cfg
 COPY shared/scripts /opt/scripts
 COPY apps/swiftly/scripts /opt/scripts
 COPY --from=build /mod/release /opt/mod
+COPY --from=utility-build /mod/release /opt/utility-practice
 
 RUN cp -R /opt/swiftlys2/swiftlys2-linux-${SWIFTLYS2_VERSION}-with-runtimes/addons /opt/addons && \
  rm -rf /opt/swiftlys2

apps/swiftly/scripts/setup.sh

@@ -89,7 +89,10 @@ if [ "$ENABLE_CSS_COMPAT" = "true" ]; then
  ln -s "/opt/custom-plugins/addons/counterstrikesharp/configs" "${INSTANCE_SERVER_DIR}/game/csgo/addons/counterstrikesharp/configs"
 fi
 
-if [ "$SERVER_TYPE" != "Ranked" ]; then
+# Public-server treatment: every installed custom plugin gets symlinked in,
+# which is what "load on every match" is meant to gate. A practice server is
+# 5stack-managed like a ranked one -- it runs its own plugin and nothing else.
+if [ "$SERVER_TYPE" != "Ranked" ] && [ "$SERVER_TYPE" != "Practice" ]; then
  if [ ! -d "/opt/custom-plugins" ]; then
  mkdir -p "/opt/custom-plugins"
  fi
@@ -178,6 +181,31 @@ if $INSTALL_5STACK_PLUGIN = true ; then
  fi
 fi
 
+# A practice server runs this instead of the match plugin, never alongside it.
+if $INSTALL_UTILITY_PRACTICE_PLUGIN = true ; then
+ echo "---Install Utility Practice---"
+ UTILITY_PRACTICE_PLUGIN_DIR="${INSTANCE_SERVER_DIR}/game/csgo/addons/swiftlys2/plugins/UtilityPractice"
+ if [ "${DEV_SWAPPED}" == "1" ]; then
+ # AutoHotReload's recursive FileSystemWatcher does not follow symlinked plugin
+ # dirs, so hot reload needs the dev volume mounted straight onto this path
+ # (see the dev deployment). Without the mount, fall back to a symlink.
+ mkdir -p "$UTILITY_PRACTICE_PLUGIN_DIR"
+ if mountpoint -q "$UTILITY_PRACTICE_PLUGIN_DIR"; then
+ echo "---Utility Practice dev: plugin dir is a mounted volume (hot reload enabled)---"
+ else
+ # css and sw dev builds share the dev volume; each uses its own subfolder
+ rmdir "$UTILITY_PRACTICE_PLUGIN_DIR" 2>/dev/null
+ mkdir -p "/opt/dev/utility-sw"
+ ln -s "/opt/dev/utility-sw" "$UTILITY_PRACTICE_PLUGIN_DIR"
+ echo "---Utility Practice dev: symlinked /opt/dev/utility-sw (hot reload OFF; use 'sw plugins reload UtilityPractice')---"
+ fi
+ elif [ ! -e "$UTILITY_PRACTICE_PLUGIN_DIR" ]; then
+ ln -s "/opt/utility-practice" "$UTILITY_PRACTICE_PLUGIN_DIR"
+ else
+ echo "---Utility Practice: plugin dir already present, skipping /opt/utility-practice symlink---"
+ fi
+fi
+
 if [ ! -e "$INSTANCE_SERVER_DIR/game/csgo/addons/swiftlys2/configs/core.jsonc" ]; then
  cp "/opt/server-cfg/core.jsonc" "$INSTANCE_SERVER_DIR/game/csgo/addons/swiftlys2/configs"
 fi

apps/utility-css/scripts/dev.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+apt update
+apt-get install inotify-tools -y
+
+# Variable to store the PID of dotnet watch process
+dotnet_watch_pid=""
+
+# Function to kill the dotnet watch build process
+kill_dotnet_watch() {
+ if [ -n "$dotnet_watch_pid" ]; then
+ kill "$dotnet_watch_pid"
+ exit
+ fi
+}
+dotnet build apps/utility-css/src
+
+dotnet watch build --project apps/utility-css/src &
+dotnet_watch_pid=$!
+
+# Set up trap to kill dotnet watch process on script exit
+trap kill_dotnet_watch EXIT
+
+directory_to_watch="/opt/5stack/apps/utility-css/src/bin/Debug/net10.0"
+
+# Matches the path apps/counterstrikesharp/scripts/setup.sh symlinks in.
+DEV_DIR="/opt/dev/utility-css"
+mkdir -p "$DEV_DIR"
+
+while true; do
+ rm -f "$directory_to_watch/CounterStrikeSharp.API.dll"
+ inotifywait -r -e modify,create,delete,move "$directory_to_watch"
+ cp -r "$directory_to_watch"/* "$DEV_DIR"
+done