s&box MCP Knowledgebase

Documentation, API references, code examples and community knowledge for s&box development.

library_books 595 entries menu_book 352 Documentation code 133 API Reference terminal 100 Code Example groups 10 Community
Results for "Id" 84 results closeClear
codeAPI Reference
May 12, 2026

s&box BanSystem: Player ban management

BanSystem GameObjectSystem API Reference BanSystem holds a banlist and can ban users. Implements INetworkListener to reject banned connections. Bans are persist…

terminalCode Example
May 3, 2026

BanSystem Pattern for Player Management

BanSystem - Player Ban Management A GameObjectSystem that manages player bans with persistent storage. Demonstrates , persistence, and RPC commands. Implementat…

codeAPI Reference
May 12, 2026

s&box BanSystem: Ban list management with persistence

BanSystem API Reference BanSystem is a GameObjectSystem that manages a ban list with LocalData persistence and connection blocking. Type Signature Key Methods -…

terminalCode Example
May 3, 2026

CleanupSystem Pattern for Map Reset and Scene Management

CleanupSystem - Scene State Management and Map Cleanup A that captures the baseline scene state and allows resetting the map to its original state. Removes spaw…

terminalCode Example
May 12, 2026

s&box player management with RPC, ConCmd, and Connection APIs

s&box Player Management with RPC, ConCmd, and Connection APIs This example shows player kick/ban utilities using s&box's Connection, RPC, ConCmd, and Chat syste…

terminalCode Example
May 12, 2026

CleanupSystem: Map reset and baseline restoration

CleanupSystem: Map Reset and Baseline Restoration This example shows the CleanupSystem which tracks the baseline scene state and allows resetting the map to its…

menu_bookDocumentation
May 20, 2026

Dedicated Servers: Installation, Configuration, and Command Line

s&box dedicated servers run headless and can be installed via SteamCMD. They host multiplayer games without requiring the full editor. Installation Install via …

codeAPI Reference
May 3, 2026

PlayerData Component for Stats and Respawn

PlayerData Component Persistent player data component tracking stats (kills, deaths), respawn state, and providing connection lookup. Key Properties Connection …

codeAPI Reference
May 20, 2026

Connection API: Properties, Methods, and Common Multiplayer Patterns

The class represents a network connection (client or server). Used extensively in multiplayer for identifying players, checking permissions, and managing networ…

menu_bookDocumentation
May 3, 2026

Backend Services - Achievements, Leaderboards, Stats

Backend Services - Achievements, Leaderboards, Stats Integrate Steam backend services for player progression, competition, and analytics. Achievements Track and…

menu_bookDocumentation
May 20, 2026

Dedicated Server User Permissions: Claims-Based Access Control via Steam ID

On s&box Dedicated Servers, you can specify admin permissions per user via the file using Steam IDs and claims. Configuration Claims Claims are strings describi…

terminalCode Example
May 3, 2026

Leaderboards API

Implement leaderboards using s&box Services API. Submitting Scores Reading Leaderboards Leaderboard Entry Properties Web API Access Query leaderboards from exte…

menu_bookDocumentation
May 12, 2026

s&box ISpawnerExtensions: Creating spawner instances

ISpawnerExtensions: Creating ISpawner Instances ISpawnerExtensions provides an extension method to create ISpawner instances from type strings, supporting vario…

menu_bookDocumentation
May 12, 2026

Steam filtering API for user content sanitization

Steam Filtering API in s&box s&box provides Steam filtering APIs to sanitize user-generated content like names and chat messages. This helps prevent profanity, …

codeAPI Reference
May 3, 2026

GameManager.Spawn RPC with Ident Parsing

GameManager.Spawn RPC Broadcast RPC for spawning entities from string identifiers with automatic weapon pickup detection. Ident Format - Spawn a prop from asset…

terminalCode Example
May 10, 2026

s&box JSONObject Save Data Helper for Components

This s&box-focused sample shows how to programmatically construct and deconstruct JSON for component save data. It is useful for player saves, world unlock stat…

menu_bookDocumentation
May 4, 2026

Code Upgrader Diagnostics: SBOX001-SBOX007 and SB3000 Roslyn Analyzer Warnings

Code Upgrader Diagnostics: s&box Roslyn Analyzer Warnings s&box ships a Roslyn analyzer () that warns about deprecated patterns and auto-fixes them. These appea…

menu_bookDocumentation
May 4, 2026

GameObject.Network Accessor — IsProxy, IsOwner, TakeOwnership, DropOwnership, Refresh, and IGameObjectNetworkEvents

GameObject.Network Accessor — Ownership, Spawning, and Proxy Detection is a that provides all network-related operations for a . It always resolves to the netwo…

menu_bookDocumentation
May 5, 2026

Exporting Standalone - s&box Documentation

Exporting Standalone ⚠️ Warning: Exporting standalone games is currently in preview. Distribution requires approval from Valve — we're working with them to open…

terminalCode Example
May 3, 2026

Storage (UGC)

Manage user-generated content, save games, and player creations. Creating Entries Entry Properties Reading Files Listing Entries Deleting Entries Steam Workshop…