Start

FX Phone

What FX Phone is, what it needs, what is in the package and where to go next.

#What it is

FX Phone (fx-phone) is a smartphone resource for FiveM servers. It has a lock screen, a home screen with widgets, a Dynamic Island, a control centre, notifications and a set of built-in apps for calls, messages, media, banking, invoices, company lines, classifieds, news and social networks.

It runs on QBCore, Qbox, ESX or without a framework, keeps its data in its own fx_phone_* database tables, and ships an admin tablet, console, file and Discord logging, daily snapshots and a migration command for cylex_phone data.

Other resources connect to it through client and server exports, events, state bags and iframe custom apps. The exports also answer to the lb-phone and cylex_phone names.

#Requirements

Requirement Notes
oxmysql Required. The only dependency in the manifest
MySQL 5.7+ or MariaDB 10.3+ Required. The tables are created on start
Framework QBCore, Qbox, ESX or none. Detected automatically; other frameworks through bridge/custom.lua
Inventory ox_inventory, qb-inventory (or any inventory that keeps items in QBCore player data), or none
Voice pma-voice, mumble-voip or SaltyChat, needed for call audio
Upload provider Fivemanage, the Fixitfy relay or your own HTTP host, needed for photos, videos and voice messages

Optional resources:

Resource What it adds
fx-phone-assets The phone model in the hand in the player's colour, cases and accessories, the shop showroom
fx-sound or xsound Ringtones and notification sounds that nearby players hear
A bank resource IBANs and job accounts: tgiann-bank, qb-management, Renewed-Banking, or esx_society with esx_addonaccount
A weather sync The Weather app reads the server's weather: Renewed-Weathersync, qb-weathersync, cd_easytime
ox_target Used by the phone shop counter when it runs
fx-3dmap Phone shops and Anon traces on the 3D map
GIPHY or Tenor key GIF search in Messages

#What is in the package

Folder What it is
fx-phone The phone itself: client, server, interface, configs, locales, setup files
fx-phone-assets Streamed models only (phone bodies, cases, accessories). It has no scripts
[fx-apps] The bundled Fixitfy app resources, each a resource of its own that registers into the phone

The bundled app resources:

Resource App Page
fx-billingapp Billing: invoices Billing
fx-companyapp Company: employees, funds, directory Company
fx-garageapp My Vehicles: garage and valet Garage
fx-metubeapp MeTube: videos and TV screens MeTube
fx-musicapp Music: streaming, speakers, Dynamic Island Music
fx-mapsapp Maps: friends' live locations Maps
fx-orderapp Order: businesses, menus, delivery, couriers Order
fx-rentalapp Rental: player-to-player car rental Rental
fx-fansapp Fans: creator subscriptions Fans
fx-casinoapps Fixitfy Play: phone games Casino
fx-sound 3D sound engine used for ringtones and speakers Sound

Each bundled app can be kept from starting with Config.BundledApps. See Apps configuration.

#Files you can edit

File What it holds
config.lua General settings: language, key, item, framework, inventory, voice, numbers, currency
configs/config_<topic>.lua One file per app or topic
config_server.lua Upload keys, webhooks, GIF and price API keys, number and IBAN generators, console commands. Server only
locales/*.json Every text, including log text
bridge/*.lua Framework adapters and custom.lua, a template for your own framework
client/integrations/, server/integrations/ Inventory, voice, screenshot, bank, upload and GIF adapters
setup/** SQL, tools, item definitions, compatibility shims

#Where to go next