Installation

Server owner: add a server

1. Install the current GKS Phone resource and make the server reachable from the internet.
2. Sign in to GKShop with Discord and open Services → Companion Collectibles.
3. Select Add server. Enter the server ID used in Config.Companion.ServerId, a display name, and the public server base URL. The URL must pass the Companion health check.
4. Copy the generated ServerId, PairingSecret, and ApiBaseUrl values into Config.Companion in LUA/config/config.lua. Keep PairingSecret private.
5. Restart the gksphone resource.
6. Set the server timezone in the Companion panel. Daily Packs and Drops require a valid timezone.
7. Add active cards to the server's Card pool. Viewers can earn cards only from that server's pool.

Streamer: install and connect

1. In Twitch Creator Dashboard, find GKS Companion under Extensions, install it, and activate it on the channel.
2. Open the extension's Configuration view and select the server you play on.
3. Generate a game code. In FiveM, join that server with the character you want to link and run the displayed /twitchlink <CODE> command.
4. Wait for the extension to confirm Game character linked. Repeat pairing if you switch to another server or character.

Start a Streamer Drop

1. Open GKS Companion → Live Config in Twitch Creator Dashboard as the channel broadcaster.
2. Select Start Drop. Each Twitch channel can start one Drop per server-local day.
3. Viewers join from the giveaway banner in the extension. The active timer and participant count appear in Live Config.

Viewer rewards

• Keep the GKS Companion extension open and visible while watching to progress toward the Daily Pack reward.
• Open Collectibles to open earned packs, view cards, and check the leaderboard.
• Link a Twitch identity when prompted to search for a viewer's showcase or use identity-based features.