> For the complete documentation index, see [llms.txt](https://cylexdev.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cylexdev.gitbook.io/docs/scripts/cylex-phone/introduction.md).

# Introduction

Cylex Phone is a smartphone for FiveM with around 40 apps and games: calls, messages, social media, bank and crypto, casino, music, camera and more. For QBCore, Qbox, ESX and mCore.

<div data-full-width="true"><figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2FP6LYzovsrD6xqOfqIb4a%2Fcylex-phone.png?alt=media" alt="Cylex Phone"><figcaption></figcaption></figure></div>

Cylex Phone is a full smartphone for your FiveM server.\
Players call and text each other, post on five social apps, send money, take photos and videos, order food and play games, all on one phone.\
It finds your framework and your inventory, garage, housing, boss menu and voice scripts by itself, and leaves every settings, language and integration file open to edit.

You can try the phone in your browser at [phone.cylexdev.com](https://phone.cylexdev.com). That page also has the full changelog. It only shows the screens: there is no game server behind it, so money, calls and live data do nothing there.

### Key Features <a href="#key-features" id="key-features"></a>

* Around 40 apps and games. Players add and remove apps in the App Store, and set up their home screen with widgets, wallpapers, light and dark themes and lock screen styles.
* Calls and video calls, Messages with group chats, photos, voice messages, locations and money requests, plus Contacts, Mail and AirDrop.
* Five social apps: Frogger (short posts), Frogram (photos and stories), Foffy (short videos), Frogly (paid posts) and Swiper (dating). Live streaming with chat and donations.
* Bank with IBAN transfers, a crypto market with real prices, Billing with a share for each job, and Company for bosses: society money, hiring, firing, duty and job calls.
* Casino with Dice, Plinko and Mines. Part of what players lose goes to the casino job.
* Frogeats food ordering, Yellow Pages, News, Cars (garage with valet), Home (house keys and doors), Racing, Music, Metube, Health, Weather, Notes, Clock, Darkchat and Hacker.
* Five built-in games with daily, weekly and all-time leaderboards.
* Ringtones and notification sounds that nearby players hear in 3D.
* Discord webhook logs for calls, messages, bank transfers, bills, company money, casino results and more.
* A setup check in the server console on every start that names wrong settings and missing scripts.
* Three languages: English, Turkish and Dutch.

### Installation Steps <a href="#installation-steps" id="installation-steps"></a>

{% content-ref url="/pages/7qfVhwXWK4Ygdp0I2BI9" %}
[Installation & Configuration](/docs/scripts/cylex-phone/installation-and-configuration.md)
{% endcontent-ref %}

{% content-ref url="/pages/oI9748ZN6mFnG1ugsx6Y" %}
[Exports & Events](/docs/scripts/cylex-phone/exports-and-events.md)
{% endcontent-ref %}

{% content-ref url="/pages/FZa36zKd1HrrnAW1MLy4" %}
[Frequently Asked Questions](/docs/scripts/cylex-phone/frequently-asked-questions.md)
{% endcontent-ref %}

{% content-ref url="/pages/xLEmtNvQMSRB5J6qku9A" %}
[Troubleshooting Common Issues](/docs/scripts/cylex-phone/troubleshooting-common-issues.md)
{% endcontent-ref %}

### Dependencies <a href="#dependencies" id="dependencies"></a>

| Dependency                     | Required            | Notes                                                                                                                                                                  |
| ------------------------------ | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| oxmysql                        | **Yes**             | Database connector. The phone creates its own tables.                                                                                                                  |
| QBCore, Qbox, ESX **or** mCore | **Yes**             | Found by itself.                                                                                                                                                       |
| A voice script                 | **Yes**             | pma-voice, mumble-voip, saltychat, tokovoip\_script or bs-voice. Calls use it. Found by itself.                                                                        |
| Fivemanage API token           | **Yes**, for media  | Photos, videos and voice messages are uploaded to Fivemanage. See [Installation & Configuration](/docs/scripts/cylex-phone/installation-and-configuration.md), Step 4. |
| screenshot-basic               | For video recording | Makes the cover picture of a recorded video.                                                                                                                           |
| An inventory                   | Optional            | ox\_inventory, qb-inventory, origen\_inventory, tgiann-inventory or mInventory. With one, players need the `phone` item. Without one, nobody needs an item.            |
| A garage script                | Optional            | qb-garages, jg-advancedgarages, nation-garages, tgiann-realparking, op-garages or mGarage, for the Cars app.                                                           |
| A housing script               | Optional            | cylex\_housing, loaf\_housing or origen\_housing, for the Home app.                                                                                                    |
| A boss menu                    | Optional            | qb-management (or qb-banking), renewed-banking, nation-management or esx\_society, for company money in the Company app.                                               |

{% hint style="warning" %}
Part of the phone's code is downloaded from the Cylex server each time the resource starts. Your server needs internet access, and the license key in server.cfg (`sv_licenseKey`) must belong to the same Cfx.re account that bought the script.
{% endhint %}

### What You Can Edit <a href="#what-you-can-edit" id="what-you-can-edit"></a>

All settings, texts and integrations are open. The phone's own logic is protected.

| File / Folder                                                                                | Editable?                                                                                         |
| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `editable/cl_config.lua`                                                                     | Yes — main settings, app list, companies, billing jobs, casino, camera filters                    |
| `editable/sv_config.lua`                                                                     | Yes — upload token, webhooks, delete timers, phone number and IBAN format, crypto, admin commands |
| `editable/music_config.lua`, `racing_config.lua`, `hacker_config.lua`, `frogeats_config.lua` | Yes — settings of these apps                                                                      |
| `editable/cl_functions.lua`                                                                  | Yes — open key, call keys, vehicle keys for the valet, fuel, duty                                 |
| `editable/autodetect.lua`                                                                    | Yes — the list of supported integration scripts                                                   |
| `editable/frameworks/`                                                                       | Yes — inventory, garage, housing, boss menu and racing item bridges                               |
| `editable/components/`                                                                       | Yes — what happens on death, speaker and voice                                                    |
| `locales/*.lua`                                                                              | Yes — every text players see                                                                      |
| `cylex_youtubeApp/config.lua`                                                                | Yes — sharing videos to TVs                                                                       |
| `client/cl_cloudsync.lua`, `server/sv_cloudsync.lua`                                         | No — the loader that downloads the phone's code                                                   |
| `html/`                                                                                      | No — the built phone interface                                                                    |

### Support <a href="#support" id="support"></a>

Store: <https://cylexdev.com>\
Discord: <https://discord.gg/cylexstore>\
Live demo and changelog: <https://phone.cylexdev.com>
