Overview

The Sdk module (CS2Kit::Sdk) provides typed wrappers around HL2SDK interfaces, abstracting away raw pointer manipulation and engine-specific details.

GameInterfaces

Centralized holder for all SDK interface pointers. Automatically populated by CS2Kit::Initialize() — no manual setup needed.

// After CS2Kit::Initialize(), all interfaces are available:
auto& gi = CS2Kit::Sdk::GameInterfaces::Instance();
auto* engine = gi.Engine;       // IVEngineServer2*
auto* cvar = gi.CVar;           // ICvar*
auto* schema = gi.SchemaSystem; // ISchemaSystem*
// ... etc.

All other Sdk classes read from this singleton internally.

GameData (Signature Management)

CS2-Kit ships built-in gamedata (gamedata/signatures.jsonc) that is automatically loaded during CS2Kit::Initialize(). The gamedata contains engine signatures and offsets used internally by Entity, PlayerController, and UserMessage subsystems.

Consumer plugins can also use GameData for their own signatures:

auto& gd = CS2Kit::Sdk::GameData::Instance();
 
// Find a raw signature address
void* addr = gd.FindSignature("CCSPlayerController_Kick");
 
// Resolve a signature with RIP-relative offset
void* resolved = gd.ResolveSignature("SomeFunction");

signatures.jsonc Format

{
    "CCSPlayerController_Kick": {
        "windows": {
            "pattern": "48 89 5C 24 ?? 57 48 83 EC 30",
            "offset": 0
        },
        "linux": {
            "pattern": "55 48 89 E5 41 54 49 89 FC",
            "offset": 0
        }
    }
}

EntitySystem

Access player controllers and entity data:

auto& es = CS2Kit::Sdk::EntitySystem::Instance();
 
// Get player controller by slot
auto* controller = es.GetPlayerController(slot);
 
// Check if a slot is valid
bool valid = es.IsPlayerSlotValid(slot);
 
// Read player button state
uint64_t buttons = es.GetPlayerButtons(slot);

PlayerController

Typed wrapper around CCSPlayerController providing common operations:

CS2Kit::Sdk::PlayerController player(controllerPtr);
 
int health = player.GetHealth();
int team = player.GetTeam();
 
player.Kick("Cheating");
player.Slay();
player.ChangeTeam(3);  // CT
player.Respawn();

Visibility

SetVisible toggles transparency on the player pawn body. Weapons, gloves, and grenades stay visible — CS2 routes those through systems a server plugin can't reach (the client-side glow/render pipeline), and there is currently no known server-side path to hide them.

player.SetVisible(false);          // body fully invisible (alpha = 0)
player.SetVisible(false, 0x80);    // body 50% transparent
player.SetVisible(true);           // restore opaque

Observer mode

Read or force a player into a specific spectator mode:

using CS2Kit::Sdk::ObserverMode_t;
 
if (player.GetObserverMode() != static_cast<int>(ObserverMode_t::Roaming))
    player.SetObserverMode(static_cast<uint8_t>(ObserverMode_t::Roaming));

Player name

Read/write m_iszPlayerName on the controller. SetPlayerName truncates to 127 characters and issues NetworkStateChanged so the scoreboard re-syncs:

auto saved = player.GetPlayerName();
player.SetPlayerName("");        // hide on scoreboard
// ... later
player.SetPlayerName(saved);

EntityRender

Mutate m_nRenderMode and m_clrRender on any CBaseModelEntity. Used internally by PlayerController::SetVisible, but exposed so plugins can hide/recolor any entity (props, dropped weapons, world objects).

using namespace CS2Kit::Sdk;
 
SetEntityRender(prop, RenderMode_t::TransTexture, ColorInvisible);
SetEntityRender(prop, RenderMode_t::Normal, ColorOpaqueWhite);

m_clrRender is RGBA packed as (A << 24) | (B << 16) | (G << 8) | R — ColorInvisible (0x00FFFFFF) is white at zero alpha.

SchemaService

Resolves entity field offsets at runtime using CS2's schema system. Results are cached:

auto& schema = CS2Kit::Sdk::SchemaService::Instance();
 
// Get field offset
int32_t offset = schema.GetOffset("CCSPlayerPawn", "m_iHealth");
 
// Use with entity pointer
int health = *reinterpret_cast<int*>(reinterpret_cast<uintptr_t>(pawn) + offset);

SigScanner

Low-level byte-pattern scanning for finding functions in memory:

using namespace CS2Kit::Sdk;
 
// Find a pattern in a module
void* addr = SigScanner::FindPattern(
    moduleBase, moduleSize,
    "48 89 5C 24 ?? 57 48 83 EC 30"
);
 
// Resolve a RIP-relative address
void* target = SigScanner::ResolveRelativeAddress(addr, 3, 7);

Wildcard bytes are represented as ?? in pattern strings.

ConVarService

Read and write ConVars with type safety:

auto& cvars = CS2Kit::Sdk::ConVarService::Instance();
 
// Read a convar value
auto value = cvars.GetValue<float>("sv_gravity");
 
// Set a convar value
cvars.SetValue("sv_gravity", 400.0f);
 
// Listen for changes
cvars.OnChange("sv_cheats", [](const std::string& name) {
    // Handle convar change
});

GameEventService

Create, fire, and listen for game events:

auto& events = CS2Kit::Sdk::GameEventService::Instance();
 
// Listen for player death
events.AddListener("player_death", [](IGameEvent* event) {
    int attacker = event->GetInt("attacker");
    int victim = event->GetInt("userid");
    // Handle event
});

MessageSystem

Send chat and center-HTML messages to players:

auto& msg = CS2Kit::Sdk::MessageSystem::Instance();
 
// Send chat message to a specific player
msg.SendChat(slot, "Hello, player!");
 
// Send center HTML to a player
msg.SendCenterHtml(slot, "<b>Important Notice</b>");
 
// Clear center HTML
msg.ClearCenterHtml(slot);

ChatInputCapture

Per-slot pending-prompt registry that backs the menu system's free-text CS2Kit::Menu::InputOption. Use it directly when you need a prompt outside of a menu (e.g. a chat command that asks the player to type a value as a follow-up).

auto& capture = CS2Kit::Sdk::ChatInputCapture::Instance();
 
capture.BeginCapture(slot, "Enter your nickname:",
    [](int s, std::string_view text) -> bool {
        if (text.size() > 32) return false;        // re-prompt
        StoreNickname(s, std::string(text));
        return true;                                // accept
    },
    /*timeoutMs=*/30000);

The validator returns true to accept the input (capture clears) or false to re-prompt the player. The capture auto-cancels after timeoutMs of no input.

Plumbing the chat hook

CS2Kit cannot install its own chat hook because suppressing a chat broadcast must happen inside the plugin's Hook_DispatchConCommand (or equivalent SourceHook hook on say / say_team). The plugin is expected to call CS2Kit::Sdk::ChatInputCapture::TryConsume before its own command parsing and supersede the broadcast when it returns true:

// Inside your plugin's chat hook, after extracting the message:
if (CS2Kit::Sdk::ChatInputCapture::Instance().TryConsume(slot, message))
    RETURN_META(MRES_SUPERCEDE);   // capture handled it; don't broadcast

If no capture is pending for slot, TryConsume returns false and the message falls through to your normal chat handling.

API

Method	Description
`BeginCapture(slot, prompt, callback, timeoutMs = 30000)`	Start waiting for `slot`'s next chat line. Replaces any previous pending prompt for the same slot.
`IsCapturing(slot)`	`true` if `slot` has a pending prompt.
`TryConsume(slot, text)`	Route a chat line to the active prompt. Returns `true` when the message was consumed.
`CancelCapture(slot)`	Drop the pending prompt without firing the callback.
`GetPrompt(slot)`	Returns the active prompt string (used by `MenuRenderer` to draw the overlay), or `nullptr`.
`OnPlayerDisconnect(slot)`	Lifecycle hook — called automatically by `CS2Kit::OnPlayerDisconnect`.

Table of Contents