Network Storage for s&boxLibrary overview
Install the library, configure credentials and call endpoints from game code.
Client library and editor tools for an s&box game backend. Call server endpoints, load game values and sync your backend's rules from the editor. Works with the open-source self-hosted server and the managed sbox.cool service.
Install · Website · Docs · Discord · Managed service wiki
Quick start
- Install from Editor > Library Manager: search for Network Storage by sboxcool.
- Configure in Editor > Network Storage > Setup with your project ID, public key, secret
key and (for a self-hosted server) base URL. The secret key stays in
Editor/and never ships. - Call your server from game code:
NetworkStorage.Configure( "your_project_id", "sbox_ns_your_public_key", "https://my-game.sboxns.com" );
var player = await NetworkStorage.CallEndpoint( "load-player" );
var result = await NetworkStorage.CallEndpoint( "mine-ore", new { ore_id = "iron", kg = 5.0f } );
if ( result.HasValue )
Log.Info( $"Currency: {result.Value.Int( "currency", 0 )}" );
var values = (await NetworkStorage.GetGameValues()).Value; // every group and table, one requestNo server yet? sbox-ns quickstart "My Game" on a self-hosted server prints the IDs, keys and the
Configure(...) line: sboxns.com/install.
What's in it
| Runtime client | Endpoints, game values, documents, save slots, analytics, retries and encrypted requests. Runtime API |
| Sync Tool | Collections, endpoints and workflows as YAML in your project, with diff, push and pull; generates typed code for them. Sync Tool |
| Setup window | Enter and test credentials and the server URL. Getting started |
| Debugging | NetLog ring buffer for in-game debug panels, SaveStateTracker for HUD save state. |
| Agent tools | ns_* tools for coding agents through s&box's sbox-cli MCP bridge. Agent tools |
Copyable patterns are in Examples/.
Docs
- Getting started: install, update, configure, API root, generated code, dedicated servers, security model.
- Runtime API: calls, game values, encrypted requests and key pinning, server compatibility status, helpers.
- Sync Tool: YAML source files and the push/pull workflow; source-authoring.md for the full model.
- Agent tools: the in-engine
network_storagetoolset. - Maintainers: releasing, compat gate, compatibility certification.
Compatibility
The library and server release independently and are both long-term supported. Public methods and endpoints are never silently renamed, removed or narrowed, and servers keep accepting older libraries by default. Each library, server, engine and database pairing is certified with real evidence: compatibility certification.
License
MIT, see LICENSE. sbox.cool and sboxcool.com are run by the same group;
api.sboxcool.com is the long-term managed API host.