Modules

typed access to the plugin's materialized config.

Injected console logging for plugins.

`@s2script/sdk/contracts/workshop` — the standard contract for a **workshop / UGC** plugin. TYPE-ONLY. The framework ships no implementation: subscribing to, downloading and mounting UGC is a Steam-services concern, not a Source 2 engine touchpoint. A community plugin implements this and publishes it; consumers depend on the one agreed shape. See `contracts/README.md`. Engine-generic on purpose — every Source 2 title has workshop content, so nothing here is CS2-specific. Game-specific economy lives in `@s2script/cs2/econ`. @example import type { WorkshopService } from "@s2script/sdk/contracts/workshop"; const ws = ctx.tryUse<WorkshopService>("workshop"); if (ws) { const map = await ws.currentMap(); console.log(map ? `${map.title} (${map.id})`: "not a workshop map"); }

Call or detour an engine function the framework does not wrap, declared in your own gamedata. Validated at load and degraded to null on failure — requires a manifest permission (`engine:calls` or `engine:hooks`) and an operator allow-list entry.

Liveness-gated EntityRef handles, typed reads/writes, create/spawn/teleport/remove, and entity I/O.

Producer-as-import and use / tryUse proxies for typed, versioned cross-plugin interfaces. Events are ledgered forwards (`on`, no `off`).

Vector and QAngle value types plus helpers like forwardVector.

Load-window authoring: `hook` (game-event catalog: hook.on / hook.onPre), previous(), pluginId(), publish / use, onOutput, createScope, Scope. The artifact is export function OnPluginStart (plus optional named publics).

runtime plugin management (the SM `sm plugins` backend).

Tick-integrated async timing: delay, nextTick, nextFrame, threadSleep.

who can hear whom.

engine-generic client handle + lifecycle events. Resolved at runtime via globalThis.__s2pkg_clients. Import: import { Client, Clients } from "./clients";

Block-scoped DamageInfo view of a live damage event. Subscribe with SDKHook — not a global mux.

Typed game-event bus: fire / fireToClient, HookResult, and the block-scoped GameEvent accessor.

Per-entity SDKHook / SDKUnhook (SourceMod-shaped). OnTakeDamage; SetTransmit AND-merges with Transmit.setVisibleTo; lifecycle virtuals (Spawn, Think, Use, …).

engine-generic sound: emit a named SoundEvent + register custom precache paths.

Ray / line / hull traces returning a liveness-gated hit entity.

Declarative per-client visibility masks. AND-merges with SDKHookType.SetTransmit — either API can hide; SetTransmit cannot un-hide a native mask clear.

a SourceMod `OnPlayerRunCmd`-equivalent: intercept, read, modify, and block a player's per-tick input (buttons, view angles, movement, impulse) before the game processes it.

A general protobuf user-message builder.

engine-generic admin flag model + cache API. Resolved at runtime via `globalThis.__s2pkg_admin`; no game-specific symbols. Import: `import { ADMFLAG, Admin } from "./admin";`

engine-generic SteamID64 ban store + bans.json persistence. Resolved at runtime via `globalThis.__s2pkg_bans`; no game-specific symbols. Import: `import { Bans } from "./bans";` The store is host-global in core, populated from `addons/s2script/configs/bans.json` via the config bridge. Enforcement is JS-driven: a ban plugin (e.g. @s2script/basebans) registers a `Clients.onConnect` handler that looks a connecting SteamID64 up here and, if banned, shows the reason then kicks (`Client.kickWithReason`) — a banned player is admitted, shown their reason, and kicked, not instant-rejected. A 3rd-party ban system registers its own onConnect against its own store.

print messages to player chat.

Load-window `command()` / `command.admin` / `command.server`. `Command` is an alias for `CommandInvocation`. Owned handlers return `HookResult.Handled`.

interactive player menus (chat + center backends).

Server.command, cvars, and map validity. Map start is the named public `OnMapStart`.

the extensible admin/top menu registry.

SourceMod-style i18n (per-client language, phrase files, {1} formatting).

chat-ballot voting with revote + an optional live center tally.

SM-parity client preference cookies.

engine-generic async SQLite database.

async HTTP.

engine-generic raw TCP + UDP sockets (binary), off the game thread.

client WebSocket.

CS2 player/pawn model, schema accessors, typed events overlay, menus, ui, and Fade/Shake/HintText.

Custom Panorama HUD: ui.components() (modals, badges, toasts) and the ui.hud() primitive.