s&box docs

Status

As you play with developing in s&box, you will notice some things are weird, missing, or suck. We are aware.

As you play with developing in s&box, you will notice some things are weird, missing, or suck. We are aware.

Here's the current status of key features and missing functionality you'll run into.

NameDescription
Audio๐ŸŸข Can play sounds, music, voice chat, can play them positionally or 2D๐ŸŸข Audio processing, effects system๐ŸŸข Lip sync๐ŸŸ  No auto voice ducking
Multiplayer๐ŸŸข Can create server, join server, sync vars, gameobjects, rpcs๐ŸŸข Dedicated server support๐ŸŸ  No error handling, permissions
UI๐ŸŸข Razor and Panel class UI, full style sheets, transitions, transforms, animation, world panels
Scenes๐ŸŸข Can create scene, gameobject, components, play, stop
Controller๐ŸŸข Controller input๐ŸŸ  UI navigation with virtual cursor, missing element navigation, on-screen keyboard
Navigation๐ŸŸข Recast navmesh, agents, pathfinding, links
Platforms๐ŸŸข Windows๐ŸŸ  Is likely to expand in the future, just not a priority
Hammer/Maps๐ŸŸข Create + Load maps, brushwork, props, lights, select + launch map in game๐ŸŸข Can use GameObjects
VR๐ŸŸข Easy to develop for, built-in components๐ŸŸ  Accessibility, user experience needs work, needs more testing
Particles๐ŸŸข Create particle effects, emitters, sprite rendering, model rendering, trails, lights, velocity, collision๐ŸŸข Totally moddable and extendable๐ŸŸ  No built in line renderer, motion vectors, normals
Standalone๐ŸŸ  Working on export to standalone version license. Exporter works.
Physics๐ŸŸข Full 3D and 2D physics, great performance + stability
Editor๐ŸŸข Scene editor, editor tools, inspector, editor apps, key re-binding
2D๐ŸŸข 2D physics, ortho camera๐ŸŸ  Basic sprite support๐Ÿ”ด No 2d editor mode
GameResources๐ŸŸข Custom game resource types, with inspector editing๐ŸŸ  No binary writing support yet
Terrain๐ŸŸ  Early development, basic editing๐Ÿ”ด No grass/detail models yet
Animation๐ŸŸข Valve's animgraph system, events, IK, animated ragdolls, morphs๐ŸŸ  Some advanced features currently rely on an undocumented format
PostProcessing๐ŸŸข Shader support, camera-based post-process base component

Referenced API

Canonical API pages mentioned in this guide.

Created at:
Updated at: