Docs

Core concepts

Relay / event ID

A shared community counter. In the current API, the event ID and relay ID are the same string.

sunfall

Event IDs do not need an event. prefix.

Game

A registered game has a Game ID, a runtime Game Key, a display name, and a private Game Admin Password. The Game ID and Game Admin Password are enough for developer self-service actions such as joining public events.

Game-event link

A game must be connected to an event before it can contribute to that event or sync reward claim state for it.

Completion version

The number of completed event milestones. Rewards are tied to completion versions.

Installation

A local player installation registered by the SDK. This is not a Lynx player account or profile.

Runtime request limits are applied per installation where possible. For example, the increment limit is per player installation, per game, and per event, so one active player does not consume another player’s contribution budget.

State token

An encrypted token used by the SDK to keep reward claim state consistent.

Reward offer

A local game-facing reward entitlement created from claimable Lynx versions.

Recommended MVP architecture

LynxRelay
-> server sync, installation state, token state, pending claim, ack

LynxRewards
-> local reward offers / chest entitlement

Game
-> event action, chest spawn, reward grant, save_game

The Godot SDK is the recommended integration path for early builds.