Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hyperx.dev/llms.txt

Use this file to discover all available pages before exploring further.

HyperX provides the backend features online games repeatedly need. Unity clients call HyperX through the SDK, while operators manage projects and live data from Console.

What HyperX Covers

AreaFeatures
UsersGuest, custom, and social login, session refresh, user lookup, characters
DataShared data, user data, character data, user preference slots
ContentCDN file downloads, game configs, probability tables, notices/events/policies
LiveOpsRankings, coupons, game logs, push device registration, usage views
CommunityFriends, mail, messages, guilds, notifications, realtime chat
  1. Create a project in Console and copy the project code.
  2. Add the HyperX SDK DLL to your Unity project.
  3. Initialize the SDK with HyperX.Core.Init.
  4. Create a guest user and confirm it on the Console Users page.
  5. Add the data, LiveOps, and social features your game needs.

Unity Quickstart

Install the SDK and create your first guest user.

SDK Initialization

Initialize the SDK with your production project code.

User Lifecycle

Connect login, session refresh, names, and characters.

Provider Integrations

Register production credentials for social login, purchases, and push.