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.

Unity samples help you confirm SDK connectivity and learn feature call order. Replace project codes, table keys, ranking keys, and coupon codes with values from your own project.

​
Included Flows

SampleFlow
HyperXBootstrapSample.csSDK initialization, guest login, current user lookup
HyperXDataSample.csShared data, user data, user preference
HyperXLiveOpsSample.csRankings, coupons, game logs, operation content
HyperXSocialSample.csMail, user search, notifications

​
Run Order

  1. Create a project in Console and copy the project code.
  2. Create the shared data, ranking, coupon, and operation content used by the sample.
  3. Place the HyperX SDK DLL under Assets/Plugins.
  4. Add the sample script under Assets/Scripts and attach it to a GameObject.
  5. Enter the project code and keys, then run the scene.
await HyperX.Core.Init(projectCode);

var session = await HyperX.Core.Users.StartGuest(
    SystemInfo.deviceUniqueIdentifier,
    country: "US",
    language: "en"
);
If a sample fails, first check that required Console data is published, then review ErrorCode, TraceId, and RequestId in the logs.