MatchZy Documentation

MatchZy is a plugin for Counter-Strike 2 (CS2) designed to manage practice sessions, pugs, scrims, and competitive matches. It provides a suite of commands for match control, automated demo recording, and statistical tracking.

Key Capabilities:

• Match Modes: Supports Pug mode, Practice mode, and competitive formats like BO1, BO3, and BO5 (including Veto support).
• Match Control: Commands for readiness (!ready, !unready), match state (!pause, !unpause, !stop), and tactical adjustments (!tac).
• Practice Mode Commands: Includes .bot, .spawn, .ctspawn, .tspawn, .nobots, .rethrow, .last, .timer, .clear, and .exitprac.
• Automated Demo Management: Automatically starts and stops demo recording (requires tv_enable 1) and can automatically upload demos to a specified URL at the end of a map.
• Statistics & Data: Stores match data in a local SQLite database (MySQL also supported) and generates detailed CSV files for player statistics.
• Gameplay Features: Knife rounds with specific win logic (player count > HP advantage > random), coaching systems, damage reports after every round, and round restore support.

MatchZy includes several key features for server administrators and match organizers:

• Match Management: Pug mode with simple commands, support for BO1/BO3/BO5 formats, Veto support, and Get5 Panel integration.
• Practice Mode: A suite of commands including .bot, .spawn, .ctspawn, .tspawn, .nobots, .rethrow, .last, .timer, .clear, and .exitprac.
• Automated Recording: Automatically starts and stops demo recording (requires tv_enable 1) and can automatically upload demos to a specified URL at the end of a map.
• Gameplay Features: Knife rounds with specific win logic (player count > HP advantage > random), coaching system, and round-based damage reports.
• Administration: Player whitelisting, admin role creation, and access control for admin commands.
• Statistics: Stores match data in a local SQLite database (MySQL is also supported) and generates detailed CSV files for player stats per match.

MatchZy provides a set of commands to manage match flow, player readiness, and tactical pauses. Most commands can be prefixed with either a dot (.) or an exclamation mark (!).

Player Readiness

• .ready or .r: Marks the player as ready.
• .unready, .ur, or .notready: Marks the player as unready.
• .forceready: Force-readies a player's entire team (only works with JSON or Get5 match setups).
• .readyrequired <number> (Admin): Sets how many players must be ready to start the match. Setting this to 0 requires all connected players to ready up.

Match Flow and Pausing

• .pause or .tech: Pauses the match during freeze time. The type of pause (tactical vs. normal) depends on the matchzy_use_pause_command_for_tactical_pause setting.
• .unpause: Requests an unpause. Both teams must type .unpause to resume.
• .tac: Starts a tactical timeout.
• .stop: Restores the backup of the current round. Both teams must type .stop to trigger the restoration.
• .stay: For knife round winners to stay on the same side.
• .switch or .swap: For knife round winners to switch sides.
• .coach <side>: Starts coaching for a specific side (e.g., .coach t for Terrorists).
• .uncoach: Leaves the coaching slot.

!ready
!unpause
.coach t

MatchZy uses JSON configuration files to host series, lock players to specific teams/sides, set maps, and configure game rules. You can load these configurations using two different commands:

1. Local File: Use matchzy_loadmatch <filepath> to load a JSON file located relative to the csgo directory.
2. Remote URL: Use matchzy_loadmatch_url <url> [header name] [header value] to fetch a JSON configuration via an HTTP(S) GET request. If you need to provide authentication or custom headers, include the header name and value as arguments.

Note: All arguments for the URL command should be enclosed in quotation marks ("").

If you wish to use MatchZy for practice, scrims, or pugs without a formal match setup, ensure the server variable matchzy_kick_when_no_match_loaded is set to false.

# Load a local file from the csgo directory
matchzy_loadmatch astralis_vs_navi_27.json

# Load a remote JSON configuration via URL
matchzy_loadmatch_url "https://<url>/astralis_vs_navi_27.json"

# Load a remote URL with a custom header
matchzy_loadmatch_url "https://<url>/match.json" "Authorization" "Bearer <token>"

To install MatchZy, you must first ensure that Metamod and CounterStrikeSharp (CSSharp) are installed on your CS2 dedicated server.

Prerequisites

1. Install Metamod: Follow the Metamod installation guide.
2. Install CounterStrikeSharp (CSSharp):
   • Download counterstrikesharp-with-runtime from the CounterStrikeSharp releases page.
   • Note: You can skip this step if you use the MatchZy CSSharp release.
   • Extract the addons folder to the csgo/ directory of your dedicated server. The csgo/addons directory should contain both the counterstrikesharp and metamod folders.
   • Windows Users: You must use the Windows build of counterstrikesharp available on the CSSharp releases page.
   • Verification: Type meta list in the server console. You should see CounterStrikeSharp plugin by Roflmuffin listed.

MatchZy Installation

1. Download the latest MatchZy release.
2. Extract the files into the csgo/ directory of your dedicated server.
3. Verification: Type css_plugins list in the server console. You should see MatchZy by WD- listed.

# Verify Metamod/CSSharp installation
meta list

# Verify MatchZy installation
css_plugins list