📖 English 📖 简体中文(大陆)

🎮 ✨ 🚀 💬 qwqCounterStrikeSharpPlugin

A Counter-Strike 2 server plugin. Type qwq in chat for a qwq! reply. When a human player joins, everyone sees qwq！！！; when a human player leaves, everyone sees qwq......

Built on CounterStrikeSharp, written in C# (.NET 10).

🏃 💨 🔜 Quick Start

📦 🔧 Deploy to Server

1. Install Metamod:Source
   See https://cs2.poggu.me/metamod/installation/
   Download the Linux build and extract to the csgo/ directory

   Structure after extraction:

   csgo/addons/
   └── metamod/
   

2. Install CounterStrikeSharp
   Download the with-runtime release
   Merge the addons/ folder into csgo/

   Structure after merging:

   csgo/
   └── addons/
     ├── metamod/
     └── counterstrikesharp/
         ├── api/
         ├── dotnet/
         └── plugins/
   

3. Add the Plugin CSS requires plugins in plugins/<PluginName>/<PluginName>.dll (directory name = DLL filename). Download the .dll from Releases:

   # Default Steam path is usually under ~/.local
   cd "path/to/Steam/steamapps/common/Counter-Strike Global Offensive/game"
   TAG=<latest version tag>
   PLUGIN_DIR=csgo/addons/counterstrikesharp/plugins/qwqCounterStrikeSharpPlugin
   mkdir -p $PLUGIN_DIR
   cd $PLUGIN_DIR
   wget "https://github.com/VincentZyuApps/qwqCounterStrikeSharpPlugin/releases/download/$TAG/qwqCounterStrikeSharpPlugin-$TAG.dll"
   mv qwqCounterStrikeSharpPlugin-$TAG.dll qwqCounterStrikeSharpPlugin.dll
   

   Final plugin structure:

   plugins/
   └── qwqCounterStrikeSharpPlugin/
       └── qwqCounterStrikeSharpPlugin.dll
   

4. Start the Server

   ./cs2 -dedicated -game csgo +map de_dust2 +sv_lan 1
   

   You should see Finished loading plugin qwq CounterStrikeSharp Plugin in the console.

5. Test In-Game
   Type qwq in chat → you'll see a green qwq! reply. When a human player joins → everyone sees qwq！！！ in the lower-left chat area; when a human player leaves → everyone sees qwq..... there.

📋 My deployment notes

🤖 ⚙️ 🔄 GitHub Actions

When pushing to GitHub, keywords in the commit message control the pipeline.
Full details in the 「Build Workflow Guide」 below.

Keyword	Build	Release
build action	✅	❌
build release	✅	✅

📋 🏗️ 🚀 Build Workflow Guide

When pushing to GitHub, keywords in the commit message control the CI/CD pipeline.

🔑 📌 Keywords Reference

Keyword	Build DLL	Publish Release
build action	✅	❌
build release	✅	✅

⚠️ No Keyword Matched

If the commit message contains none of the keywords above, the pipeline will not run, saving your Actions quota.

🏭 📊 Pipeline Stages

check ──→ build ──→ release
  │         │         │
  │         │         └── download artifact → create GitHub Release → upload zip
  │         │
  │         └── dotnet restore → dotnet build → zip → upload artifact
  │
  └── parse commit message → set control flags

🔍 Stage 1: check (parse commit)

• Read the latest commit message
• Match keywords, set should_build / should_release flags
• Extract version from <Version> in qwqCounterStrikeSharpPlugin.csproj
• Release tag format: v{version}-{run_number} (e.g. vx.y.z-k)

🛠️ Stage 2: build (compile)

• dotnet restore restore NuGet dependencies
• dotnet build -c Release compile the plugin
• Produces QwqCounterStrikeSharpPlugin.dll + .pdb packaged as qwqCounterStrikeSharpPlugin.zip
• Uploaded to Actions Artifact

🎯 Stage 3: release (publish)

• Download the artifact
• Create a Git tag with the version number
• Create a GitHub Release with the zip attached

📝 💻 Usage Examples

# Build only, no release
git commit -m "fix: fixed a bug, build action"

# Build and publish a Release
git commit -m "feat: added a new feature, build release"

📦 📄 Artifact Contents

The zip inside the Artifact / Release contains:

File	Description
QwqCounterStrikeSharpPlugin.dll	Main plugin (place in addons/counterstrikesharp/plugins/)
QwqCounterStrikeSharpPlugin.pdb	Debug symbols (optional, keep for stack trace line numbers)

🔖 🔢 Custom Version

Edit the <Version> field in qwqCounterStrikeSharpPlugin.csproj:

<Version>x.y.z</Version>

Edit the ModuleVersion string in QwqCounterStrikeSharpPlugin.cs:

public override string ModuleVersion => "x.y.z";

The next Release will automatically use vx.y.z-{run_number} as the tag.