⚙️ Configuration

Configuration File

[!WARNING] Don't touch the first line of the configuration file

Config, Event, Phone, Iban = {}, {}, {}, {}

Framework Settings

Configure your server's framework and core resource:

-- Use "esx" or "qb"
Config.Framework = "esx"
-- Default ESX: "esx:getSharedObject" | Default QB: "qb-core"
Config.Core = "esx:getSharedObject"
-- Your server name
Config.ServerName = "SERVERNAME"
-- oxmysql, mysql-async or ghmattisql
Config.Mysql = "oxmysql"

URL Configuration

Set URLs for external services and buttons:

-- This will open when you click on the EARN MONEY button
Config.discordurl = "https://discord.gg/KDBKx7KVcc"
-- This will open when you click on the SHOP button
Config.website = "https://bit.tebex.io"
-- Insert here the command you use on your server to send reports
Config.reportCommand = "report"

Feature Toggles

Enable or disable specific features:

-- If you have the bit battlepass set to true
Config.battlepass = false
-- False to open the default esx inventory, true if you use a custom inventory
Config.CustomInventory = true
-- If you want to keep the old menu on the "P" key
Config.OldMenuOnPKey = true

Custom Commands

Configure custom commands for specific tabs:

-- For custom "earn money" command
Config.customEarnMoneyTab = true
Config.earnMoneyTabCommand = "bp"
-- For custom "shop" command
Config.customShopTab = false
Config.shopTabCommand = ""
-- For custom "inventory" command
Config.customInventoryTab = false
Config.inventoryTabCommand = ""

Event Configuration

Configure the next server event to display in the pause menu:

-- NEXT EVENT DATA
Event.title = "Race 16/05/22"
Event.image = "https://example.com/event-image.jpg"
Event.text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit..."

Custom Inventory

If you use a custom inventory system, configure the export/trigger:

-- CUSTOM INVENTORY FUNCTION
function CustomInventoryExport()
    TriggerEvent('bit-inventory:openInv')
end

Don't touch if you don't know what you're doing!

Phone Configuration

Configure phone number display and integration:

-- If you want the user's phone number to be shown
Config.ShowPhone = true
-- Set to true if you use Quasar Smartphone
Config.useQuasarSmartphone = false
-- True only if you use a custom phone
Config.useCustomPhone = false

Phone Database Settings

Default configuration for ESX and QBCore:

-- PHONE || Don't touch if you don't know what you're doing!!
if Config.Framework == "esx" then
    Phone.Table = "users"
    Phone.ColumnKey = "identifier"
    Phone.ColumnPhone = "phone_number"
elseif Config.Framework == "qb" then
    Phone.Table = "players"
    Phone.ColumnKey = "citizenid"
    Phone.ColumnPhone = "charinfo"
end

Custom Phone Query

For custom phone systems:

-- ONLY IF YOU USE A CUSTOM PHONE SCRIPT
function customPhoneQuery(xPlayer)
    ---EXAMPLE---
    local phone = SqlFunc(Config.Mysql,'fetchAll','SELECT phone_number FROM users WHERE identifier = @identifier', {['@identifier'] = xPlayer.identifier})
    -------------
    return phone
end

Money Display

Function to retrieve player money (cash and bank):

function getUserMoney(xPlayer)
    if Config.Framework == "esx" then
        cash = xPlayer.getMoney()
        bank = xPlayer.getAccount('bank').money
    elseif Config.Framework == "qb" then
        cash = xPlayer.PlayerData.money.cash
        bank = xPlayer.PlayerData.money.bank
    end
    return cash, bank
end

IBAN Configuration

Configure IBAN display and database settings:

-- If you want the user's IBAN to be displayed
Config.ShowIBAN = true
Config.customIban = false

IBAN Database Settings

Default configuration for ESX and QBCore:

-- IBAN || Don't touch if you don't know what you're doing!!
if Config.Framework == "esx" then
    Iban.Table = "users"
    Iban.ColumnKey = "identifier"
    Iban.ColumnIban = "iban"
elseif Config.Framework == "qb" then
    Iban.Table = "players"
    Iban.ColumnKey = "citizenid"
    Iban.ColumnIban = "iban"
end

Custom IBAN Query

For custom banking systems:

-- ONLY IF YOU USE A CUSTOM IBAN
function customIban(xPlayer)
    ---EXAMPLE---
    local iban = SqlFunc(Config.Mysql,'fetchAll','SELECT iban FROM users WHERE identifier= @identifier', {['@identifier'] = xPlayer.identifier})
    for k, v in pairs (iban) do
        iban = v.iban
    end
    -------------
    return iban
end

Configuration Tips

• Server Name: Set your server's display name for the pause menu header
• MySQL Wrapper: Ensure the correct MySQL wrapper is set (oxmysql, mysql-async, or ghmattimysql)
• Custom Inventory: If using a custom inventory, set Config.CustomInventory = true and configure the export function
• Battlepass: Only enable if you have BIT-Battlepass installed
• Phone/IBAN: These features can be disabled if your server doesn't use them
• Old Menu: Keep enabled if players want access to the default FiveM pause menu
• Report Command: Set this to match your server's report system command
• Event Data: Update regularly to keep players informed of upcoming events
• URLs: Use your actual Discord invite and Tebex store links

Advanced Configuration

For advanced users, you can modify the database queries and functions to match your specific server setup. Always backup your configuration before making changes.