This is a useful plugin for managing pug games, especially 10 mans/gathers. It allows a player to type .setup into chat and select (from a menu):
- how to choose the teams (players do it manually, random teams, captains select teams)
- how to choose the map (use the current map, do a map vote using maps from addons/sourcemod/configs/pugsetup/maps.txt)
The goal is to allow a lightweight, easy-to-use setup system that automates as much as possible with as few dependencies as possible. However, the goal isn't fully automated - it assumes the players know each other or there is an admin. There is no mechanism for kicking players or anything similar.
Part of being lightweight is doing nothing that can interfere with the server's performance. When the game is actually live, the plugin is doing extremely little work - the only thing it does is read chat commands (e.g. pausing when a captain types .pause). Otherwise, there is 0 effect on gameplay and the rounds progress the same as without sourcemod on the server. This is in contrast to the WarMod plugin or what ESEA servers use, where they are tracking the overall score, overriding the in-game warmup period, etc.
The goal is to make setup easier for people, not provide a comprehensive pug platform. Please keep this and the principle of keep it simple, stupid in mind when making any suggestions.
- Goonpug (very similar to this plugin, but with more features - and more dependencies)
- PUG Mod (relatively plain - but no captain selection)
- WarMod (does pretty much everything - can be difficult to configure, heavyweight)
You should be able to get the most recent download from https://github.com/splewis/csgo-pug-setup/releases.
There is a notion of the the pug/game "leader". This is the player that writes .setup first and goes through the setup menu. The leader has elevated permissions and can use some extra commands (e.g. pause). To prevent some abuse there is also an admin command sm_leader to manually change the leader.
Generally, here is what happens:
- A player joins and types .setup and goes through the menu to select how the teams and map will be chosen
- Other players join and all type .ready
- If the leader setup for a map vote, the map vote will occur and the map will change, then all players will type .ready on the new map
- If the leader setup for a captain-style team selection, the game will wait for when 2 captains are selected, then the captains will be given menus to chose players
- Then, either by the leader typing .start or the game auto-living (which is also configurable), the game will initiate a live-on-3 restart and go
Download pugsetup.zip and extract the files to the game server. From the download, you should have installed the following (to the csgo directory):
addons/sourcemod/plugins/pugsetup.smxaddons/sourcemod/configs/pugsetup/(the entire directory)addons/sourcemod/translations(the entire directory)cfg/sourcemod/pugsetup(the entire directory)
csgo/addons/sourcemod/plugins/pugsetup_teamnames.smx is an optional plugin that lets you set team names associated with players. It's just for fun. See its description at the end of the readme.
As of 1.3.0, sourcemod 1.7 is required. If you must use sourcemod 1.6, I'd suggest trying an older version.
Once all of these are on the server, it should just work. If you want to tweak the configs or maplists read on.
One of the files you should have downloaded was csgo/addons/sourcemod/configs/pugsetup/gametypes.cfg:
"GameTypes"
{
// Configs are relative to the csgo/cfg/sourcemod/pugsetup directory
// Maplists are relative to the csgo/addons/sourcemod/configs/pugsetup directory
"Normal"
{
"config" "standard.cfg"
"maplist" "standard.txt"
}
}
This file specifies different "game types", which are just combonations of a cfg file and a map list. You can add more sections if you want, and the .setup menu will contain a page to choose which option. Otherwise, if there is only 1 game type, that one will always be used.
To create a new game type, add a section to the gametypes.cfg file, create the .cfg file in csgo/cfg/sourcemod/pugsetup, and create a maplist in csgo/addons/sourcemod/configs/pugsetup.
One use of this is to have different rule sets. For example, I like playing 2v2's on more maps (we generally use the map veto option), so I create a new section like so:
"GameTypes"
{
"Normal"
{
"config" "standard.cfg"
"maplist" "standard.txt"
}
"2v2"
{
"config" "standard.cfg"
"maplist" "2v2maps.txt"
}
}
And then I create a new maplist csgo/addons/sourcemod/configs/pugsetup/2v2maps.txt:
de_aztec
de_cache
de_cbble
de_dust
de_dust2
de_inferno
de_mirage
de_nuke
de_overpass
de_train
workshop/125689191/de_season_rc1
workshop/144923022/de_contra_b3
workshop/201811336/de_toscan
workshop/239672577/de_crown
workshop/267340686/de_facade
When creating configs, realize that CS:GO's standard competitive config (csgo/cfg/gamemode_competitive.cfg) will be executed first. Two example deathmatch-style configs (good for aim maps) are included as examples, csgo/cfg/sourcemod/pugsetup contains awp.cfg and ak.cfg.
You need to enable gotv to use the demo-recording feature. Adding the following to your server.cfg will work:
tv_enable 1
tv_delaymapchange 1
tv_delay 45
tv_deltacache 2
tv_dispatchmode 1
tv_maxclients 10
tv_maxrate 0
tv_overridemaster 0
tv_relayvoice 1
tv_snapshotrate 20
tv_timeout 60
tv_transmitall 1
Of course, you can tweak the values.
Note: before the plugin executes the game-type config (by default cfg/sourcemod/pugsetup/standard.cfg), it execute the game's
default competitive config (cfg/gamemode_competitive.cfg). This is meant to provide a consistent base for cvars, but you should be aware of it.
For example: tv_delay will get set to 105, so if you want it lower you must also set it in your gammeode config.
Some commands that are important are:
- !setup, begins the setup phase and sets the pug leader
- !start, begins the game (note that the cvar sm_teamselect_autolo3 controls if this is needed
- !ready
- !unready
- !pause
- !unpause
- !capt gives the pug leader a menu to select captains
- !rand selects random captains
- !leader gives a menu to change the game leader
- !endgame, force ends the game safely (only the leader can do this, note that this resets the leader to nobody)
You can also type .start instead of !start, or .ready instead of !ready.
The ! style commands will let you use arguments; for example: !capt player1 player2 works, while using .capt will just open a menu for you to pick players.
These are some helper commands for automation purposes the bypass requiring a player to press any menus:
- sm_10man (this just uses the first game type from
gametypes.cfg) - sm_forceend
Generally you don't need the admin (sm_) commands, but they may come in helpful if a captain/leader doesn't know about the .pause feature or you need to take leardership of the pug.
There is some limited extension support in the form of some natives and forwards. See pugsetup.inc.
An example of these in use is in pugsetup_teamnames.sp.
If you want something custom made, feel free to contact me. Depending on the complexity of the task, it may or may not be free.
Some examples of custom things I have are:
- plugin to freeze players in place when not ready and enough players are on the server
- plugin to upload demo files when games are finished
These are put in an autogenerated file at cfg/sourcemod/pugsetup.cfg, once you start the plugin go edit that file if you wish. These are just some important ones, check the file for more.
- sm_pugsetup_warmup_cfg should store where the warmup config goes, defaults to the included file
sourcemod/pugsetup/warmup.cfg) - sm_pugsetup_autorecord controls if the plugin should autorecord a gotv demo (you may need to add some extra cvars to your cfgs, such as tv_enable 1)
- sm_pugsetup_requireadmin controls if an admin flag ("g" for change map permissions) is needed to use the setup command
- sm_pugsetup_autokicker_enabled controls if the autokicker is enabled. The autokicker will only kick clients when the game is live and all the spots are taken.
(Using the included pugsetup_teamnames.smx plugin)
Just for fun, I added support to automatically set mp_teamname_1 and mp_teamflag_1 (and 2). Here's how it works
- you run the sm_name command in console to associate a player with a team name and flag (example:
sm_name splewis "splewises terrible team1" "US") - when the game goes live, the plugin picks a name/flag randomly from the players on the team
- when running the sm_name command, the syntax is:
sm_name <player> <teamname> <teamflag> - note that the team flags are the 2-letter country codes
- the team names/flags are stored using the clientprefs API, so a database for clientprefs must be set (by default SQLite is used)