Installation
Register your server at app.gkshop.org and connect the published Twitch Extension.
1. Prepare the FiveM server
Companion needs GKSPHONE v2.8.4 or later. In gksphone/config/config.lua, enable Companion and choose the server ID you will register:
Config.Companion = {
Enabled = true,
ServerId = "YOUR_SERVER_ID",
PairingSecret = "",
}Restart the phone resource. The server's public HTTP endpoint must be reachable from the internet; a local address such as localhost will not work.
The pairing secret is added after registration. Character pairing will not work until step 2 is complete. Real App does not need to be enabled for Companion.
2. Register at app.gkshop.org
- Open app.gkshop.org and select Continue with Discord.
- Open Services → Companion Collectibles, or use the direct dashboard link.
- Select Add server and complete the fields below.
- Select Verify and add. The service checks the public endpoint before registering it.
- Use Copy config in the setup dialog. Replace
Config.Companioningksphone/config/config.luawith the generated block and restart the phone resource.
| Field | What to enter |
|---|---|
| Server ID | The same ID used in Config.Companion.ServerId. |
| Display name | The name shown to streamers in the server selector. |
| Public server base URL | A public HTTP or HTTPS address with its port if needed, e.g. https://fivem.example.com:30120. Do not include an API path, query, or fragment. |
| Allow streamers to select this server in the Twitch extension | Enable this to make the server available in the broadcaster's server selector. |
Save the generated PairingSecret privately. It is shown only when generated and cannot be retrieved later. Do not share it in screenshots, repositories, or chat. If lost, generate a replacement, update the server configuration, and restart the resource.
The generated block uses Enabled, ServerId, and PairingSecret. There is no ApiBaseUrl setting to fill in.
3. Check settings and cards
Select your server in the dashboard:
- Confirm Companion enabled is on and use Save features for the features you want to expose.
- Review Timezone. New registrations default to UTC; choose an IANA timezone such as
Europe/Istanbulfor a different daily reset. Changes to an existing timezone apply at the next midnight in the current timezone. - Review Card pool. A new server with no existing cards receives starter cards. Keep at least three different active cards so packs can open.
See Dashboard management for artwork, credentials, feature toggles, and resets.
4. Install and pair the Twitch Extension
- Open GKS Companion in Twitch Creator Dashboard, install it, and activate it as a Video Overlay.
- As the broadcaster, open Configuration and select the server you play on.
- Generate a game code. Join that FiveM server with the character you want to link, then run the displayed command in game:
/twitchlink YOUR_CODE- Wait for GAME CHARACTER LINKED in Configuration. Generate a fresh code if it expires. Pair again to link a different server or character.
The short-lived game code is different from PairingSecret. Streamers use the game code; the server owner manages the credential.
5. Check viewer features and rewards
Start a stream with the configured server available and open the extension from the video player's extension rail. Check News, Socials, and Collectibles. Viewers need no app.gkshop.org account or FiveM character; Twitch identity sharing is requested for features that need it.
Daily Pack progress counts while the extension reports itself visible and the player is not paused. Follow the target duration in Collectibles. The Collectibles panel itself does not need to stay open; hidden or paused sessions do not count.
Start a Streamer Drop
Open Live Configuration as the broadcaster and select Start Drop. Drops last 10 minutes. Each channel can start one per server-local day. Logged-in viewers who share Twitch identity can enter once; one eligible entrant wins a pack. Each viewer can win one Drop per server-local day.
Results appear automatically. No eligible entries or a cancelled Drop means no reward. No purchase, follow, subscription, or Bits payment is required. The broadcaster organizes the Drop and is responsible for communicating its rules and Twitch non-sponsorship disclosure to participants.

