Game kits

A kit lets a game link its player to their Discord account in your community. It does Connect and nothing else: it starts a connect session, returns the link, the code and the QR image to the game, polls for the result, waits for the player's confirmation, keeps the player signed in, renews the player session, reads the member card and disconnects. It draws nothing: the game shows the button. Rewards and the shop are not in the kits.

Every kit does what the Connect client of the TypeScript SDK does, request for request, with the same timings (polling for the result every 3 seconds, a player session renewed a minute before it ends, two retries after a failure) and the same four states of the button.

The kits

Three more packages have pages of their own. The Unity package and the Unreal plugin are previews: their logic is tested, the Unreal plugin builds in Unreal Engine 5.8, and neither has been run in a game yet.

A game made with another engine uses Connect for any engine, which gives the seven web requests with their exact headers and bodies.

How a player connects

The same in every kit:

The connection is saved when both the Discord member and the game have approved. This confirmation matters: a code shown on a stream can be approved by anyone who reads it, so the player can reject a name that isn't theirs.

The same example in each kit

let connect = try CeejayConnect(publicKey: "ceejay_pk_…", storage: KeychainConnectStorage())
try await connect.restore()                                          // when the game starts

let session = try await connect.start(StartParams(playerId: "p_19"))
showWaiting(code: session.code, qr: session.qrURL)                   // always show the code too
Task { try? await connect.open(session, using: WebAuthenticationSessionOpener()) }

let outcome = try await connect.waitForResult { member, _ in         // asks every 3 seconds
    await askThePlayer("Connect to \(member.displayName ?? "this Discord account")?")
}

The same names in each kit

The four states are the same everywhere: not connected, waiting, connected and needs attention. Needs attention has four reasons: the Discord account never joined the server, it left the server, Discord's membership screening is still open, or the game shares something new since the player last gave consent.

Opening the link

Never open the link in a web view inside the game: Discord blocks sign-in there. The kit never reads the window or the sheet it opened. It polls for the result, so nothing depends on a phone switching back to the game.

What a kit stores

Two things must persist after the game is closed, and both are private to the device: the refresh token, and the open session with the secret that reads its result. Every kit writes them as one JSON string under one key, ceejay.connect, in the device's secure store: the Keychain on Apple platforms, the Keystore on Android. The Godot addon cannot reach either, and says so: it stores an encrypted file, and has an interface for a store of your own.

What a kit sends

A kit communicates only with your community's CEEJAY instance. It sends the two headers Authorization and Content-Type, and these values:

• the player ID your game gives it, and the player's name, language and age, if you pass them;
• the device's sign-in: the refresh token and the player session that CEEJAY issued to this device, and, if you pass one, the Firebase or Unity token, the Steam ticket or the connect pass that proves the player.

It sends nothing else: no advertising ID, no device ID, no location, no contacts, no analytics and no crash reports. The Discord sign-in happens in the browser on CEEJAY's page, not in your game. As with any request, CEEJAY's server sees the device's IP address.

This is what to put on the store's privacy form for the kit. Your own declarations depend on everything else your game does.

Related

• Connect explains the flow, the confirmation from both the member and the game, and the proof levels.
• Connect for any engine gives the seven requests as plain HTTP.
• The Connect client of the TypeScript SDK is the reference every kit follows.
• Errors lists every code of Connect.