auto_stories

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
terminalCode Example
May 20, 2026

Code Cheat Sheet: Quick Reference for GameObjects, Components, and Transforms

Quick reference for common s&box operations covering debugging, transforms, GameObjects, and Components. Useful when you know what you want to do but not the ex…

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…

menu_bookDocumentation
May 20, 2026

UI Style Properties: CSS Reference with Custom Pseudo-Classes and Sound Events

s&box UI styling follows web CSS conventions with some differences. Everything is flex by default. Key custom properties include / for hover/click sounds, , and…

menu_bookDocumentation
May 20, 2026

NavMesh Area Costs and Filters: Weighted Pathfinding and Agent Restrictions

NavMesh Areas in s&box can be used to mark sections as more costly to traverse (e.g. shallow water) or to prevent certain agents from entering specific areas. C…

menu_bookDocumentation
May 20, 2026

Serverside Code: #if SERVER Blocks and .Server.cs Files for Hidden Logic

s&box supports serverside-only code that is stripped from client builds. This only works when running local projects on dedicated servers. #if SERVER Blocks Cod…

menu_bookDocumentation
May 20, 2026

BeamEffect: Animated Line Renderer for Tracers, Lasers, and Beams

The BeamEffect in s&box is an animated LineRenderer for creating beams, tracers, and lasers. It supports multiple beams, fade over time, scale over time, and te…

menu_bookDocumentation
May 20, 2026

Creating Terrain: Heightmap Setup, World Scale, and Asset Reuse

To add Terrain to your s&box scene, right-click in the Hierarchy and select 3D Object → Terrain. The inspector prompts you to create, import, or link an existin…

menu_bookDocumentation
May 20, 2026

GameResource Extensions: Appending Data to Existing Assets Without Modification

ResourceExtensions in s&box append additional data to existing GameResources without modifying the original class or assets. Useful for adding properties to Clo…

menu_bookDocumentation
May 20, 2026

Video: VideoPlayer Decoding and VideoWriter Encoding with Streaming Support

s&box provides VideoPlayer for decoding video and VideoWriter for encoding video frames. VideoPlayer Decodes video files or URLs, exposing the current frame as …

menu_bookDocumentation
May 20, 2026

TemporaryEffect: Auto-Cleanup for Particle and Sound Prefabs

The TemporaryEffect component in s&box is added to prefabs containing ParticleEffects and Sounds. It automatically deletes the GameObject after all particles ar…

menu_bookDocumentation
May 20, 2026

Binary Serialization: BlobData for Large GameResource Data Storage

When JSON files grow too large in s&box, you can store data as a binary blob using the class. This works with GameResource assets and provides custom serializat…

menu_bookDocumentation
May 20, 2026

Leaderboard Web API: Public REST Endpoint with Aggregation and Filtering

The s&box leaderboard Web API is publicly accessible for querying player rankings based on stats. Endpoint Parameters stat — stat name to base the leaderboard o…

menu_bookDocumentation
May 20, 2026

Dedicated Servers: Running Local Projects with Hidden Serverside Code

s&box dedicated servers can run entirely local projects as the game using the command line argument: Assets are still fetched from the cloud version of the game…

menu_bookDocumentation
May 20, 2026

Component Editor Tools: Selection-Based Scene View UI and Gizmos

Component Editor Tools in s&box are always active when a specific Component is selected. They create UI in the scene view and can override input. An example is …

menu_bookDocumentation
May 20, 2026

Creating Post-Process Effects: BasePostProcess with Volume Blending and Shaders

Create custom post-processing effects in s&box by deriving from . This enables volume-based blending and custom shader rendering. The Component Key Methods GetW…

menu_bookDocumentation
May 20, 2026

Raw Input: Direct Keyboard Access Bypassing Input Actions

s&box provides raw keyboard input access that bypasses input actions. Only use this when input actions won't work — raw inputs cannot be rebound by players. Ava…

menu_bookDocumentation
May 20, 2026

Razor Components: Reusable UI Fragments with RenderFragment and Generics

Razor Components in s&box allow you to define reusable UI content that can be used inside other razor files. They make panels more agile and composable. Creatin…

menu_bookDocumentation
May 20, 2026

Storage UGC: User-Generated Content with Steam Workshop Integration

The s&box Storage system provides a unified way to manage user-generated content in your game. Each storage entry is a self-contained folder with its own filesy…

menu_bookDocumentation
May 20, 2026

Input Glyphs: Device-Adaptive Button Icons for UI Hints

Input glyphs in s&box provide an easy way to show users which buttons to press for actions. They automatically adjust for whatever device is being used and retu…

menu_bookDocumentation
May 20, 2026

API Whitelist: Sandboxed Code Restrictions and Safe Alternatives

s&box uses a code whitelist to prevent access to classes and functions that could be used maliciously. Code that doesn't pass these checks will not be loaded in…