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 "key" 142 results closeClear
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 -…

codeAPI Reference
May 12, 2026

s&box PostProcessManager: Post-processing resource management

PostProcessManager API Reference PostProcessManager is a GameObjectSystem that manages post-processing resources with preview, toggle, and camera attachment. Ty…

menu_bookDocumentation
May 5, 2026

Components - s&box Documentation

Components A Component is added to a GameObject to provide functionality. This functionality can vary wildly. You could add a component that renders a model at …

terminalCode Example
May 3, 2026

Physgun Grab State with Permission Checks

Physgun Grab State Pattern Implementation pattern for physgun object grabbing with ownership checks and IPhysgunEvent permissions. Key Features Sync'd GrabState…

menu_bookDocumentation
May 5, 2026

Getting Started - s&box Documentation

Getting Started S&box is coded in C#. Under the hood, it uses the Source 2 engine (CS2, HL:Alyx, DOTA2) and some of its systems: rendering, resources, physics, …

terminalCode Example
May 12, 2026

RPC-based chat system with avatars and Steam filtering

RPC-Based Chat System with Avatar Support This example shows a complete chat system using Razor, RPC broadcasting, Steam filtering, and avatar display. Key Feat…

terminalCode Example
May 12, 2026

Drag-and-drop system with static instance pattern

Drag-and-Drop System with Static Instance Pattern This example shows a drag-and-drop system using a static instance pattern for global state management and visu…

terminalCode Example
May 12, 2026

Automatic water volume setup with buoyancy physics

Automatic Water Volume Setup with Buoyancy This example shows automatic attachment of WaterVolume components to colliders tagged "water" and buoyancy physics im…

codeAPI Reference
May 12, 2026

s&box LimitsSystem: Spawn and tool limits

LimitsSystem GameObjectSystem API Reference LimitsSystem enforces configurable limits on spawning and tool usage. Maintains a per-player tracked object list pop…

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…

menu_bookDocumentation
May 20, 2026

Razor Panels: HTML/CSS UI with C# in s&box

s&box UI can be created using Razor syntax — web-like HTML/CSS combined with C#. Panels are not rendered via a HTML renderer; the syntax is a convenience layer …

menu_bookDocumentation
May 20, 2026

Playing Sounds: SoundHandle, GameObject.PlaySound, and Audio Components

s&box provides several ways to play sounds: fire-and-forget at a position, controlled via , attached to a , or via scene components. SoundEvent Assets Sounds ar…

codeAPI Reference
May 20, 2026

SceneTraceResult: All Fields and Properties from Trace Hits

is returned by and contains all information about a trace hit. Key Fields Common Usage Pattern

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 …

menu_bookDocumentation
May 20, 2026

Cloud Assets: Referencing and Runtime Mounting from sbox.game

s&box provides access to a large library of cloud assets (models, textures, sounds) hosted on sbox.game. Assets are downloaded and cached automatically — no man…

menu_bookDocumentation
May 20, 2026

Particle Effects: CPU-Simulated Programmable Particle System

The s&box particle system is CPU-simulated (multithreaded) and fully programmable via components. You can emit particles manually, iterate and modify them at ru…

menu_bookDocumentation
May 20, 2026

Hotloading Pitfalls: Default Values, Types, Delegates, and Optimization

s&box hotloads code changes live when you save or files. Understanding the pitfalls helps avoid subtle bugs during development. How It Works IL Hotload (Fast): …

menu_bookDocumentation
May 20, 2026

File System: Sandboxed Virtual Filesystems for Data Persistence

Standard .NET access is restricted in s&box. Instead, use the provided virtual filesystems that sandbox access to specific game directories. Available File Syst…

terminalCode Example
May 3, 2026

ControlSystem Pattern for Seat/Vehicle Control

ControlSystem - Seat/Vehicle Control Management A that manages control transfer between players and seated entities (vehicles, chairs). Handles input routing an…

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…