Installation

Extract the files

Unzip the download into a [phone] folder inside your server's resources directory.

resources/
└── [phone]/
    ├── gksphone/
    │   ├── config/
    │   ├── client/
    │   ├── server/
    │   └── ...
    ├── gks-tablet/
    ├── gksphone_prop/
    └── gks-sound/

All four ship in the same download. One folder, one ensure [phone] line later.

Add the phone items

The phone is item-gated by default. Two items decide which theme a player gets:

Rename them in Config.ItemName if yours differ. To skip items entirely: Config.ItemRequire = false plus Config.DefaultPhoneModel.

Watch items

Only needed if you set Config.Watch.ItemRequire = true — it is false out of the box and everyone wears Config.Watch.DefaultModel.

Five plain items, one per case. No metadata and no client export, so the same definition works on every inventory:

["watch_black"] = {
    label = "Watch",
    weight = 90,
    stack = false,
    consume = 0,
},

Ship only the cases you want. Rename them in Config.Watch.ItemName — the left side is your item, the right side is the model.

phone = {
    name = 'phone',
    label = 'Phone',
    weight = 700,
    type = 'item',
    image = 'phone.png',
    unique = true,
    useable = true,
    shouldClose = true,
    combinable = nil,
    description = 'Neat phone ya got there'
},

iphone = {
    name = 'iphone',
    label = 'iPhone',
    weight = 1000,
    type = 'item',
    image = 'iphone.png',
    unique = true,
    useable = true,
    shouldClose = true,
    combinable = nil,
    description = 'Very expensive phone'
},

-- Only needed if the charging system is enabled
powerbank = {
    name = 'powerbank',
    label = 'Powerbank',
    weight = 200,
    type = 'item',
    image = 'powerbank.png',
    unique = true,
    useable = true,
    shouldClose = true,
    combinable = nil,
    description = 'To charge the phone'
},

Set up the database

Doing it manually instead:

1. Drop every existing gksphone_* table.
2. Import gksphone/gksphonev2.sql.
3. Import gks-tablet/install.sql.

Select your framework

Set Config.Framework in both gksphone/config/config.lua and gks-tablet/config/config.lua.

Config.Inventory works the same way — see Overview for the accepted values.

Configure the server side

In gksphone/config/serverconfig.lua and gks-tablet/config/serverconfig.lua.

Media service

Photos, videos and voice memos upload to an external host. Pick one and paste its tokens:

-- "fivemanage" | "gksmedia" | "customMedia"
Cfg.MediaService = "fivemanage"

Cfg.AuthTokenImage = "API_TOKEN"
Cfg.AuthTokenAudio = "API_TOKEN"
Cfg.AuthTokenVideo = "API_TOKEN"

Leaving these as API_TOKEN is why the camera "does nothing" on a fresh install.

Logging

Pick the service, then paste a Discord webhook against each event you want logged. Leave a key empty to skip that event. For fivemanage, also install fmsdk.

Cfg.LogService = "discord"   -- "discord" or "fivemanage"

Cfg.DiscordWebHooks = {
    ['bank'] = "https://discord.com/api/webhooks/...",
    ['cryptoBuy'] = "",
    ['dispatchSendReport'] = "",
    ['squawkPost'] = "",
    -- 48 keys in the file; fill in only the ones you want
}

Video calling has its own setup — see WebRTC.

Add it to server.cfg

Everything the phone reads from must start first:

# Database and framework
ensure oxmysql
ensure es_extended        # or qb-core / qbx_core

# Voice
ensure pma-voice

# Anything the phone integrates with
ensure your_inventory
ensure your_banking
ensure your_housing
ensure your_garages
ensure your_eyetarget

# The phone last
ensure [phone]

Voice defaults to pma-voice. For mumble-voip: Config.PMAVoice = false, Config.UseMumbleVoIP = true.

Start and check

Restart the server, then confirm:

• The console shows the phone starting with no red errors.
• gksphone_* tables exist in your database.
• F1 or /phone opens the phone (Config.OpenPhone, Config.RegisterCommandName).
• Taking a photo in the Camera app produces an image.

Anything off: Common Issues.

Back up what you have

Zip your current gksphone folder and keep it. Copy config/config.lua and config/serverconfig.lua somewhere separate too — you will want to diff them.

Delete the old version

Remove the existing gksphone folder from [phone].

Download the latest build

Grab it from the Cfx.re Portal.

Reapply your config

Compare your saved config.lua and serverconfig.lua against the new ones and merge your changes across. Copying the old files over wholesale will drop any settings added since your last update.