Get5

https://splewis.github.io/get5/latest
Admin
Get5 is a standalone SourceMod plugin for CS:GO servers that automates and manages competitive...
Tokens:39,083
Snippets:168
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Get5 Scrim Match

Source: https://splewis.github.io/get5/latest/getting_started

Describes how to initiate a Get5 scrim match using console commands or chat commands. Requires server administration privileges or RCON access, and the server must be on the correct map.

```APIDOC
Command: get5_scrim
  Description: Initiates a Get5 scrim match.
  Usage: RCON or server console command.
  Context: Server must be on the correct map.

Chat Command: !scrim
  Description: Initiates a Get5 scrim match via in-game chat.
  Usage: In-game chat command.
  Context: Requires server administrator privileges.
```

--------------------------------

### Get5 In-Game Menu (!get5) Overview

Source: https://splewis.github.io/get5/latest/getting_started

Explains the functionality of the `!get5` in-game menu, accessible by server administrators, for configuring and starting matches. It highlights the menu's ability to create and load match configuration files based on selected options, and its interaction with team and map files.

```APIDOC
Command: !get5
  Description: Accesses the in-game menu for match configuration.
  Access: Server administrators only.
  Functionality:
    - Start a match with current players.
    - Preselect teams using a 'teams file'.
    - Configure custom map pools using a 'maps file'.
  Underlying Mechanism: Creates and loads a match configuration file based on selected options.
```

--------------------------------

### Integrate Practice Mode with Get5 Scrims

Source: https://splewis.github.io/get5/latest/getting_started

Provides a configuration setting to prevent `practicemode` from being started during an active Get5 scrim match, ensuring the match completes or is cancelled first.

```APIDOC
Configuration Property: sm_practicemode_can_be_started
  Type: Integer (0 or 1)
  Description: Controls the ability to start practice mode.
  Recommended Value: 0
  Location: cvars section of scrim match configuration (e.g., scrim_template.cfg)
  Purpose: Removes the ability to start practice mode until the Get5 match is completed or cancelled.
```

--------------------------------

### Get5 CS:GO Server Directory Structure

Source: https://splewis.github.io/get5/latest/installation

This snippet illustrates the recommended directory layout for a CS:GO game server after installing Get5, MetaMod, and SourceMod. It details the placement of core Get5 files, configuration examples, translation files, and SourceMod components, providing a visual guide for proper server setup and organization.

```Text
addons:
  - metamod.vdf
  - metamod_x64.vdf
  metamod: # (8)
  sourcemod:
    bin: # (9)
    configs:
      - admin_groups.cfg
      - admin_level.cfg
      - core.cfg
      - admin_simple.ini # (18)
      - ...
      get5:
        - example_match.cfg # (12)
        - example_match.json # (10)
        - scrim_template.cfg # (11)
      geoip:
      sql-init-scripts:
    logs: # (1)
    plugins: # (17)
      - admin-flatfile.smx
      - adminhelp.smx
      - adminmenu.smx
      - antiflood.smx
      - basebans.smx # (26)
      - basechat.smx
      - basecommands.smx
      - basecomm.smx
      - basetriggers.smx
      - basevotes.smx
      - clientprefs.smx
      - funcommands.smx
      - funvotes.smx
      - get5.smx # (2)
      disabled: # (15)
        - admin-sql-prefetch.smx
        - admin-sql-threaded.smx
        - get5_apistats.smx # (4)
        - get5_mysqlstats.smx # (3)
        - mapchooser.smx
        - nominations.smx
        - randomcycle.smx
        - rockthevote.smx
        - sql-admin-manager.smx
    translations: # (5)
      - adminhelp.phrases.txt
      - adminmenu.phrases.txt
      - get5.phrases.txt
      - ...
      da: # (6)
        - adminhelp.phrases.txt
        - adminmenu.phrases.txt
        - get5.phrases.txt
        - ...
    data: # (14)
    scripting: # (7)
      - adminhelp.sp
      - adminmenu.sp
      - swag.sp # (21)
      - get5.sp
      - get5_apistats.sp
      - get5_mysqlstats.sp
      - spcomp
      - spcomp64 # (22)
      - ...
      get5:
        - backups.sp
        - chatcommands.sp
        - ...
      include: # (20)
        - admin.inc
        - get5.inc
        - SteamWorks.inc
        - ...
    extensions: # (13)
      - bintools.ext.so
      - sdkhooks.ext.2.csgo.so
      - SteamWorks.ext.so # (19)
      - ...
    gamedata: # (16)
cfg:
  sourcemod: # (24)
    - sm_warmode_off.cfg
    - sm_warmode_on.cfg
    - sourcemod.cfg
  get5: # (23)
    - warmup.cfg
    - live.cfg
    - knife.cfg
bin: # (25)
expressions:
maps:
materials:
models:
panorama:
resource:
scenes:
scripts:
...
```

--------------------------------

### Get5 Scrim Mode Overview and Activation

Source: https://splewis.github.io/get5/latest/getting_started

Provides an overview of Get5's 'Scrim' mode, designed for team practices, and outlines four distinct methods for initiating a scrim, including menu options, configuration settings, and console commands.

```APIDOC
Scrims:
  Description: A "scrim" is defined as having a home team and anyone else on the opposing team. This feature is designed for practices where you know the Steam IDs of your own team and want to enforce team-locking, but don't know the Steam IDs of your opponents.
  Activation Methods:
    1. Using the !get5 menu and setting Team Selection Mode to Scrim.
    2. Setting scrim: true in any match configuration.
    3. Passing --scrim and your home team to --team1 with get5_creatematch.
    4. Using the get5_scrim command and the fixed scrim_template.cfg file.
```

--------------------------------

### Get5 Legacy Scrim Template Configuration

Source: https://splewis.github.io/get5/latest/getting_started

Details the legacy method of configuring scrims using `scrim_template.cfg`, including how to add team Steam IDs and manage coaches, while noting it's not the recommended approach for new users.

```APIDOC
Scrim Template (Legacy):
  Description: While this approach still works for backwards-compatibility, it is not the recommended one. New users should use the !get5 menu, get5_creatematch command, or load a normal match configuration in Scrim mode instead.
  File Location: addons/sourcemod/configs/get5/scrim_template.cfg
  Configuration:
    - Adding Team Steam IDs: You must edit the scrim template and add your team's players to the team1 section by their Steam IDs (any format works). Any user not in team1 will implicitly be set to team2.
    - Coaches in Scrims: You cannot set the 'coaches' section in a scrim template. Instead, add everyone to the 'players' section and use the '!coach' command to become a coach after joining the game. If the team is full (defined by players_per_team), additional players will automatically be moved to coach if there are available slots.
    - Player Management: You can list however many players you want (coaches, analysts, ringers, etc.). If someone on your list ends up on the other team, you can use the '!ringer' command to temporarily swap them (or to put someone not in the list on your team temporarily).
```

--------------------------------

### Get5 Menu Options and Match Schema Parameters

Source: https://splewis.github.io/get5/latest/getting_started

Documents the various options available within the `!get5` in-game menu and their corresponding parameters in the Get5 match schema. Each menu option directly influences specific aspects of the generated match configuration.

```APIDOC
Menu Option: Game Mode
  Description: Allows switching between Competitive (regular 5v5) and Wingman mode.
  Sets Schema Parameter: wingman (boolean)

Menu Option: Series Length
  Description: Sets the maximum number of maps to play in the series.
  Sets Schema Parameter: num_maps (integer)

Menu Option: Team Size
  Description: Defines the number of players each team can have, excluding coaches. This setting should match the selected Game Mode.
  Sets Schema Parameter: players_per_team (integer)
```

--------------------------------

### Get5 Overtime Configuration

Source: https://splewis.github.io/get5/latest/getting_started

Describes how to enable or disable overtime in Get5 matches by setting the `mp_overtime_enable` cvar.

```APIDOC
Overtime:
  Description: Determines if overtime is enabled or not.
  Sets: mp_overtime_enable (in cvars)
```

--------------------------------

### Get5 Match Configuration and Loading

Source: https://splewis.github.io/get5/latest/getting_started

Details how to configure and load Get5 match files, including commands for manual loading and settings for automatic loading upon player join. It references the underlying match schema.

```APIDOC
Command: get5_loadmatch
  Description: Loads a pre-configured match file.
  Usage: get5_loadmatch <path_to_config_file>

Configuration Variable: get5_autoload_config
  Description: Automatically loads a match configuration file as soon as a player joins.
  Type: boolean
  Default: false
  Usage: Set to 1 to enable, 0 to disable.
```

--------------------------------

### Get5 Team Selection Modes

Source: https://splewis.github.io/get5/latest/getting_started

Explains the different methods for configuring teams in a Get5 match, including 'Current', 'Fixed', and 'Scrim' modes, and how they affect team composition and captain selection.

```APIDOC
Team Selection Mode:
  Description: Determines how teams are selected or configured.
  Sets: scrim, team1, team2
  Options:
    1. Current:
      Description: Uses teams as-is (requires full teams on both sides). Coaches must use 'coach ct' or 'coach t'. Allows manual or random captain selection.
    2. Fixed:
      Description: Uses admin-selected teams from the menu (requires at least two teams in teams file). Captains are the first players in 'players' for each team.
    3. Scrim:
      Description: Uses the menu-selected team as the "home team" (requires at least one team in teams file). Home team captain is the first player, away-team captain is a random player.
```

--------------------------------

### Get5 Map Pool Configuration

Source: https://splewis.github.io/get5/latest/getting_started

Describes how map pools are used in Get5 for 'Manual' or 'Pick/Ban' map selection modes, and where to define additional map pools.

```APIDOC
Map Pool:
  Description: Determines which pool of maps to select from when using Manual or Pick/Ban map selection mode.
  Sets: maplist
  Configuration: Additional map pools can be defined by editing your maps file.
```

--------------------------------

### Get5 Map Selection Strategies

Source: https://splewis.github.io/get5/latest/getting_started

Details the strategies for selecting maps in a Get5 match, such as 'Manual', 'Current Map', and 'Pick/Ban', and their implications for series length and veto systems.

```APIDOC
Map Selection:
  Description: Determines the strategy used to select the map(s) to play.
  Sets: skip_veto, maplist
  Options:
    1. Manual:
      Description: The map(s) must be selected from the menu by the admin.
    2. Current Map:
      Description: Play the current map (Series Length == 1 only).
    3. Pick/Ban:
      Description: The map selection (veto) system is used.
```

--------------------------------

### Configure Get5 Scrim Template Settings

Source: https://splewis.github.io/get5/latest/getting_started

Explains how to modify scrim parameters by editing the `scrim_template.cfg` file. Settings are applied within the `cvars` section and can include any option from the match configuration schema.

```APIDOC
Configuration File: addons/sourcemod/configs/get5/scrim_template.cfg
  Section: cvars
    Description: Defines scrim-specific properties.
    Example Property: mp_match_can_clinch
      Type: Integer (0 or 1)
      Description: Controls if a match can be clinched.
      Default Value: 0 (designed for practice, disables clinching)
    Applicable Properties: Any option from the Get5 match configuration schema.
    Note: 'scrim' will always be enabled regardless of configuration.
```

--------------------------------

### Get5 Friendly Fire Configuration

Source: https://splewis.github.io/get5/latest/getting_started

Explains how to enable or disable friendly fire in Get5 matches by setting the `mp_friendlyfire` cvar.

```APIDOC
Friendly Fire:
  Description: Determines if friendly fire is enabled or not.
  Sets: mp_friendlyfire (in cvars)
```

--------------------------------

### Get5 Play All Rounds Configuration

Source: https://splewis.github.io/get5/latest/getting_started

Details how to configure Get5 to play all rounds of a match, even if a team has already won, by setting the `mp_match_can_clinch` cvar.

```APIDOC
Play All Rounds:
  Description: Determines if all rounds of the match will be played or not, even if a team has logically won.
  Sets: mp_match_can_clinch (in cvars)
```

--------------------------------

### Get5 Side Selection Strategies

Source: https://splewis.github.io/get5/latest/getting_started

Outlines the different methods for determining side selection in Get5 matches, including 'Standard', 'Always Knife', 'Team 1 CT', and 'Random' options.

```APIDOC
Side Type:
  Description: Determines the strategy for side selection.
  Sets: side_type
  Options:
    1. Standard:
      Description: The team that doesn't pick a map gets to pick a side on it (Map Selection == Pick/Ban only).
    2. Always Knife:
      Description: A knife round is always used.
    3. Team 1 CT:
      Description: Team 1 always starts CT.
    4. Random:
      Description: Sides are randomly decided.
```

--------------------------------

### Example Usage of get5_creatematch Command

Source: https://splewis.github.io/get5/latest/configuration

Demonstrates how to use the `get5_creatematch` console command to initiate a match, specifying teams by their keys as defined in the `teams.json` file. It shows examples for both direct team matchups and scrims.

```console
get5_creatematch --team1 "navi" --team2 "astralis"
```

```console
get5_creatematch --team1 "navi" --scrim "OtherTeamName"
```

--------------------------------

### Example Get5 Status JSON Output

Source: https://splewis.github.io/get5/latest/commands

An example of the JSON data returned by the `get5_status` command, illustrating the structure and typical values for a live game state, including team scores, connected clients, and map information.

```JSON
{
    "plugin_version": "0.9.4-8ef7ffa3",
    "gamestate": "live",
    "paused": false,
    "loaded_config_file": "addons/sourcemod/configs/get5/match_config.json",
    "matchid": "1743",
    "map_number": 1,
    "round_number": 14,
    "round_time": 14234,
    "team1": {
        "name": "NaVi",
        "series_score": 1,
        "current_map_score": 4,
        "connected_clients": 5,
        "ready": true,
        "side": "t"
    },
    "team2": {
        "name": "Astralis",
        "series_score": 0,
        "current_map_score": 10,
        "connected_clients": 5,
        "ready": true,
        "side": "ct"
    },
    "maps": [
        "de_dust2",
        "de_nuke",
        "de_inferno"
    ]
}
```

--------------------------------

### Get5 Teams File JSON Structure Example

Source: https://splewis.github.io/get5/latest/configuration

Provides a comprehensive example of the `teams.json` file structure. It illustrates how to define multiple teams, including their names, tags, flags, logos, and lists of players and coaches identified by their Steam IDs.

```json
{
   "navi": {
      "name": "Natus Vincere",
      "tag": "NaVi",
      "flag": "UA",
      "logo": "navi",
      "players": {
         "76561198034202275": "s1mple",
         "76561198044045107": "electronic",
         "76561198246607476": "b1t",
         "76561198121220486": "Perfecto",
         "76561198040577200": "sdy"
      },
      "coaches": {
         "76561198013523865": "B1ad3"
      }
   },
   "astralis": {
      "name": "Astralis",
      "tag": "Astralis",
      "flag": "DK",
      "logo": "astr",
      "players": {
         "76561197990682262": "Xyp9x",
         "76561198010511021": "gla1ve",
         "76561197979669175": "K0nfig",
         "76561198028458803": "BlameF",
         "76561198024248129": "farlig"
      },
      "coaches": {
         "76561197987144812": "Trace"
      }
   }
}
```

--------------------------------

### Get5 Match Setup Configuration Variables

Source: https://splewis.github.io/get5/latest/configuration

This section outlines the console variables (CVars) for configuring match setup in Get5. These settings influence how matches begin, player readiness, in-game announcements, and team-specific visual elements.

```APIDOC
get5_ready_team_tag
get5_live_countdown_time
get5_auto_ready_active_players
get5_allow_force_ready
get5_set_client_clan_tags
get5_time_to_start
get5_time_to_make_knife_decision
get5_print_damage
get5_print_damage_excess
get5_phase_announcement_count
get5_team1_color
get5_team2_color
get5_spec_color
```

--------------------------------

### Example Get5 Damage Report Output

Source: https://splewis.github.io/get5/latest/configuration

Illustrates how damage reports appear in chat based on the `get5_damageprint_format` setting, showing different scenarios for kills, assists, and damage dealt.

```Plain Text
[Get5] Team A 1 - 0 Team B
- [X] (100 in 3) to [A] (44 in 1) from Player1 (0 HP) # - Killed this player, they assisted in killing you.
- [F] (0 in 0) to [X] (56 in 2) from Player2 (0 HP)   # - Killed by this player, flash assisted in killing them.
- [-] (0 in 0) to [-] (0 in 0) from Player3 (84 HP)   # - No interaction, this player survived.
- [A] (73 in 2) to [-] (0 in 0) from Player4 (0 HP)   # - Assisted in killing this player.
- [-] (30 in 1) to [-] (0 in 0) from Player5 (0 HP)   # - Dealt damage to this player, not enough for assist.
```

--------------------------------

### Get5 Server Setup Configuration Variables

Source: https://splewis.github.io/get5/latest/configuration

This section lists the console variables (CVars) related to server setup in Get5. These variables control specific aspects of server behavior, such as identification, player kicking rules, and JSON output formatting.

```APIDOC
get5_server_id
get5_kick_immunity
get5_kick_when_no_match_loaded
get5_kick_on_force_end
get5_check_auths
get5_print_update_notice
get5_pretty_print_json
get5_autoload_config
get5_reset_cvars_on_end
get5_debug
```

--------------------------------

### Get5: Check Web Panel Availability

Source: https://splewis.github.io/get5/latest/commands

Indicates whether the Get5 web panel has been successfully installed on the system.

```APIDOC
Command: get5_web_available
Description: Indicates if the Get5 web panel has been installed.
```

--------------------------------

### Get5 Match Configuration Example (JSON)

Source: https://splewis.github.io/get5/latest/match_schema

Demonstrates a comprehensive Get5 match configuration in JSON format, including match details, team rosters, map lists, and server variables. This is the recommended format for Get5 match files, providing a structured way to define all aspects of a competitive match.

```json
{
  "match_title": "Astralis vs. NaVi",
  "matchid": "3123",
  "clinch_series": true,
  "num_maps": 3,
  "wingman": false,
  "players_per_team": 5,
  "coaches_per_team": 2,
  "coaches_must_ready": true,
  "min_players_to_ready": 2,
  "min_spectators_to_ready": 0,
  "skip_veto": false,
  "veto_first": "team1",
  "side_type": "standard",
  "spectators": {
    "name": "Blast PRO 2021",
    "players": {
      "76561197987511774": "Anders Blume"
    }
  },
  "maplist": [
    "de_dust2",
    "de_nuke",
    "workshop/1193875520/de_aztec",
    "de_inferno",
    "de_mirage",
    "de_vertigo",
    "de_ancient",
    "de_overpass"
  ],
  "map_sides": [
    "team1_ct",
    "team2_ct",
    "knife"
  ],
  "team1": {
    "fromfile": "addons/sourcemod/get5/team_navi.json"
  },
  "team2": {
    "id": "3752",
    "name": "Astralis",
    "tag": "Astralis",
    "flag": "DK",
    "logo": "astr",
    "matchtext": "Defending Champions",
    "players": {
      "76561197990682262": "Xyp9x",
      "76561198010511021": "gla1ve",
      "76561197979669175": "K0nfig",
      "76561198028458803": "BlameF",
      "76561198024248129": "farlig"
    },
    "coaches": {
      "76561197987144812": "Trace"
    }
  },
  "cvars": {
    "hostname": "Get5 Match #3123",
    "mp_friendlyfire": "0",
    "get5_stop_command_enabled": "0",
    "sm_practicemode_can_be_started": "0"
  }
}
```

--------------------------------

### Get5 Team Configuration Example (JSON)

Source: https://splewis.github.io/get5/latest/match_schema

Illustrates a separate JSON file for defining a team's details, including ID, name, tag, flag, logo, and player/coach Steam IDs. This file can be referenced by a main match configuration using the `fromfile` property, promoting reusability of team data.

```json
{
  "id": "1348",
  "name": "Natus Vincere",
  "tag": "NaVi",
  "flag": "UA",
  "logo": "navi",
  "players": {
    "76561198034202275": "s1mple",
    "76561198044045107": "electronic",
    "76561198246607476": "b1t",
    "76561198121220486": "Perfecto",
    "76561198040577200": "sdy"
  },
  "coaches": {
    "76561198013523865": "B1ad3"
  }
}
```

--------------------------------

### Example Get5 Team Configuration File

Source: https://splewis.github.io/get5/latest/match_schema

This snippet demonstrates the structure of a standalone team configuration file, typically loaded via the 'fromfile' directive in a main Get5 match configuration. It defines essential team properties such as ID, name, tag, flag, logo, and match text, along with a list of player Steam IDs and their in-game names, and a section for coaches.

```Get5 Config
"Team"
{
    "id" "1348"
    "name" "Natus Vincere"
    "tag" "NaVi"
    "flag" "UA"
    "logo" "navi"
    "matchtext" "Challengers"
    "players"
    {
        "76561198034202275" "s1mple"
        "76561198044045107" "electronic"
        "76561198246607476" "b1t"
        "76561198121220486" "Perfecto"
        "76561198040577200" "sdy"
    }
    "coaches"
    {
        "76561198013523865" "B1ad3"
    }
}
```

--------------------------------

### Define get5 Demo File Path and Naming Format

Source: https://splewis.github.io/get5/latest/configuration

These configuration variables specify where recorded demo files are stored on the server and how they are named. They support the use of dynamic substitution variables like {MATCHID} and {DATE} to create organized and unique file paths and names. A critical note is that scores will always be zero at the start of a match when the demo file is created.

```APIDOC
get5_demo_path:
  Description: The folder of saved demo files, relative to the `csgo` directory. You can use the {MATCHID} and {DATE} variables, i.e. `demos/{DATE}/{MATCHID}/`. Much like get5_backup_path, the path must not start with a slash, and must end with a slash. Required folders will be created if they do not exist.
  Default: ""
```

```APIDOC
get5_demo_name_format:
  Description: Format to use for demo files when recording matches. Do not include a file extension (`.dem` is added automatically). If you do not include the {TIME} tag, you will have problems with duplicate files if restoring a game from a backup. Note that the {MAPNUMBER} variable is not zero-indexed. Set to empty string to disable recording demos. Team scores ({TEAM1_SCORE}, {TEAM2_SCORE}) will always be zero at the time of demo creation.
  Default: "{TIME}_{MATCHID}_map{MAPNUMBER}_{MAPNAME}"
```

--------------------------------

### Get5 Match Configuration Example (KeyValue/CFG)

Source: https://splewis.github.io/get5/latest/match_schema

Presents a Get5 match configuration in the KeyValue format, typically used in `.cfg` files. This format differs from JSON by representing booleans as '0' or '1' strings and wrapping all numerical values in quotes. It also requires empty strings as values for dictionary keys like in `maplist`.

```cfg
"Match"
{
    "match_title"             "Astralis vs. NaVi"
    "matchid"                 "3123"
    "clinch_series"           "1"
    "num_maps"                "3"
    "wingman"                 "0"
    "players_per_team"        "5"
    "coaches_per_team"        "2"
    "coaches_must_ready"      "1"
    "min_players_to_ready"    "2"
    "min_spectators_to_ready" "0"
    "skip_veto"               "0"
    "veto_first"              "team1"
    "side_type"               "standard"
    "spectators"
    {
        "name" "Blast PRO 2021"
        "players"
        {
            "76561197987511774" "Anders Blume"
        }
    }
    "maplist"
    {
        "de_dust2"                      ""
        "de_nuke"                       ""
        "workshop/1193875520/de_aztec"  ""
```

--------------------------------

### Get5 Maps File Configuration and Usage

Source: https://splewis.github.io/get5/latest/configuration

Details the default location for the Get5 maps configuration file and provides an example JSON structure for defining map pools. It also shows how to use a specific map pool with the `get5_creatematch` command.

```filepath
cfg/get5/maps.json
```

```bash
get5_creatematch --map_pool "extended"
```

```json
{
   "default": [
      "de_ancient",
      "de_anubis",
      "de_inferno",
      "de_mirage",
      "de_nuke",
      "de_overpass",
      "de_vertigo"
   ],
   "extended": [
      "de_ancient",
      "de_anubis",
      "de_cache",
      "de_dust2",
      "de_inferno",
      "de_mirage",
      "de_nuke",
      "de_overpass",
      "de_train",
      "de_vertigo"
   ],
   "wingman": [
      "de_shortdust",
      "de_boyard",
      "de_chalice",
      "de_cbble",
      "de_inferno",
      "de_lake",
      "de_overpass",
      "de_shortnuke",
      "de_train",
      "de_vertigo"
   ]
}
```

--------------------------------

### Example Get5 Match Configuration Fragment

Source: https://splewis.github.io/get5/latest/match_schema

This snippet illustrates a fragment of a Get5 match configuration file. It includes a section for map pool definitions (though the opening brace is implied from context), a 'map_sides' section for specifying CT/T sides, a 'team1' section demonstrating loading team data from an external file, a detailed 'team2' definition with players and coaches, and a 'cvars' section for custom server variables.

```Get5 Config
        "de_inferno"                    ""
        "de_mirage"                     ""
        "de_vertigo"                    ""
        "de_ancient"                    ""
        "de_overpass"                   ""
    }
    "map_sides"  // Example; would only work with "skip_veto" "1"
    {
        "team1_ct" ""
        "team2_ct" ""
        "knife"    ""
    }
    "team1"
    {
        "fromfile" "addons/sourcemod/get5/team_navi.cfg"
    }
    "team2"
    {
        "id" "3752"
        "name" "Astralis"
        "tag" "Astralis"
        "flag" "DK"
        "logo" "astr"
        "matchtext" "Defending Champions"
        "players"
        {
            "76561197990682262" "Xyp9x"
            "76561198010511021" "gla1ve"
            "76561197979669175" "K0nfig"
            "76561198028458803" "BlameF"
            "76561198024248129" "farlig"
        }
        "coaches"
        {
            "76561197987144812" "Trace"
        }
    }
    "cvars"
    {
        "hostname"                       "Get5 Match #3123"
        "mp_friendlyfire"                "0"
        "get5_stop_command_enabled"      "0"
        "sm_practicemode_can_be_started" "0"
    }
}
```

--------------------------------

### Example Get5 Match Statistics Configuration File

Source: https://splewis.github.io/get5/latest/stats_system

This snippet illustrates the complete structure of a `get5_matchstats.cfg` file in KeyValues format. It includes top-level match details like series type, team information, and overall winner, followed by map-specific data such as map name, demo filename, and per-team scores. Crucially, it provides granular player statistics for each participant, covering metrics like kills, deaths, assists, damage, round performance (e.g., 1vX wins), and contribution scores.

```KeyValues
"Stats"
{
    "series_type"  "bo1"
    "team1"
    {
        "id"    "23758"
        "name"  "EnvyUs"
    }
    "team2"
    {
        "id"    "15716"
        "name"  "Fnatic"
    }
    "winner"  "team1"
    "map0"
    {
        "mapname"        "de_mirage"
        "demo_filename"  "304_map1_de_mirage.dem"
        "winner"         "team1"
        "team1"
        {
            "players"
            {
                "76561197996426755"
                {
                    "init"                "1" // internal init key, ignore this
                    "coaching"            "0" // 1 if the player is a coach
                    "name"                "xyz"
                    "kills"               "9"
                    "deaths"              "3"
                    "assists"             "5"
                    "flashbang_assists"   "2"
                    "teamkills"           "0"
                    "suicides"            "0"
                    "damage"              "945"
                    "util_damage"         "34"
                    "enemies_flashed"     "4"
                    "friendlies_flashed"  "1"
                    "knife_kills"         "0"
                    "headshot_kills"      "3"
                    "roundsplayed"        "8"
                    "bomb_defuses"        "1"
                    "bomb_plants"         "0"
                    "1kill_rounds"        "1"
                    "2kill_rounds"        "2"
                    "3kill_rounds"        "1"
                    "4kill_rounds"        "0"
                    "5kill_rounds"        "0"
                    "v1"                  "3" // 1v1s won
                    "v2"                  "2"
                    "v3"                  "1"
                    "v4"                  "0"
                    "v5"                  "0"
                    "firstkill_t"         "0"
                    "firstkill_ct"        "2"
                    "firstdeath_t"        "0"
                    "firstdeath_ct"       "2"
                    "tradekill"           "4"
                    "kast"                "8"
                    "contribution_score"  "23"
                    "mvp" "4"
                }
            }
            "score"          "5" // total rounds won
            "score_ct"       "2" // rounds won on CT
            "score_t"        "3" // rounds won on T
            "starting_side"  "3" // 3 for CT, 2 for T
        }
    }
}
```

--------------------------------

### Configure Get5 Backup File Path

Source: https://splewis.github.io/get5/latest/configuration

Sets the directory for saved backup files, relative to the `csgo` directory. Supports the `{MATCHID}` variable for dynamic path creation. Important: the path must end with a slash and not start with one. Automatic deletion is not supported when `{MATCHID}` is used.

```APIDOC
Name: get5_backup_path
Description: The folder of saved backup files, relative to the `csgo` directory. You can use the `{MATCHID}` variable, i.e. `backups/{MATCHID}/`. Required folders will be created if they do not exist.
Default: ""
```

--------------------------------

### Get5 Cvars File Configuration and Usage

Source: https://splewis.github.io/get5/latest/configuration

Details the default location for the Get5 cvars configuration file and provides an example JSON structure for defining sets of console variables. It also shows how to use a specific cvar set with the `get5_creatematch` command.

```filepath
cfg/get5/cvars.json
```

```bash
get5_creatematch --cvars "no_ff_casual"
```

```json
{
   "default": {},
   "no_ff_casual": {
      "mp_friendlyfire": 0,
      "sv_damage_print_enable": 1
   }
}
```

--------------------------------

### Get5 Game Phase Configuration File Paths

Source: https://splewis.github.io/get5/latest/configuration

Lists the default file paths for configuration files that are executed during specific game phases in Get5, such as warmup, knife round, and live competitive or wingman matches.

```cfg
cfg/get5/warmup.cfg
cfg/get5/knife.cfg
cfg/get5/live.cfg
cfg/get5/live_wingman.cfg
```

--------------------------------

### Get5 Coaching Server Requirements

Source: https://splewis.github.io/get5/latest/coaching

Details the necessary server configurations and launch parameters required to enable and manage coaching functionality within Get5, including specific console variables and match schema settings.

```APIDOC
sv_coaching_enabled:
  Description: Enables or disables the coaching system.
  Type: Integer
  Required Value: 1 (enabled)
  Reference: https://totalcsgo.com/command/svcoachingenabled

coaches_per_team:
  Description: Defines the maximum number of coaches allowed per team in the match configuration or scrim template.
  Type: Integer
  Required Value: Greater than 0
  Reference: ../match_schema#schema

-maxplayers_override:
  Description: Server launch parameter to override the default maximum player slots, ensuring enough capacity for all players, spectators, and coaches.
  Type: Launch Parameter
  Required: Must be defined and sufficient for expected client count.
  Reference: https://developer.valvesoftware.com/wiki/Maxplayers
```

--------------------------------

### Get5 Phrase File Example: Team Picked Map Translation

Source: https://splewis.github.io/get5/latest/translations

This snippet demonstrates how translation strings are structured within Get5's phrase files. It shows the English `get5.phrases.txt` entry for the 'TeamPickedMap' string, including the `#format` parameter which defines the order and types of arguments. The example illustrates how variables are injected into the translated string and how a corresponding French translation would appear.

```Get5 Phrase File
"TeamPickedMap"
{
    "#format"  "{1:s},{2:s},{3:d}" # (1)
    "en"       "{1} picked {2} as map {3}." # (2)
}

```

```Get5 Phrase File
"TeamPickedMap"
{
    "fr"  "{1} a choisi {2} comme map {3}."
}

```

--------------------------------

### Configure Get5 Live Config File Path

Source: https://splewis.github.io/get5/latest/configuration

Specifies the path to the configuration file executed when the game goes live, relative to `csgo/cfg`.

```APIDOC
get5_live_cfg:
  description: Config file executed when the game goes live, relative to csgo/cfg.
  default: "get5/live.cfg"
```

--------------------------------

### get5_auto_ready_active_players

Source: https://splewis.github.io/get5/latest/configuration

Determines whether players are automatically marked as ready if they get a kill during the warmup or map selection phase.

```APIDOC
get5_auto_ready_active_players:
  description: "Whether to automatically mark players as ready if they kill anyone in the warmup or map selection phase."
  default: 0
```

--------------------------------

### get5_print_update_notice

Source: https://splewis.github.io/get5/latest/configuration

Determines if a chat message is printed when the game goes live, indicating a new Get5 version is available. This feature requires SteamWorks to be installed.

```APIDOC
get5_print_update_notice:
  description: "Whether to print to chat when the game goes live if a new version of Get5 is available. This only works if SteamWorks has been installed."
  default: 1
```

--------------------------------

### Configure Get5 Wingman Live Config File Path

Source: https://splewis.github.io/get5/latest/configuration

Specifies the path to the configuration file executed when the game goes live in Wingman mode, relative to `csgo/cfg`.

```APIDOC
get5_live_wingman_cfg:
  description: Config file executed when the game goes live for wingman mode, relative to csgo/cfg.
  default: "get5/live_wingman.cfg"
```

--------------------------------

### Get5 Server and Admin Commands Reference

Source: https://splewis.github.io/get5/latest/commands

Console commands available to server administrators for managing Get5 matches. These commands enable loading configurations, handling backups, controlling match flow, and managing players.

```APIDOC
ServerAdminCommands:
  loadmatch(filename: string): Loads a match configuration from a file.
  loadbackup(filename: string): Loads a match backup from a file.
  loadbackup_url(url: string, header_name: string = null, header_value: string = null): Loads a match backup from a URL.
  last_backup_file(): Returns the path to the last backup file.
  loadteam(team_id: "team1" | "team2" | "spec", filename: string): Loads a team configuration.
  loadmatch_url(url: string, header_name: string = null, header_value: string = null): Loads a match configuration from a URL.
  endmatch(winning_team: "team1" | "team2" = null): Ends the current match, optionally declaring a winner.
  creatematch(parameters: object): Creates a new match with optional parameters. Example: --parameter value
  scrim(opposing_team_name: string = null, map_name: string = null, match_id: string = null): Starts a scrim match.
  addplayer(auth_id: string, team_id: "team1" | "team2" | "spec", player_name: string = null): Adds a player to a team or spectator.
  addcoach(auth_id: string, team_id: "team1" | "team2", coach_name: string = null): Adds a coach to a team.
  removeplayer(auth_id: string): Removes a player by authentication ID.
  addkickedplayer(team_id: "team1" | "team2" | "spec", player_name: string = null): Adds a player to the kicked list.
  removekickedplayer(): Clears the kicked player list.
  add_ready_time(seconds: number): Adds time to the ready-up phase.
  forceready(): Forces all players to ready up.
  status(): Displays current match status.
  listbackups(match_id: string = null): Lists available backups for a match.
  ringer(target: string): Calls a ringer for a specified player.
  dumpstats(file_path: string = null): Dumps match statistics to a file.
  debuginfo(file_path: string = null): Dumps debug information to a file.
  test(): Runs internal tests.
```

--------------------------------

### get5_veto_countdown Configuration

Source: https://splewis.github.io/get5/latest/configuration

Sets the countdown time in seconds before the map selection process begins. Setting this to zero allows the veto process to start immediately without a delay.

```APIDOC
get5_veto_countdown:
  Type: Configuration Variable
  Description: Time (in seconds) to countdown before the map selection process commences. Set to zero to move to veto without a countdown.
  Default: 5
```
Tokens:
Raw