Real App
Set up the GKSPHONE companion app for iOS and Android so players stay reachable away from the server.
The Real App is a published mobile app that connects to your server. Players read and reply to messages, follow the social feeds and get notifications from a real phone while they are not in game. It is included with GKSPHONE V2.
| Platform | |
|---|---|
| iOS | App Store |
| Android | Google Play |
| Demo | YouTube |
Which features sync is decided per server when you register it — see below.
Requirements
| GKSPHONE version | v2.3.0 or above |
| Discord | The GKSHOP customer role, to run the registration commands |
| Server | gksphone running and reachable. Private servers need an endpoint |
1. Configure the phone
In gksphone/config/config.lua:
Config.RealApplication = true
Config.RealAppJoinCode = "a8q9z5" -- just the code from cfx.re/join/a8q9z5Paste the full URL by mistake and the phone strips it back to the code on start, with a warning in the console. A code with anything other than letters and digits is rejected outright and blanked, which disables Real App login — check the console if it stops working.
Finding your join code
It is the last part of your server's join link: https://cfx.re/join/a8q9z5 → a8q9z5. The same code goes in the Discord commands below.
2. Register the server on Discord
Run these in the commands channel under General. Only the account that registered a server can edit or remove it.
| Command | Does |
|---|---|
/addserver serverid: [endpoint:] | Registers the server, then opens a menu to pick which apps sync |
/listservers | Lists your registered servers and their active apps |
/editserver serverid: [endpoint:] | Re-opens the app selection menu |
/removeserver serverid: | Removes the server permanently |
/addserver serverid:a8q9z5 endpoint:123.45.67.89:30120The bot checks the server is live before registering. Public servers don't need endpoint — only private ones do.
3. Players log in
Login is by QR code, so nobody types a server address:
- On the in-game phone, open Settings → About → Log in with QR.
- Scan the code with the Real App.
- The app is now bound to that character's phone.
The option only appears once the server has been registered and the phone reports Real App as available.
The QR code authenticates that phone. A player who shares a screenshot of it hands over their account.
Troubleshooting
| Message | Cause |
|---|---|
| Server is not responding to gksphone | gksphone isn't running, or isn't reachable from outside. Private servers need a working endpoint |
| You do not have permission | Your Discord account is missing the GKSHOP customer role — see Discord Roles |
| Server not found or you are not the owner | No record for that ID, or someone else registered it |
| QR login does nothing | Config.RealApplication is false, or Config.RealAppJoinCode was blanked for containing invalid characters |