Workshop contract

Interfaces

@s2script/sdk/contracts/workshop

Type-only contract for a workshop / UGC service. The framework ships no implementation: a community plugin publishes one and consumers depend on this shape.

4 exports

Import

import { WorkshopItem } from "@s2script/sdk/contracts/workshop";

Author-time types ship in the npm package; the engine injects the runtime at plugin load. Add @s2script/sdk to your plugin's dependencies.

API reference

Generated from the shipped type definitions.

interface

WorkshopItem

A workshop item. id is a **decimal string**, never a number: published-file IDs are 64-bit and a BigInt cannot cross the plugin boundary (it throws and drops the whole payload).

readonly id: string

— Published-file ID as a decimal string, e.g. "3070288894".

readonly title: string

— Item title, or "" when metadata has not been fetched yet.

readonly authorSteamId: string

— Owning author's SteamID64 as a decimal string, or "" if unknown.

readonly sizeBytes: number

— Bytes on disk once installed; 0 when not installed or unknown.

readonly updatedAt: number

— Last-updated Unix seconds; 0 if unknown.

interface

WorkshopMap

An installed workshop map, as reported by WorkshopService.currentMap.

readonly mapName: string

— The BSP name the engine loads (what Server.mapName reports once live).

interface

WorkshopDownloadProgress

Progress for an in-flight download.

readonly id: string

readonly bytesDownloaded: number

readonly bytesTotal: number

interface

WorkshopService

The contract a workshop plugin publishes. Everything that touches Steam is asynchronous — an implementation must not block the game frame. Methods resolve to null/false rather than throwing when an item is unknown or Steam is unreachable, so a consumer degrades instead of crashing (the framework's standing posture).

currentMap(): Promise<WorkshopMap | null>

— The currently-running workshop map, or null when the server is on a stock map.

info(id: string): Promise<WorkshopItem | null>

— Metadata for id, or null if unknown/unreachable.

ensureInstalled(id: string): Promise<boolean>

— Ensure id is installed and up to date, resolving true once usable. Implementations should be idempotent — calling it for an already-current item is a cheap true.

progress(id: string): Promise<WorkshopDownloadProgress | null>

— In-flight download progress, or null when nothing is downloading for id.

changeMap(id: string): Promise<boolean>

— Change level to a workshop map. Resolves false when the item is not a map, is not installed and could not be fetched, or the change was refused. On success the server changes level, so a caller should not assume any code after this runs on the same map.

installed(): Promise<readonly WorkshopItem[]>

— Every installed workshop item known to the implementation.

Back to modules All packages