Configuration

Introduction

There are three types of configurations that are relevant for PugSharp.

PugSharp Configs

The configs for PugSharp wich are located in the subfolder PugSharp/Config on your cs2 server.

Matchconfig

The matchconfig defines the current match. It is not loaded automatically, so you have to do that with one of the Admin/Rcon Commands ps_loadconfig or ps_loadconfigfile .

Matchconfig Fields

Field	DefaultValue	Description
maplist	none (required)	List of available maps for the map vote
team1	none (required)	Team declaration
team2	none (required)	Team declaration
matchid	none (required)	Unique Identifier for the match
num_maps	1	Number of Maps to be played. This should be an odd number to determine a winner.
players_per_team	5	Maximum possible number of players per team.
min_players_to_ready	5	Number of players per team that have to be ready to start the game.
max_rounds	24	Maximum number of rounds played for the main match.
max_overtime_rounds	6	Maximum number of rounds played in overtime.
vote_timeout	60000 (60s)	Timeout in milliseconds. If a team does not complete the vote within this timeout, the map with the most votes gets banned.
eventula_apistats_url	(optional)	URL where the Game State has to be sent.
eventula_apistats_token	(optional)	Optional AuthToken used to authenticate on apistats upload.
eventula_demo_upload_url	(optional)	URL to upload the game demo to eventula
g5_api_url	(optional)	URL to send the g5 events to.
g5_api_header	(optional)	Header that should be set to access the g5 events API.
g5_api_headervalue	(optional)	Header value that should be set to access the g5 events API.
allow_suicide	true	Flag to determine if players are allowed to suicide.
vote_map	de_dust2	Map used during warm-up and voting.
team_mode	0	Change how teams are defined. 0: Default (Teams are fix defined) 1: Scramble (Teams are scrambled when all players are ready)

Team Fields

Field	DefaultValue	Description
id	ULID	Id for the Team, if not defined a new ULID will be generated
name	none (required)	The Teamname
tag	none (required)	Currently not used
flag	DE (required)	The flag that is displayed
players	none	The List of Players (SteamID and Username). If defined only the given players can join the match.

Matchconfig Example

{
  "maplist": ["de_vertigo", "de_dust2", "de_inferno", "de_mirage", "de_nuke", "de_overpass", "de_ancient"],
  "team1": {
    "id": "1",
    "name": "hallo",
    "tag": "hallo",
    "flag": "DE",
    "players": {
      "12345678901234567": "Apfelwurm",
      "12345678901234568": "strange name"
    }
  },
  "team2": {
    "id": "2",
    "name": "asd",
    "tag": "asd",
    "flag": "DE",
    "players": {
      "12345678901234569": "BOT R00st3r",
      "76561198064576360": "heatwave"
    }
  },
  "matchid": "40",
  "num_maps": 1,
  "players_per_team": 2,
  "min_players_to_ready": 2,
  "max_rounds": 24,
  "max_overtime_rounds": 6,
  "vote_timeout": 60000,
  "eventula_apistats_url": "https://dev.lan2play.de/api/matchmaking/40/",
  "eventula_apistats_token": "Bearer S0XRU0UhIExFQ0tFUiEK",
  "eventula_demo_upload_url": "https://dev.lan2play.de/api/matchmaking/40/demo",
  "vote_map": "de_inferno",
  "server_locale": "en"
}

Serverconfig

The Serverconfig defines server wide PugSharp settings for your server. It is loaded automatically when PugSharp is loaded.

Location: /game/csgo/PugSharp/Config/server.json

Serverconfig Fields

Field	Default	Description
locale	en	This is the language that will be used for the messages that are printed to the users
allow_players_without_match	true	Defines if players can join the server when no match is loaded.

Serverconfig Example

{
    "locale": "en",
    "allow_players_without_match": true
}

CounterstrikeSharp Configs

For the administration permissions, we are using the CounterstrikeSharp admin framework . Currently all Admin/Rcon Commands are using the permission @pugsharp/matchadmin

CS2 Server Configs

The sample configs for the CS2 Server itself wich are located in the subfolder cfg/PugSharp on your cs2 server.

Config	Execution point in time
warmup.cfg	this config is loaded on every warmup in the game (pre Vote/ Vote / pre ready)
live.cfg	this config is loaded on the start of the actual game