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 "custom" 146 results closeClear
menu_bookDocumentation
May 20, 2026

Async Components: Coroutine-Style Async Tasks on the Main Thread

Async tasks in s&box run on the main thread by default, operating like coroutines. They are the recommended replacement for coroutines in s&box. Basic Async Fra…

menu_bookDocumentation
May 20, 2026

WebSockets: External Server Communication with Auth Token Support

s&box allows WebSocket connections to interface with external servers. Common uses include custom networking and persistent data storage outside the local files…

menu_bookDocumentation
May 20, 2026

NavMesh Agent: AI Pathfinding Component with Crowd Control

The s&box NavMeshAgent component moves GameObjects along the NavMesh automatically with built-in crowd control to avoid collisions between agents. Component Set…

menu_bookDocumentation
May 20, 2026

Shader Graph Getting Started: Visual Shader Editor in s&box

s&box Shader Graph is a visual scripting language that compiles to shader code. Accessible to beginners and useful for rapid prototyping by experienced shader d…

menu_bookDocumentation
May 5, 2026

Sync Properties - Complete Networking Guide

Sync Properties Sync Attribute Adding the attribute to a property on a Component will have its latest value sent to other players each time it changes. These pr…

menu_bookDocumentation
May 20, 2026

Input System Overview: Button Queries, Analog Input, and Escape Override

The s&box Input class provides button queries, analog input, and escape key handling for gameplay. Button Queries Analog Input Custom Keys Configure input actio…

terminalCode Example
May 3, 2026

BaseWeapon and BaseCarryable Weapon Framework

BaseWeapon and BaseCarryable - Weapon Framework Base classes for creating weapons in s&box. Provides ammo management, view/world models, and input handling. Bas…

menu_bookDocumentation
May 5, 2026

Input - s&box Gameplay Documentation

Input s&box provides a comprehensive input system that handles keyboard, mouse, and gamepad input. The input system uses named actions defined in your project s…

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…

codeAPI Reference
May 12, 2026

s&box ThrusterDefinition: Thruster type GameResource

ThrusterDefinition GameResource API Reference ThrusterDefinition is a GameResource that defines a thruster type with a prefab, used by the Thruster tool to spaw…

menu_bookDocumentation
May 4, 2026

s&box ISceneEvent: Scene-Wide and Per-Object Event Broadcasting

s&box ISceneEvent<T>: Scene-Wide and Per-Object Event Broadcasting is the base interface for all scene event systems. It provides static methods for broadcastin…

menu_bookDocumentation
May 5, 2026

Particle Effect - s&box Documentation

Official s&box documentation for Particle Effects - visual effects system. Particle Effect creates visual effects using GPU-accelerated particles. The system su…

codeAPI Reference
May 12, 2026

s&box INetworkListener: Connection interception

Interface for network connection interception. Implement to accept or reject incoming connections. Methods Usage Implement on a GameObjectSystem or Component to…

menu_bookDocumentation
May 12, 2026

LocalData persistence for server-side data

LocalData Persistence in s&box LocalData provides server-side data persistence that survives server restarts. It's useful for storing configuration, ban lists, …

codeAPI Reference
May 12, 2026

s&box HoverballDefinition: Hoverball type GameResource

HoverballDefinition GameResource API Reference HoverballDefinition is a GameResource that defines a hoverball type with a prefab, used by the Hoverball tool to …

menu_bookDocumentation
May 5, 2026

Editor Shortcuts - s&box Editor Documentation

Editor Shortcuts Custom keyboard shortcuts make your editor tools more efficient. Shortcuts can be bound globally or to specific widgets. Creating a Static Shor…

menu_bookDocumentation
May 5, 2026

ActionGraph - s&box Documentation

Official s&box documentation for the ActionGraph system - visual scripting. ActionGraph provides node-based visual scripting for gameplay logic. Getting Started…

terminalCode Example
May 3, 2026

Sync Properties for Networked State

Sync Properties for Multiplayer The attribute automatically synchronizes property values to all clients when they change. Basic Sync Sync Flags Customize sync b…

menu_bookDocumentation
May 12, 2026

Rpc.FilterInclude for targeted RPC broadcasting

Rpc.FilterInclude for Targeted RPC Broadcasting Rpc.FilterInclude is a using statement in s&box that restricts RPC broadcasts to specific connections only. This…

codeAPI Reference
May 12, 2026

s&box WheelDefinition: Wheel type GameResource

WheelDefinition GameResource API Reference WheelDefinition is a GameResource that defines a wheel type with a prefab, used by the Wheel tool to spawn wheels. Ty…