> For the complete documentation index, see [llms.txt](https://docs.gkshop.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gkshop.org/gksphone-v2/real-app.md).

# Real App

***

### What is the Real App?

Most FiveM phone scripts only work **inside the game client**. GKSPHONE goes further: players can install a **real mobile app** on their phone and continue parts of their roleplay from anywhere.

| In-game phone          | Real App (companion)                                              |
| ---------------------- | ----------------------------------------------------------------- |
| Full UI inside FiveM   | Lightweight app on iOS / Android                                  |
| Used while playing     | Used away from the PC                                             |
| All 35+ apps           | Selected connected features (messages, feed, notifications, etc.) |
| Requires FiveM running | Connects to your registered server                                |

**In short:** The in-game phone is the full experience. The Real App extends that experience to a real device — keeping players engaged with the city 24/7.

***

### Why server owners enable it

* **Higher player retention** — players stay connected between sessions
* **Deeper roleplay** — reply to messages, follow timelines, react to events on a real phone
* **Modern server image** — a published App Store / Play Store app, not a browser hack
* **Included with GKSPHONE V2** — no separate phone script purchase; Real App connects to your GKSPHONE server

***

### What players can do

Depending on the apps you enable for your server, players can typically:

* **Read and reply to messages** from their FiveM contacts
* **Follow the social feed / timeline** (SnapGram, Squawk, and connected apps)
* **Receive push notifications** for in-city events
* **Stay in the loop** when away from their PC

{% hint style="info" %}
Exact available features depend on which applications you enable when registering your server via Discord (see **Server registration** below).
{% endhint %}

***

### Download the app

The GKSPHONE Real App is available on official app stores:

| Platform                  | Link                                                                                                                           |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| **iOS (App Store)**       | [apps.apple.com/app/gksphone/id6694655432](https://apps.apple.com/app/gksphone/id6694655432)                                   |
| **Android (Google Play)** | [play.google.com/store/apps/details?id=org.gkshop.gksphone](https://play.google.com/store/apps/details?id=org.gkshop.gksphone) |

**Demo video:** [GKSPHONE Real App on YouTube](https://www.youtube.com/watch?v=hH7EKi7ubVY)

***

### Requirements

Before setting up the Real App, make sure:

| Requirement          | Details                                                                          |
| -------------------- | -------------------------------------------------------------------------------- |
| **GKSPHONE V2**      | Real App requires GKSPHONE V2 on your FiveM server                               |
| **Minimum version**  | GKSPHONE **v2.3.0 or above**                                                     |
| **Config**           | `Config.RealApplication = true` in `gksphone/config/config.lua`                  |
| **Join code**        | `Config.RealAppJoinCode` must contain your server ID                             |
| **Discord role**     | Server owner needs the designated GKSPHONE Discord role to register servers      |
| **Running resource** | `gksphone` must be running and reachable (private servers need a valid endpoint) |

{% hint style="danger" %}
Compatible with **Gksphone v2.3.0 and above** only. Older versions are not supported.
{% endhint %}

***

### Setup overview

For server owners — high-level flow before the detailed commands:

1. **Configure GKSPHONE** — enable Real App in `config.lua` and set your server join code
2. **Register your server** — use Discord bot commands (`/addserver`) to link your FiveM server and choose which apps sync to the Real App
3. **Players install the app** — download from App Store or Google Play, select your server, and log in

***

### Server registration (Discord bot)

This section explains how to register and manage servers via the Discord bot.

#### Prerequisites

* To use these commands, you must have the designated **GKSPHONE role** on the Discord server.
* The server you want to register must have `gksphone` integration enabled.
* Ensure that `Config.RealApplication = true` is set in `gksphone/config/config.lua`.
* In `gksphone/config/config.lua`, fill in the `Config.RealAppJoinCode` field with your **server ID**.

#### Commands

You can perform the following actions in the commands channel under the **General** category.

**1. Register Server (`/addserver`)**

Used to register a new FiveM server into the system.

Public servers do not require endpoints. Private servers require endpoints.

* **Usage:** `/addserver serverid: [endpoint:http://ip:port]`
* **Example:** `/addserver serverid:a8q9z5 endpoint:123.45.67.89:30120`
* **Process:**
  1. The bot validates server information using the provided Server ID.
  2. If the server is active and accessible, a menu appears asking which applications (Apps) you want to use.
  3. Once apps are selected, the server registration is complete.

**2. List My Servers (`/listservers`)**

Displays a list of all servers registered by you, along with their active applications.

* **Usage:** `/listservers`

**3. Edit Server (`/editserver`)**

Used to modify the application settings of a previously registered server. Only the user who originally registered the server can use this command.

* **Usage:** `/editserver serverid: [endpoint:http://ip:port]`
* **Example:** `/editserver serverid:a8q9z5`
* **Process:**
  1. The bot checks if you are the owner of the server.
  2. It re-opens the application selection menu.
  3. You can update the server configuration by making new selections.

**4. Remove Server (`/removeserver`)**

Used to permanently remove a registered server from the system.

* **Usage:** `/removeserver serverid:`
* **Example:** `/removeserver serverid:a8q9z5`

***

### How to find your Server ID

You can find your CFX Join ID in the URL structure of your server's join link.

1. Locate your server on the FiveM server list or Keymaster.
2. Look at the URL (e.g. `https://cfx.re/join/a8q9z5`).
3. The last part of the URL (e.g. `a8q9z5`) is your **Server ID** — use this in `Config.RealAppJoinCode` and Discord commands.

***

### FAQ

#### Is the Real App a separate purchase?

The Real App is part of the **GKSPHONE V2 ecosystem**. Players download it free from the app stores; your server must run GKSPHONE V2 with Real App enabled.

#### Which GKSPHONE version do I need?

**v2.3.0 or above.**

#### Why does the bot say "Server is not responding to gksphone"?

Either `gksphone` is not running on your server, or it is not accessible externally. Check your `gksphone/config/config.lua` settings and ensure the resource is started.

#### Why "You do not have permission"?

You need the required GKSPHONE Discord role to use registration commands.

#### Why "Server not found or you are not the owner"?

No server record exists with that ID, or another user registered it.

#### Can players use the Real App without being in-game?

Yes — that is the purpose of the companion app. Enabled apps sync between the in-game phone and the Real App based on your server registration settings.

***

### Related links

| Resource         | URL                                                                  |
| ---------------- | -------------------------------------------------------------------- |
| Product overview | [GKSPHONE V2 Overview](https://docs.gkshop.org/gksphone-v2/overview) |
| Installation     | [Installation](https://docs.gkshop.org/gksphone-v2/installation)     |
| Configuration    | [Configuration](https://docs.gkshop.org/gksphone-v2/configuration)   |
| Website          | [gkshop.org](https://www.gkshop.org/)                                |
| Discord support  | [discord.com/invite/XUck63E](https://discord.com/invite/XUck63E)     |