HTTPS SSH

GOKZ SourceMod Plugins (CS:GO)

GOKZ a set of SourceMod plugins exclusively for Counter-Strike: Global Offensive servers. It implements the KZ (Kreedz) game mode, which involves speedrunning through custom maps.

Features

  • Timer - Times runs by automatically detecting the use of start and end buttons in KZ maps.
  • Movement Modes - Custom movement mechanics. Includes Vanilla, SimpleKZ, and KZTimer modes.
    • Mode plugins can be used alone (with only MovementAPI) to apply their mechanics at all times.
  • Jumpstats - Detailed statistics of your jumps and each individual air strafe.
  • Customisable Experience - Tonnes of options to provide the best possible experience for players.
  • Database Support - Store run times and more using either a MySQL or SQLite database.
    • Player options are stored using the clientprefs extension.
  • GlobalAPI Support - Submit run times to the GlobalAPI so that players may compete across servers.
  • Replays - Record replays of the server's fastest times and use bots to play them back.
  • Anti-Macro - Detect and auto-ban blatant users of bhop macros and cheats (SourceBans++ supported).
  • Map bonus support, HUD, teleport menu, noclip, !goto, !measure, !race and much, much more.

For more information about what each plugin does, please see PLUGINS.md.

Usage

Server Requirements

Installing

  • Ensure your server is up to date and meets the above requirements.
  • Download and extract GOKZ-latest.zip from Downloads to csgo.
  • Add a MySQL or SQLite database called gokz to csgo/addons/sourcemod/configs/databases.cfg.
  • When the plugins first load, various configuration files will be auto-generated and can be found in csgo/cfg/sourcemod/gokz.
  • Use sm_updatemappool to populate the ranked map pool with those in csgo/cfg/sourcemod/gokz/gokz-localranks-mappool.cfg.

Please refer to the wiki for a more detailed installation guide.

Updating

  • Minor updates - Download and extract GOKZ-latest-upgrade.zip from Downloads to csgo.
  • Major updates - Check the new version's release notes for specific instructions.

Commands

Please see COMMANDS.md for a list of player and admin commands.

Mapping

To add a timer button to a map, use a func_button with a specific name.

  • Start button is named climb_startbutton.
  • End button is named climb_endbutton.
  • Bonus start buttons are named climb_bonusX_startbutton where X is the bonus number.
  • Bonus end buttons are named climb_bonusX_endbutton where X is the bonus number.

TIP - Enable both the Don't move and Toggle flags to easily avoid any usability issues.

Contributing

GOKZ is an open-source, community-driven project. If you are interested in helping out, please see CONTRIBUTING.md for more details.

Authors

Official Wiki

Steam Group

CS:GO KZ Discord