Web SDK
The TypeScript runtime for HELIX Instant worlds. Identity, wallet, storage, inventory, multiplayer and voice for a world that runs in the browser.
The Web SDK is HELIX's TypeScript runtime. A world is a static bundle that runs in a sandboxed
iframe inside the HELIX shell; the SDK performs the handshake with the shell and exposes the
Platform API as the Helix namespace, plus the web-only multiplayer and voice
stack.
Install
npm install @hypersoniclabs/helix-sdkhelix init already adds it to a new project. There is no separate server SDK: multiplayer game
logic is declared in public/helix.json and runs on a platform-owned room (see
Multiplayer).
Start up
import { Helix } from '@hypersoniclabs/helix-sdk';
const { embedded, world, user, runtimeFidelity } = await Helix.init(); // call once, at startup
if (Helix.auth.isAuthenticated()) {
const me = await Helix.auth.getUser(); // { id, username, displayName }
}Helix.init() takes no arguments. The shell hands the world a short-lived, world-scoped session
token and the SDK wraps that handshake. When the world is opened directly (a plain vite preview),
init() resolves with embedded: false, identity returns null, and saves, purchases and
entitlements degrade to neutral, so the same build runs both ways. Use helix dev to exercise the
platform calls offline.
What is on Helix
| Namespace | What it does |
|---|---|
Helix.auth | Current user, login prompt, auth change events |
Helix.wallet | LIX balance and balance change events |
Helix.dataStore | Durable per-world key-value storage with optimistic versions |
Helix.inventory | Items the player owns, equip |
Helix.marketplace, Helix.purchases | Buy products, items and listings; read entitlements |
Helix.leaderboard, Helix.achievements | Rankings and badges |
Helix.multiplayer, Helix.voice, Helix.party, Helix.matchmaking | Rooms, proximity voice, parties |
Helix.avatar, Helix.emotes, Helix.locomotion | The player's equipped avatar, emotes and movement pack |
Helix.notify, Helix.prompts, Helix.device, Helix.camera, Helix.presence | Shell UI: notifications, interaction prompts, tablet, photos, activity |
The complete signature of every member, generated from the published package, is in the API reference.
Get started
Analytics event contract
HELIX-owned event capture, storage, rollups, and creator-safe analytics, with PostHog as an internal analysis surface.
Multiplayer & Networking
How HELIX web worlds share a space and a game. A platform-owned, server-authoritative room runs rules you declare in helix.json. Web-runtime only.