CS2 Whitelist
July 11, 2026 ยท View on GitHub
Metamod: Source plugin for CS2 server whitelisting.
Restricts server access to a list of Steam Group memebers, SteamIDs and IP addresses defined in a text file or in a database.
Usage
Requirements
- Dedicated CS2 Server. (Recommended to use SteamRT3 Docker)
- Metamod: Source 2.0.
- (Optional) sql_mm plugin.
- (Optional) MySQL Database.
- (Optional) mm-cs2admin plugin.
Installation
- Install the dependencies.
- Download the latest release and extract it in your server's root folder (
~/game/csgo/) - Configure the core config file in
/cfg/cs2whitelist/core.cfg. - Create a new file or rename the .example to
whitelist.txtand add your selection of user's IDs/IPs to the file. (Alternatively) Configure your whitelist via the commands, or by directly modifying the database.
Configuration
cfg/cs2whitelist/whitelist.txt - one entry per line:
Supported entry types:
| Format | Example |
|---|---|
| Steam2 SteamID | STEAM_0:1:12345678 |
| SteamID64 | 76561198012345678 |
| IPv4 address | 192.168.1.100 |
| Steam group ID64 | 103582791429521408 |
| Steam group ID32 | 42850207 |
ConVars
| ConVar | Default | Description |
|---|---|---|
mm_whitelist_enable | 1 | Enable (1) or disable (0) the whitelist. |
mm_whitelist_immunity | 1 | Skip the check for players with any cs2admin flag. |
mm_whitelist_filename | whitelist.txt | File name inside cfg/cs2whitelist/. |
mm_whitelist_log | 0 | Log failed join attempts. 0 = off, 1 = always, 2 = once per player per map. Logs to console and addons/cs2whitelist/logs/YYYY-MM-DD.log. |
Admin commands
All commands require mm-cs2admin for in-game use. Without it, commands can only be issued from the server console.
See COMMANDS for more.
Build
Prerequisites
- This repository is cloned recursively (ie. has submodules)
- python3
- ambuild, make sure
ambuildis in yourPATH - MSVC (VS build tools) on Windows / Clang on Linux
AMBuild
mkdir -p build && cd build
python3 ../configure.py --enable-optimize
ambuild
Credits
Contributing
Feel free to create PRs or issues regarding anything, but keep in mind that this is very much just for fkz and I won't spend time adding features I won't use.