Skip to content

feat(cs2server): add MatchZy mod - #5088

Merged
dgibbs64 merged 2 commits into
GameServerManagers:developfrom
borzaka:feat/cs2-matchzy-mod
Oct 31, 2026
Merged

dgibbs64 merged 2 commits into
GameServerManagers:developfrom
borzaka:feat/cs2-matchzy-mod

Conversation

@borzaka

@borzaka borzaka commented Oct 18, 2026

Copy link
Copy Markdown
Contributor

Description

Add MatchZy to the Counter-Strike 2 mods, so it can be installed, updated and removed with mods-install, mods-update and mods-remove.

  • Add matchzy using the plugin-only archive (MatchZy-<version>.zip) of the latest GitHub release. The with-cssharp archives are skipped, because CounterStrikeSharp is its own mod in LinuxGSM.
  • Require LinuxGSM-managed counterstrikesharp before installing MatchZy.
  • Update with OVERWRITE: since MatchZy 0.9.2 (Add override CFGs for every MatchZy CFG shobhit-pathak/MatchZy#420) custom settings go in cfg/MatchZy/<name>_override.cfg, which releases don't contain. Updates refresh the shipped CFGs and leave the override CFGs alone. admins.json, database.json, savednades.json, whitelist.cfg (not shipped since 0.9.0) and the SQLite matchzy.db are kept as well.
  • Keep the shared addons/counterstrikesharp, addons/counterstrikesharp/gamedata and addons/counterstrikesharp/plugins directories when removing MatchZy. Without this, removing MatchZy would delete CounterStrikeSharp's gamedata.json and every other CounterStrikeSharp plugin.

Removing MatchZy deletes cfg/MatchZy (including the override CFGs) and addons/counterstrikesharp/plugins/MatchZy (including matchzy.db), the same way other mods remove their configs and data. Demos, MatchZyDataBackup and round backups outside these directories are kept.

Anyone who edited the shipped CFGs directly needs to move those settings to the matching _override.cfg, otherwise mods-update overwrites them.

Related to #4683 (adds MatchZy; CS2-SimpleAdmin is still open)

Affected servers: cs2

Type of change

  • Bug fix (a change which fixes an issue).
  • New feature (a change which adds functionality).
  • New Server (new server added).
  • Refactor (restructures existing code).
  • Chore (CI, workflows, tooling or other maintenance).
  • Comment update (typo, spelling, explanation, examples, etc).

Testing

  • Commands/tests run:
    • shellcheck and bash -n on the changed modules.
    • prettier --check with prettier-plugin-sh, installed the same way as in action-prettier.yml.
    • Simulated install, update and remove using the real mods_core.sh functions and the MatchZy 0.9.2 release archive, with CounterStrikeSharp and another CounterStrikeSharp plugin already installed.
    • Ran the release asset filter against the latest release, a release without a plugin-only archive (0.8.13) and a GitHub API error response.
  • Result:
    • shellcheck, bash -n and prettier --check: no issues.
    • Install: the shared CounterStrikeSharp directories are not in matchzy-files.txt.
    • Update: the shipped CFGs are replaced with the release versions; *_override.cfg, admins.json, database.json and matchzy.db are kept.
    • Remove: MatchZy is removed; CounterStrikeSharp's gamedata.json, the other plugin and server.cfg are untouched.
    • Asset filter: picks MatchZy-0.9.2.zip. When a release has no plugin-only archive or the API request fails, the URL is empty and the install stops at the download, the same as for CounterStrikeSharp.
    • Not tested on a live CS2 server.
  • Environment used (distro/version): Ubuntu 22.04.5 LTS.

Risk and rollback

  • Risk level: low - adds a new CS2 mod; existing mods are unchanged.
  • Rollback plan: remove MatchZy with ./cs2server mods-remove, or revert this change.

Breaking changes

  • No breaking changes.
  • Breaking changes included (describe below).

Documentation

  • No documentation update required.
  • User documentation update required (LinuxGSM-Docs): add MatchZy to the CS2 mods in commands/mods.md and game-servers/counter-strike-2.md.
  • Developer documentation update required (LinuxGSM-Dev-Docs).

Checklist

PR will not be merged until all steps are complete.

  • This pull request links to an issue ("Fixes", or "Related to" for a partial fix).
  • This pull request uses the develop branch as its base.
  • This pull request subject follows the Conventional Commits standard.
  • This code follows the style guidelines of this project.
  • I have performed a self-review of my code.
  • I have provided a detailed enough description of this PR.

🤖 Generated with Claude Code

- Add MatchZy using the plugin-only archive of the latest GitHub release
- Require CounterStrikeSharp before installing MatchZy
- Overwrite the shipped CFGs on mod updates: since MatchZy 0.9.2 custom
  settings go in the *_override.cfg files, which releases don't contain
- Keep shared CounterStrikeSharp directories when removing MatchZy

Related to GameServerManagers#4683

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added this to the v26.4.0 milestone Oct 18, 2026
@github-actions github-actions Bot added the type: feature New feature or request label Oct 18, 2026
@dgibbs64 dgibbs64 removed this from the v26.4.0 milestone Oct 18, 2026
@github-actions github-actions Bot added engine: source2 Issues related to source2 engine game: Counter-Strike 2 Issues related to Counter-Strike 2 labels Oct 18, 2026
@dgibbs64 dgibbs64 mentioned this pull request Oct 18, 2026
@dgibbs64 dgibbs64 added this to the v26.5.0 milestone Oct 31, 2026
@dgibbs64
dgibbs64 merged commit 5d5bd40 into GameServerManagers:develop Oct 31, 2026
15 checks passed
@dgibbs64 dgibbs64 mentioned this pull request Nov 4, 2026
dgibbs64 added a commit to GameServerManagers/LinuxGSM-Docs that referenced this pull request Nov 4, 2026
- Add MatchZy to the Counter-Strike 2 supported mods list
- Describe MatchZy and the install order on the CS2 page
- Explain that mods-update overwrites the shipped MatchZy CFGs, so custom
  settings go in the *_override.cfg files
- Warn that mods-remove deletes the MatchZy configs and matchzy.db

Related to GameServerManagers/LinuxGSM#5088

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Daniel Gibbs <me@danielgibbs.co.uk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

engine: source2 Issues related to source2 engine game: Counter-Strike 2 Issues related to Counter-Strike 2 type: feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants