CS2KZ

WIP, not ready for release

Requirements

• Metamod 2.0.0 build 1459 or later

• MultiAddonManager v1.6 for radio menus, layout-based HUD and KZ sound effects (eg. jumpstats)

• Optional: SQL_MM v1.3.4.3 or later for local database support

• Optional: CS2Menus for html menu support

Installation

• Download the latest version in the release section and extract them to your server's csgo/ directory.

Compilation

• Remember to recursively clone the plugin:

  git clone --recursive https://github.com/KZGlobalTeam/cs2kz-metamod.git
  

• Latest AMBuild needs to be installed for compilation.

• For each platform:

Windows (ambuild/msvc):

mkdir build
cd build
python3 ../configure.py 
ambuild

For windows debugging with VS, build the project then add the following command at the end:

python3 ../configure.py --gen=vs --vs-version 17

Linux (ambuild/clang):

mkdir build
cd build
python3 ../configure.py 
ambuild

Linux (Docker w/ Valve SDK Image):

mkdir build
docker build -t cs2kz-linux-builder .
docker run --rm -v ./build:/app/build cs2kz-linux-builder

Note: does not work with gcc!

Copy the contents of build/package/ to your server's csgo/ directory.

Project Architecture

This is a CS2 KZ Metamod C++ plugin with:

• Source code files in src directory
  • KZ related functionalities in src/kz subdirectory
    • Distinct functionalities are usually split into services in its own subdirectory (eg. src/kz/language for localization code)
  • Reverse engineered and SDK code in src/sdk subdirectory
  • General movement related code in src/movement subdirectory
  • General player related code in src/player subdirectory
• Additional SDK files are in hl2sdk-cs2/public subdirectory
• Some code is generated from protobuf files, they are located in build/cs2kz/windows-x86_64
• Config files are found in cfg and gamedata
• Localization texts are found in translations
• Third party dependencies are found in vendor
• AMBuilder is used to declare the list of translation units to add into the build. See AMBuild for more information.

Coding standards

• Follow the existing naming conventions.
• Prefer short types defined in common.h (eg. u32, u64, f32,... ) unless it is code related to reverse engineering/SDK.