RUN.game SDK

The RUN.game SDK gives your HTML5 game access to monetization, multiplayer, storage, AI, and more — all through a single import.

Quick Start

import RundotGameAPI from '@series-inc/rundot-game-sdk/api'

Every API is accessed through RundotGameAPI. For example:

// Save player progress
await RundotGameAPI.appStorage.setItem('level', '5')

// Show a rewarded ad
const result = await RundotGameAPI.ads.showRewardedAdAsync()

// Get server time
const time = await RundotGameAPI.time.requestTimeAsync()

API Reference

Monetization

API	What it does
Ads	Serve rewarded video and interstitial ads.
Purchases	Let players spend RunBucks on digital goods.

Messaging

API	What it does
Notifications	Schedule local notifications for re-engagement.
In-App Messaging	Display toast notifications and in-app messages.

Assets

API	What it does
Assets	Load game assets from the CDN with caching, preloading, and WebView support.
Shared Assets	Download host-provisioned asset bundles shared across titles.

Game Systems

API	What it does
Experiments	Run A/B tests, feature flags, and feature gates.
Big Numbers	Handle exponential economies without losing precision.
Multiplayer (BETA)	Build synchronous multiplayer sessions with real-time updates.
Server-Authoritative (BETA)	Drive authoritative game state through the simulation system.
Sharing	Share links, generate QR codes, and handle share parameters.
Leaderboards (BETA)	Competitive leaderboards with multiple security levels.

Device & Environment

API	What it does
Safe Area	Read safe-area insets to avoid overlapping host UI and notches.
Environment	Detect device type, platform, screen size, and dev mode.

AI

API	What it does
AI	Generate text and images using hosted AI models.

Utility

API	What it does
Analytics	Record gameplay telemetry, funnel steps, and user properties.
Context	Access launch parameters and share parameters.
Embedded Libraries	Load and manage embedded libraries shipped by the host.
Haptics	Trigger haptic feedback on supported devices.
Lifecycles	React to host lifecycle changes (pause/resume/teardown).
Logging	Stream structured logs for debugging and support.
Preloader	Control the native loading screen during heavy loads.
Profile	Access the current user profile.
Storage	Persist player data at device, app, or global scope.
Time	Server time synchronization and formatting.

---

New to RUN.game? See Getting Started | Deploying Your Game | Setting Your Game Thumbnail | Troubleshooting