Crux - Documentation
Install the Crux SDK and ship a multiplayer game in under 10 minutes. The interactive API explorer above requires JavaScript; below is a JS-free index of what Crux covers and where to start.
SDK Quickstarts
- All SDKs index - Unity, Unreal, Godot, JavaScript
- Unity SDK: install via UPM, add the
GsbClient prefab, call Login(), then FindMatch().
- Unreal SDK: install the Crux plugin, configure the
CruxSubsystem, call Authenticate, then JoinMatch.
- Godot SDK: drop the addon in
res://addons/, autoload GSB, call gsb.login(), then gsb.find_match().
- JavaScript / Web SDK:
npm install @supercraft/gsb-sdk then const client = new Gsb({apiKey}).
API Reference Sections
- Auth - player accounts, JWT sessions, anonymous login, social login.
- Matchmaking - queue join/leave, ticket polling, server allocation, region pinning.
- Dedicated Servers - server lifecycle, config, allocation, health checks, RCON.
- Leaderboards - create boards, submit scores, paginated reads, friends-only views.
- Economy - currencies, items, purchases, inventory, trade.
- Live Ops - events, A/B tests, remote config, push notifications.
- Audit Log - per-player and per-server activity stream.
Operational Topics
- Pricing and free-tier limits: pricing page
- Migrating from PlayFab, Nakama, Pragma, Beamable, Brainslug, Photon - see the GSB blog for migration guides per stack.
- Self-hosted vs managed: comparison guide.
Need a key? Sign up free - 100 monthly active players included on the free tier with all features unlocked.