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 separates data by owner and operational workflow. Decide what the data belongs to, create the required Console table if needed, then read or save it from the SDK.

​
Which Feature Should I Use?

FeatureOwnerUse It For
Shared dataProjectItem catalogs, shop lists, public balance values
User dataUser accountCurrency, achievements, tutorial state, account-level state
Character dataRepresentative characterCharacter level, equipment, stats, loadout
User preferenceSlots under the user accountGraphics options, controls, last selected values
Use user data or character data when operators need field-level validation. Use user preference for flexible client-owned JSON settings.

​
Read Shared Data

Shared data is created and published from Console. Clients read it. 
var items = await HyperX.Core.Data.Shared.List("catalog");
var sword = await HyperX.Core.Data.Shared.Get("catalog", "sword");

int price = (int)sword.Data["price"];

​
Save User Data

await HyperX.Core.Data.User.PutJson(
    tableKey: "inventory",
    rowKey: "main",
    accessToken: session.AccessToken,
    json: "{\"gold\":1200,\"gem\":30}"
);

var inventory = await HyperX.Core.Data.User.Get(
    "inventory",
    "main",
    session.AccessToken
);

await HyperX.Core.Data.User.Delete("inventory", "main", session.AccessToken);

​
Save User Preferences

User preferences are stored by slot_key, not table row. 
await HyperX.Core.Data.UserPreference.PutJson(
    slotKey: "settings",
    accessToken: session.AccessToken,
    json: "{\"quality\":\"high\",\"bgm\":0.7}",
    metadataJson: "{\"platform\":\"android\"}"
);

var settings = await HyperX.Core.Data.UserPreference.Get(
    "settings",
    session.AccessToken
);
Current default limits are 20 slots per user and 1MiB JSON payload per slot.