S&box Wiki
Home
/
Edit The s&box wiki
View
Edit
History
No Category
Developer Overview
The Project System
Publishing To Asset Party
Getting Started With Hammer
Mapping Basics
Mapping Entities
Advanced Mapping Techniques
Getting Started with Modeldoc
Animgraph & Animation
Physics
Modeldoc Nodes
Advanced Modelling
UI Basics
Styles & Stylesheets
Razor Templates
Materials
Built In Shaders
Shaders
Shader Reference
Sounds & Audio
Particles
Getting Started
Learning C#
Making Games
Players
Entities
The Scene System
Physics
Rendering
Camera
Networking
Input
VR
Editor & Tools
Misc
Playing Guides
Console Commands & Variables
Dedicated Server
Preview
Log in to edit
The s&box wiki
<cat>Dev.Intro</cat> <title>The s&box wiki</title> <upload src="41122/8d905d3af45832c.jpg" size="56510" name="header_capsule.jpg" /> # Current Status ## Code The API is 90% stable. No huge globally breaking changes are expected. It could happen, but we're taking care to mark things obsolete and give you time to move to changed APIs where possible. ## Addons Addons are supported. Check our [October 2022 blog](https://sbox.facepunch.com/news/october2022#Addons) for more info. ## Mapping and Entities We're moving the majority of entities and entity IO to addon code. This has two big advantages.. first of all you can look at the code and see exactly how it works, what it should do and what it shouldn't. Secondly it forces us to make a bunch of stuff work in our addon code - meaning a more flexible API for everyone to use. We're taking this as an opportunity to rename, sort and throw away a bunch of obsolete entities. This is still an ongoing process so if you can't find an entity in Hammer that you used to use, have a look around for a better named alternative - if it's still not there open an issue and we'll sort you out. ## Developer Preview We are slowly giving out developer preview access to people. You don't need to ask us for a key. Go to the [Dev Backend](https://sbox.facepunch.com/dev/) site for more information. # Issues For bugs and feature requests, please use [Github Issues](https://github.com/Facepunch/sbox-issues/) # Other Resources There's a few other sites you should keep an eye on for updates. + [Monthly Dev Blogs](https://sbox.facepunch.com/news/) + [Development Updates](https://github.com/Facepunch/sbox-issues/discussions) + [asset.party](https://asset.party/) + [API Reference](https://asset.party/api)
S&box Wiki
Development
Developer Overview
5
General FAQ
System Requirements
The Developer Preview
The Editor Overview
The s&box wiki
The Project System
2
Importing and Creating Assets
Your First Project
Publishing To Asset Party
2
Creating and uploading projects
Uploading assets
Hammer
Getting Started With Hammer
4
Creating a Door
Creating your first gm_flatgrass
Getting Started With Hammer
Mapping Resources
Mapping Basics
1
Tools Visualisation Modes
Mapping Entities
1
Light Entities
Advanced Mapping Techniques
4
Instances
Prefabs
Quixel Bridge Plugin
Tilesets
Models & Animation
Getting Started with Modeldoc
5
Breakpieces
Guide to Models
Importing Rust Weapons
LODs
ModelDoc FAQ & best practices
Animgraph & Animation
3
Animations without Animgraph
AnimEvents, AnimGraph Tags, Attachments
Animgraph
Physics
3
Cloth Physics
Collisions, Physics & Surface Types
Jiggle Bones
Modeldoc Nodes
1
Custom ModelDoc nodes
Advanced Modelling
6
Bodygroups
Citizen
First Person
IKChains and Stride Retargeting
Morphs
Vertex Normals
User Interface
UI Basics
6
Custom Fonts
Enabling Pointer Events
Events and Input
Localization
UI Basics
World UI
Styles & Stylesheets
2
Custom Style Properties
Supported Style Properties
Razor Templates
1
Razor Overview
Materials & Shaders
Materials
4
Guide to Materials
Material Resources
Texture Settings
Using Dynamic Expressions
Built In Shaders
0
Shaders
4
Compute Shaders
Constant Buffers
Material API
Shading Model
Shader Reference
3
Anatomy of Shader Files
Shader Reference
Shader States
Other Assets
Sounds & Audio
3
Guide to Sounds
Sound Events
Soundscapes
Particles
5
Creating animated sprites
Creating your first particle effect
Understanding Particle Editor
Using custom sprites
Using particle systems from C#
Coding
Getting Started
7
Cheat Sheet
Debugging
Event System
FileSystem
Setting up Rider
Setting up Visual Studio
Setting up Visual Studio Code
Learning C#
2
C# Learning Resources
Threaded Tasks
Making Games
4
Creating A Game
Running multiple instances of the game
The Game Loop
Traces
Players
4
Bots
Clothing
Pawn
Voice
Entities
6
Entities
Entity Components
Entity Tags
Map Placeable Entities
RenderEntity
Usable Entities
The Scene System
0
Physics
2
Custom Physics on a ModelEntity
Hitboxes
Rendering
1
RenderHooks
Camera
1
Camera
Networking
8
Commands
Lag Compensation
Network Callbacks
Networked Types
Networking Basics
Prediction
RPCs
Websockets
Input
3
Input Glyphs
Input System
Speech Recognition
VR
2
VR Input
VR Overlays
Editor & Tools
3
Custom Asset Types
Hammer API
Hotload Performance
Misc
8
Backend API
ClientData ConVars
Code Accesslist
DisplayInfo
Mounting assets at runtime
Precaching
Saved Games
TypeLibrary
Playing
Playing Guides
2
Default Keybinds
Proton
Console Commands & Variables
0
Dedicated Server
1
Dedicated Servers