📔Installation

This comprehensive guide will walk you through the installation process of GKSPHONE V2. Follow each step carefully to ensure a successful installation.

Critical Prerequisites:

Use WinSCP for FTP file transfers. FileZilla may corrupt files during transfer.
If upgrading from v1 to v2, you must remove all gksphone_* tables from your database before proceeding.

Step 1: File Structure Setup

Create the proper directory structure for GKSPHONE V2:

Navigate to your server's resources folder
Create a [phone] folder inside the resources directory
Extract all files from the downloaded zip into this [phone] folder

Expected Directory Structure:

resources/
└── [phone]/
    └── gksphone/
        ├── config/
        ├── client/
        ├── server/
        └── ...

Step 2: Item Configuration

Configure phone items based on your inventory system:

Add these items to your qb-core/shared/items.lua file:

-- Phone Items
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'
},

-- Powerbank Item (Optional)
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'
},

Add the following to ox_inventory/data/items.lua. If you already have phone or iphone items, replace them with this data.

["phone"] = {
    label = "Phone",
    weight = 190,
    stack = false,
    consume = 0,
    client = {
        export = "gksphone.UsePhoneItem",
        remove = function()
            TriggerEvent("gksphone:client:ItemRemoved", "phone")
        end,
        add = function()
            TriggerEvent("gksphone:client:ItemAdded", "phone")
        end
    }
},

["iphone"] = {
    label = "iPhone",
    weight = 190,
    stack = false,
    consume = 0,
    client = {
        export = "gksphone.UsePhoneItem",
        remove = function()
            TriggerEvent("gksphone:client:ItemRemoved", "iphone")
        end,
        add = function()
            TriggerEvent("gksphone:client:ItemAdded", "iphone")
        end
    }
},

-- Powerbank Item (Optional)
["powerbank"] = {
    label = "Powerbank",
    weight = 190,
    stack = false,
    consume = 1,
    client = {
        event = "gksphone:client:powerbank"
    }
},

ESX includes a default phone item. Add only the iPhone item by running this SQL query:

INSERT INTO `items` (`name`, `label`) VALUES ('iphone', 'iPhone');

Step 3: Database Setup

Before running the SQL file, make sure to delete all tables starting with gksphone_ in your database.

Automatic Setup Available: If you enable Config.DatabaseAutoSetup in gksphone/config/config.lua, the system will automatically create the required database tables. You can skip the manual SQL step.

Manual Database Setup

Important: Delete all existing gksphone_* tables from your database
Run the gksphone/gksphonev2.sql file in your database management tool

Step 4: Framework Configuration

Supported Frameworks: ESX, QB-Core, Qbox There is also a standalone file that you can customize for your own framework.

If you haven't changed your framework's source file name, you can leave this as "auto" for automatic detection.

Open gksphone/config/config.lua
Set Config.Framework to match your server framework:
- "esx" for ESX
- "qb" for QB-Core
- "qbx" for Qbox
- "auto" for automatic detection

Step 5: Server Configuration

Configure your server settings in gksphone/config/serverconfig.lua:

Media Service Setup

You can use any media service you prefer. We recommend GKS Media, Fivemerr, or Fivemanage.

If you are having trouble taking a photo, you may have filled out the fields below incorrectly.

serverconfig.lua

-- Available options: "fivemanage", "fivemerr", "gksmedia", "customMedia" 
Cfg.MediaService = ""

-- Authentication tokens for your chosen service
Cfg.AuthTokenImage = ""    -- Image upload token/API key
Cfg.AuthTokenAudio = ""    -- Audio upload token/API key
Cfg.AuthTokenVideo = ""    -- Video upload token/API key

Music and PlayTube App Configuration

You must enter your GKSPHONE purchase transaction ID in Cfg.TebexTransactionID in the serverconfig.lua file. If you don't know your transaction ID, check your Tebex purchase history.

Important: Keep your Tebex ID secure. Support cannot help recover lost transaction IDs.

Application Logging Configuration

Discord Webhooks: Enter Discord webhook URLs for applications you want to log in the serverconfig.lua file.

Fivemanage Logs: Ensure fmsdk is installed for Fivemanage logging support.

Step 6: Server Startup Configuration

Add GKSPHONE to your server.cfg file. Order is important - ensure dependencies start before the phone system:

# Core Framework (Required first)
ensure pma-voice
ensure oxmysql
ensure es_extended  # or qb-core

# Dependencies (Must start before phone)
ensure your_eyetarget
ensure your_banking
ensure your_inventory
ensure your_housing
ensure your_garages

# Other scripts can start before or after phone
ensure other_scripts

# Phone System (Start last)
ensure [phone]

Installation Complete! After completing all steps, restart your server. The GKSPHONE V2 system should now be active and ready for use.

PreviousFiveM Asset Escrow System NextDocumentation

Last updated 0 minutes ago