Skip to main content

Installation Steps

1

Install dependencies

Verify all dependencies below are started before this script in your server.cfg.

ox_lib

Download ox_lib
2

Extract and place the resource

Extract the script from the zip file and place it into your standalone folder or a folder that starts before your scripts.
3

Add items to your inventory (Optional)

Add the items from below and the images from the images folder to your inventory. This is optional if you want to use the contacts history feature.
["x_burner"] = {
    label = "Burner Phone",
    weight = 100,
    stack = false,
    close = false,
    description = "Nothing suspicious about this phone..",
}
The image is provided in the folder that you downloaded.
4

Configure the resource

Open config.lua and adjust the settings to your liking. See the configuration section below for details.
5

Add to server.cfg

Make sure that the Framework, ox_lib, and Inventory are started before the script.
ensure ox_lib
ensure projectx-burner

Configuration

Below is the full configuration file with explanations for each option.
Config = Config or {}

Config = {
    Position = 'right',
    Duration = 10,
    DurationBasedOnLength = false,
    EnableProfilePics = true,

    ContactsHistory = {
        EnableItem = true,
        NoContactsNotification = "You don't have any active contacts",
        Duration = 15
    }
}

General Settings

Position
string
default:"right"
The position of the phone on the screen. Options: "left" or "right"
Duration
number
default:"10"
Duration in seconds that the phone will stay on screen after receiving a message
DurationBasedOnLength
boolean
default:"false"
If enabled, the duration will be calculated based on the length of the message instead of using the fixed Duration value
EnableProfilePics
boolean
default:"true"
Enable or disable the profile picture displayed above the sender name

Contacts History Settings

ContactsHistory.EnableItem
boolean
default:"true"
Enable the burner phone item for viewing contact history. If enabled, you need a supported framework (QBX, QB, ESX) or implement your own logic in server.lua. Don’t forget to add the item to your inventory!
ContactsHistory.NoContactsNotification
string
default:"You don't have any active contacts"
The notification message shown when the player has no active contacts (no messages received)
ContactsHistory.Duration
number
default:"15"
Duration in seconds that the contact history UI will stay open after selecting a contact