@s2script/sdk 0.5.0 → 0.6.0

package/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2026 Gabriel Hirakawa
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gabriel Hirakawa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,10 +1,44 @@
 # @s2script/sdk
 
-The **s2script SDK** — types + CLI for building [Source 2](https://developer.valvesoftware.com/wiki/Source_2) / CS2 plugins in TypeScript.
+The **s2script SDK** — the TypeScript types and the `s2s` CLI for building
+[Source 2](https://developer.valvesoftware.com/wiki/Source_2) / Counter-Strike 2 server plugins.
 
-> **`0.0.1` is a placeholder.** This release exists only to claim the package name and bootstrap npm OIDC trusted publishing. The real content lands in **`0.1.0`**:
->
-> - Per-capability type subpaths — `import { Entity } from "@s2script/sdk/entity"`, `@s2script/sdk/math`, `@s2script/sdk/timers`, `@s2script/sdk/events`, … (the framework's standard library, consolidated from the former `@s2script/*` packages).
-> - The build CLI, exposed as the **`s2s`** command (`s2s build`; cold-start `npx @s2script/sdk build`).
+s2script is a plugin framework for Source 2 games, loaded via
+[Metamod:Source](https://www.sourcemm.net/). This package is what you develop against; the runtime
+ships with the server addon.
 
-Game-specific schema/types ship separately in `@s2script/cs2` (and future `@s2script/<game>` packages).
+## Quickstart
+
+```bash
+npx @s2script/sdk create my-plugin
+cd my-plugin
+npm run build          # → dist/<id>.s2sp
+```
+
+Copy the `.s2sp` into `addons/s2script/plugins/` on a running server and it loads immediately —
+re-drop to hot-reload, delete to unload. No restart.
+
+```ts
+import { plugin } from "@s2script/sdk/plugin";
+
+export default plugin((ctx) => {
+  ctx.commands.register("hello", (cmd) => {
+    cmd.reply("hello from s2script");
+  });
+});
+```
+
+This package is **types-only** — the engine injects the implementation at load time, and
+`s2s build` marks `@s2script/*` external rather than bundling it. Capabilities are imported as
+per-capability subpaths (`@s2script/sdk/entity`, `@s2script/sdk/timers`, `@s2script/sdk/clients`, …);
+game-specific schema types ship separately in
+[`@s2script/cs2`](https://www.npmjs.com/package/@s2script/cs2).
+
+## Docs
+
+**[s2script.com/docs](https://s2script.com/docs)** — getting started, guides, and the full API
+reference. Source and issues: [GitHub](https://github.com/s2script/s2script).
+
+## License
+
+MIT OR Apache-2.0

package/admin.d.ts

@@ -7,26 +7,43 @@
 
 /** SourceMod-parity admin flag bitmask constants (SM bit values). */
 export declare const ADMFLAG: {
+  /** Reserved-slot access (`1<<0` = 1). */
   readonly RESERVATION: number;
+  /** Generic admin — the baseline "is an admin" flag (`1<<1` = 2). */
   readonly GENERIC:     number;
+  /** May kick players (`1<<2` = 4). */
   readonly KICK:        number;
+  /** May ban players (`1<<3` = 8). */
   readonly BAN:         number;
+  /** May remove bans (`1<<4` = 16). */
   readonly UNBAN:       number;
+  /** May slay/slap players (`1<<5` = 32). */
   readonly SLAY:        number;
+  /** May change the map (`1<<6` = 64). */
   readonly CHANGEMAP:   number;
+  /** May change most convars (`1<<7` = 128). */
   readonly CONVARS:     number;
+  /** May execute config files (`1<<8` = 256). */
   readonly CONFIG:      number;
+  /** Admin-chat and other special chat privileges (`1<<9` = 512). */
   readonly CHAT:        number;
+  /** May start votes (`1<<10` = 1024). */
   readonly VOTE:        number;
+  /** May set the server password (`1<<11` = 2048). */
   readonly PASSWORD:    number;
+  /** May use rcon commands (`1<<12` = 4096). */
   readonly RCON:        number;
+  /** May change cheat convars and use cheat commands (`1<<13` = 8192). */
   readonly CHEATS:      number;
+  /** Full access — implicitly satisfies every flag (`1<<14` = 16384). See {@link AdminInfo.hasFlags}. */
   readonly ROOT:        number;
 };
 
 /** An admin entry: their SteamID64, their combined flag mask, and a helper to check flags. */
 export interface AdminInfo {
+  /** This admin's SteamID64 (decimal string). */
   readonly steamId: string;
+  /** Combined flag mask (union of file + runtime tiers and group flags) — test against {@link ADMFLAG} bits. */
   readonly flags:   number;
   /** Immunity level (0 = none). A lower-immunity admin cannot target a higher one. */
   readonly immunity: number;
@@ -38,13 +55,23 @@ export interface AdminInfo {
 
 /** A resolved admin group (from admin_groups.json): its flags, immunity, and per-command overrides. */
 export interface AdminGroup {
+  /** The group's name (its key in admin_groups.json). */
   readonly name: string;
+  /** Flag mask granted to every member — {@link ADMFLAG} bits. */
   readonly flags: number;
+  /** Immunity level conferred by membership (0 = none). */
   readonly immunity: number;
+  /** Per-command access overrides, keyed by command name: `public` opens it to all, `mask` is the required flags. */
   readonly overrides: Readonly<Record<string, { public: boolean; mask: number }>>;
 }
 
-/** The admin API: add/remove runtime admins, look up by SteamID or slot, reload from file. */
+/**
+ * The admin API: add/remove runtime admins, look up by SteamID or slot, reload from file.
+ * @example
+ * import { Admin, ADMFLAG } from "@s2script/sdk/admin";
+ * const a = Admin.forSlot(p.slot);
+ * const adminStr = a ? "yes(flags=0x" + a.flags.toString(16) + ")" : "no";
+ */
 export declare const Admin: {
   /** Add (or overwrite) a runtime admin. Not persisted to admins.json. */
   add(steamId: string, flags: number, immunity?: number): void;

package/bans.d.ts

@@ -29,7 +29,14 @@ export interface BanEntry {
   reason: string;
 }
 
-/** The ban API: add/remove bans, look up by SteamID64, list, and reload from bans.json. */
+/**
+ * The ban API: add/remove bans, look up by SteamID64, list, and reload from bans.json.
+ * @example
+ * import { Bans } from "@s2script/sdk/bans";
+ * // Connect-time enforcement inside a Clients.onConnect handler.
+ * const b = Bans.get(c.steamId);
+ * if (b && (b.until === 0 || b.until > Date.now() / 1000)) c.kickWithReason(b.reason);
+ */
 export declare const Bans: {
   /** Add (or overwrite) a ban and persist it to bans.json. `minutes <= 0` = permanent. */
   add(steamId: string, minutes: number, reason?: string): void;

package/chat.d.ts

@@ -1,5 +1,12 @@
 /** @s2script/chat — print messages to player chat. NO runtime code (injected at load). */
 
+/**
+ * Print messages to player chat (SayText2), with a caller-owned {@link Chat.color} prefix.
+ * @example
+ * import { Chat } from "@s2script/sdk/chat";
+ * Chat.toAll("[Vote] Result: " + winner);
+ * Chat.toSlot(slot, "Usage: @@<target> <message>");
+ */
 export declare const Chat: {
   /**
    * An opaque prefix prepended to every chat message (NOT rcon/console replies). Color is content the

package/clients.d.ts

@@ -2,8 +2,10 @@
  * @s2script/clients — engine-generic client handle + lifecycle events.
  * Resolved at runtime via globalThis.__s2pkg_clients. Import: import { Client, Clients } from "./clients";
  */
+
 /** A connected client, identified by its 0-based slot (CPlayerSlot). Slot-backed; getters read live. */
 export declare class Client {
+  /** The client's 0-based engine slot (`CPlayerSlot`) — the handle's stable identity for its connection. */
   readonly slot: number;
   /** True while a client occupies this slot. */
   isValid(): boolean;
@@ -35,9 +37,15 @@ export declare class Client {
    */
   voiceMuted: boolean;
 }
+/**
+ * Look up connected clients by slot or enumerate them all.
+ * @example
+ * import { Clients } from "@s2script/sdk/clients";
+ * console.log(`onLoad — all()=${Clients.all().length} clients`);
+ */
 export declare const Clients: {
   /** The client in `slot`, or null if the slot is empty. */
   fromSlot(slot: number): Client | null;
-  /** Every currently-connected client. */
+  /** Every currently-connected client (bots included). */
   all(): Client[];
 };

package/commands.d.ts

@@ -1,7 +1,25 @@
 /** @s2script/commands — register server commands. NO runtime code (injected at load). */
+
+/**
+ * Where a command was invoked from — SourceMod's *reply source*. Set by the dispatch path and
+ * exposed as {@link CommandInvocation.replySource}; it is what {@link CommandInvocation.reply}
+ * routes on.
+ *
+ * - `"server"` — the server console or rcon (`callerSlot` is `-1`)
+ * - `"console"` — a player's own developer console
+ * - `"chat"` — a `!` or `/` chat trigger
+ */
+export type ReplySource = "server" | "console" | "chat";
+
+/**
+ * The parsed invocation handed to a command callback: who called it, its arguments (multiple typed
+ * accessors), and a caller-appropriate `reply` channel. Valid only for the duration of the callback.
+ */
 export interface CommandInvocation {
   /** 0-based caller slot, or -1 for the server console. */
   readonly callerSlot: number;
+  /** Where this invocation came from — what {@link CommandInvocation.reply} routes on. */
+  readonly replySource: ReplySource;
   /** argString split on whitespace (0-based; the command name is NOT included). Kept for compat. */
   readonly args: string[];
   /** everything after the command name (raw) — SM `GetCmdArgString`. */
@@ -16,8 +34,33 @@ export interface CommandInvocation {
   argFloat(n: number, fallback?: number): number;
   /** every argument from index `n` onward, re-joined with a single space (a reason/message/value that spans spaces). */
   argsFrom(n: number): string;
-  /** reply to the caller: server console → server print; a player → their chat. */
+  /**
+   * Reply to the caller in the channel they used — SourceMod's `ReplyToCommand`. Routed by
+   * {@link CommandInvocation.replySource}: `"server"` → the server console, `"console"` → the
+   * caller's own developer console (both control-bytes-stripped), `"chat"` → their chat, one frame later.
+   *
+   * `Chat.color`'s global prefix applies to the chat path only and never decorates a console reply.
+   * To pin a channel regardless of how the command was invoked, use {@link
+   * CommandInvocation.replyToChat} or {@link CommandInvocation.replyToConsole}.
+   *
+   * @example
+   * // `!help` answers in chat; `sm_help` typed at a console answers in that console.
+   * ctx.commands.register("sm_help", (cmd) => cmd.reply("[SM] Commands: …"));
+   */
   reply(message: string): void;
+  /**
+   * Force the reply into the caller's chat, whichever channel they actually used — SM `PrintToChat`.
+   * Sent raw (colour is content you own) and deferred one frame, so a `!cmd` answer lands *after*
+   * the player's own chat line rather than above it. The server console (`callerSlot` `-1`) has no
+   * chat channel and degrades to the server console.
+   */
+  replyToChat(message: string): void;
+  /**
+   * Force the reply into the caller's developer console — SM `PrintToConsole`. Control bytes are
+   * stripped (a chat colour *is* a control byte, and renders as garbage in a console), and the line
+   * is printed immediately. The server console (`callerSlot` `-1`) prints to the server console.
+   */
+  replyToConsole(message: string): void;
   /** reply to the caller, translated for THEIR language (SM's `%t` on the reply path). Soft-deps
    * `@s2script/translations` — degrades to the raw `key` if it isn't loaded. */
   replyT(key: string, ...args: (string | number)[]): void;
@@ -32,13 +75,31 @@ export interface ChatTrigger {
   readonly argString: string;
 }
 
+/**
+ * Command-registry utilities: dispatch by name, parse/route chat triggers, and enumerate the global
+ * registry. Commands themselves are registered through the plugin context (`ctx.commands.register*`).
+ * @example
+ * import { Commands } from "@s2script/sdk/commands";
+ * // sm_help backend: every registered command + its required admin flag mask.
+ * const cmds = Commands.list().slice().sort((a, b) => (a.name < b.name ? -1 : 1));
+ */
 export declare const Commands: {
-  /** Invoke a registered command by name in THIS plugin (applying its gating). Returns true if it exists. */
-  dispatch(name: string, slot: number, argString: string): boolean;
+  /**
+   * Invoke a registered command by name in THIS plugin (applying its gating). Returns true if it
+   * exists.
+   *
+   * `replySource` sets where the command's {@link CommandInvocation.reply} lands. Omit it and it
+   * falls back to the slot — the server console at `-1`, else that player's own console, matching
+   * SourceMod's `FakeClientCommand`. Pass `"chat"` when re-dispatching on a player's behalf from a
+   * chat context.
+   */
+  dispatch(name: string, slot: number, argString: string, replySource?: ReplySource): boolean;
   /** Parse a chat message for a trigger (`!`/`/`). Returns the parsed trigger, or null if it's ordinary chat. */
   parseChatTrigger(message: string): ChatTrigger | null;
   /** If `message` is a trigger, dispatch the command (tries `name` then `sm_<name>`) as `slot`; returns
-   * `{ silent, ran }` (the caller should suppress the chat message), or null if it was ordinary chat. */
+   * `{ silent, ran }` (the caller should suppress the chat message), or null if it was ordinary chat.
+   * Always dispatches with `replySource` `"chat"` — including the silent `/` trigger, where `silent`
+   * suppresses the player's own line but the answer still belongs in chat. */
   handleChatTrigger(slot: number, message: string): { silent: boolean; ran: boolean } | null;
   /** The trigger characters — SM PublicChatTrigger (`"!"`) / SilentChatTrigger (`"/"`). Mutate to reconfigure. */
   readonly triggers: { public: string; silent: string };

package/config.d.ts

@@ -1,11 +1,23 @@
 /** @s2script/config — typed access to the plugin's materialized config. NO runtime code. */
 /** A materialized config value: a scalar, or a nested section object of further values. */
 export type ConfigValue = string | number | boolean | { [k: string]: ConfigValue };
+/** The whole materialized config: top-level keys to {@link ConfigValue}s. Passed to `ctx.config.onChange`. */
 export type Config = Record<string, ConfigValue>;
+/**
+ * Typed access to this plugin's materialized config values (declared under `s2script.config` in the manifest).
+ * @example
+ * import { config } from "@s2script/sdk/config";
+ * // plugins/antiflood/src/plugin.ts:31 — re-read on live-reload
+ * const maxTokens = config.getInt("max_tokens");
+ */
 export declare const config: {
+  /** A config value as a string. `""` if the key is absent. */
   getString(key: string): string;
+  /** A config value as an integer. `0` if the key is absent or non-numeric. */
   getInt(key: string): number;
+  /** A config value as a float. `0` if the key is absent or non-numeric. */
   getFloat(key: string): number;
+  /** A config value as a boolean. `false` if the key is absent. */
   getBool(key: string): boolean;
   /** Read a raw file from the configs dir (name includes its extension, e.g. "maplist.txt"). null if absent. */
   readFile(name: string): string | null;

package/console.d.ts

@@ -5,8 +5,17 @@
 
 /** Engine-provided console (log/error/warn/info). Also available as the global `console`. */
 export declare const console: {
+  /**
+   * Write a line to the server console (and the log). Arguments are stringified and space-joined.
+   * @example
+   * import { console } from "@s2script/sdk/console";
+   * console.log("[antiflood] onLoad — chat flood protection active");
+   */
   log(...data: any[]): void;
+  /** Write a line at error severity. */
   error(...data: any[]): void;
+  /** Write a line at warning severity. */
   warn(...data: any[]): void;
+  /** Write a line at info severity. */
   info(...data: any[]): void;
 };

package/cookies.d.ts

@@ -1,10 +1,43 @@
 /** @s2script/cookies — SM-parity client preference cookies. NO runtime code (injected as __s2pkg_cookies). */
 import type { Client } from "./clients";
-export enum CookieAccess { Public, Protected, Private }
-export interface Cookie { readonly name: string; readonly access: CookieAccess; readonly default: string; }
-export interface CookieOptions { description?: string; access?: CookieAccess; default?: string; }
+
+/** SM-parity access level carried as metadata on a {@link Cookie} definition (client cookie-menu visibility/editability). */
+export enum CookieAccess {
+  /** Visible and editable by the client in the cookie menu. */
+  Public,
+  /** Visible to the client but not editable. */
+  Protected,
+  /** Hidden from the client; plugin-only. */
+  Private,
+}
+/** A registered cookie definition — the handle passed to {@link Cookies.get}/{@link Cookies.set}. */
+export interface Cookie {
+  /** Unique cookie name (the DB key). */
+  readonly name: string;
+  /** Client visibility/editability, per {@link CookieAccess}. */
+  readonly access: CookieAccess;
+  /** Value returned by {@link Cookies.get} when the client has no stored value. */
+  readonly default: string;
+}
+/** Options for {@link Cookies.register}. */
+export interface CookieOptions {
+  /** Human-readable description (shown in a cookie menu). */
+  description?: string;
+  /** Client visibility/editability. @defaultValue {@link CookieAccess.Public} */
+  access?: CookieAccess;
+  /** Fallback value when the client has no stored value. @defaultValue `""` */
+  default?: string;
+}
+/** Entry point for registering and reading/writing client preference cookies. */
 export declare const Cookies: {
-  /** Register (or return an existing) cookie definition. */
+  /**
+   * Register (or return an existing) cookie definition. Idempotent per plugin context — the same name
+   * returns the already-registered {@link Cookie}.
+   * @example
+   * import { Cookies } from "@s2script/sdk/cookies";
+   * const boots = Cookies.register("demo_boots", { default: "0" });
+   * const n = parseInt(Cookies.get(client, boots), 10);
+   */
   register(name: string, opts?: CookieOptions): Cookie;
   /** Cache value for this client (a stored "" is a real value), else the cookie's default. Default for bots. */
   get(client: Client, cookie: Cookie): string;

package/damage.d.ts

@@ -4,7 +4,13 @@
  */
 import type { EntityRef } from "./entity";
 
-/** A block-scoped view of the current damage event (valid only inside a Damage.onPre handler). */
+/**
+ * A block-scoped view of the current damage event (valid only inside a Damage.onPre handler).
+ * @example
+ * import type { DamageInfo } from "@s2script/sdk/damage";
+ * // plugins/basecommands/src/plugin.ts:81 — halve the damage (assign 0 to block it entirely)
+ * ctx.entities.onDamage((info: DamageInfo) => { info.damage = info.damage / 2; });
+ */
 export interface DamageInfo {
   /** The damage amount (m_flDamage). Assigning MODIFIES the live damage; set to 0 to block. */
   damage: number;