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
menu_bookDocumentation
May 5, 2026

Indirect Light Volumes (DDGI) — dynamic global illumination probe grid

Indirect Light Volumes (DDGI) places a probe grid for dynamic global illumination — light bouncing off surfaces tints nearby objects, and sunlight fades natural…

menu_bookDocumentation
May 5, 2026

Terrain System — heightmap creation, material painting, and sculpting

Terrain System s&box terrain is a heightmap-based landscape system with material painting, sculpting tools, and built-in LOD. Terrain data is stored in a reusab…

terminalCode Example
May 5, 2026

RadiusDamage — explosion area damage with IDamageable, occlusion, and physics force

RadiusDamage Component is a built-in s&box component that applies damage to all objects within a sphere. It integrates with the system and can apply outward phy…

menu_bookDocumentation
May 5, 2026

Clutter System — scattering grass, rocks, and debris with GPU instancing

Clutter System — Scattering Grass, Rocks, and Debris The Clutter System scatters large amounts of small objects (grass, rocks, debris) across a scene using GPU-…

terminalCode Example
May 5, 2026

BeamEffect — laser and energy beams between two points

BeamEffect — Laser and Energy Beams renders a beam between two points in the world. Use it for lasers, electricity, tractor beams, or any line-based visual effe…

menu_bookDocumentation
May 5, 2026

PolygonMesh — procedural block meshes with per-face materials and vertex editing

PolygonMesh — Procedural Block Meshes s&box includes a API for creating and editing meshes at runtime or in editor tools. The editor's block mesh tools use this…

terminalCode Example
May 5, 2026

CharacterController — capsule movement, ground checks, and velocity control

CharacterController in s&box is a built-in s&box component for capsule-based movement. Unlike , you control velocity directly — the controller handles collision…

terminalCode Example
May 5, 2026

Post-processing and camera setup — CameraComponent, PostProcessVolume, Bloom, DoF, and Film Grain

Post-Processing and Camera Setup CameraComponent Orthographic Camera Multiple Cameras (Priority) Higher priority renders on top. Use for split-screen, minimaps,…

terminalCode Example
May 5, 2026

Spatial audio components — SoundPoint, SoundBox, SoundscapeTrigger, DspVolume, and AudioListener

Spatial Audio Components s&box provides several components for placing audio in the world. All are alternatives to for persistent, positioned audio sources. Sou…

terminalCode Example
May 5, 2026

Particle Effect system — emitters, manual emission, and custom controllers

Particle Effect System s&box particles are CPU-simulated and fully programmable. A particle system is built from three component types on the same GameObject: (…

terminalCode Example
May 5, 2026

Scene lighting setup — DirectionalLight, PointLight, SpotLight, SkyBox, AmbientLight, and Fog

Scene Lighting Setup s&box lighting is built from components. A typical scene needs a directional light (sun), ambient light, and a skybox. Directional Light (S…

terminalCode Example
May 5, 2026

Collider types — Box, Sphere, Capsule, Model, Hull, Plane, and Trigger volumes

Collider Types s&box provides several collider components for physics shapes. All colliders can be set as triggers (no physical response, just overlap detection…

terminalCode Example
May 5, 2026

VerletRope — rope physics with attachment, slack, and stiffness

VerletRope simulates rope physics using Verlet integration. The rope hangs from the GameObject's position and optionally attaches its end to another GameObject.…

terminalCode Example
May 5, 2026

Physics joints — Fixed, Ball, Hinge, Slider, Spring, and Wheel

Physics Joints Joints connect two physics bodies together with constraints. All joint types are components added to a GameObject positioned at the joint's ancho…

terminalCode Example
May 5, 2026

NavMeshLink custom traversal — parabolic jump, ladder climb, and physics jump

NavMeshLink Custom Traversal connects two NavMesh points for agents to traverse (jumps, ladders, teleports). Default traversal linearly interpolates between sta…

menu_bookDocumentation
May 5, 2026

Scene Metadata - s&box Scene Documentation

Scene Metadata You can implement the interface in any Component that has data you'd like saved to Metadata. Metadata is data that can be accessed without needin…

menu_bookDocumentation
May 5, 2026

ActionGraph Component Actions - s&box Documentation

ActionGraph Component Actions Add ActionGraph behavior directly to GameObjects using the ActionGraph component. Component Actions The ActionGraph component lets…

menu_bookDocumentation
May 5, 2026

Publishing Clothing - s&box Clothing Documentation

Publishing Clothing Publish clothing assets to sbox.game for players to use. Setting up your .Clothing File Create a clothing definition asset: Right-click in A…

menu_bookDocumentation
May 5, 2026

Making a Hat - s&box Clothing Documentation

Making a Hat Step-by-step guide to creating hat clothing for the Citizen character. Making Hats / Headwear Hats are worn on the head and don't need to deform wi…

menu_bookDocumentation
May 5, 2026

Physics Events - s&box Physics Documentation

Physics Events Receive callbacks for physics events in the scene. IScenePhysicsEvents Implement this interface on a component to receive scene-wide physics even…