Config

Here your find our Config Preview

Configuration

All configuration is done through files in the shared/ directory. The system uses two main configuration files.

Configuration Files

File	Purpose	Editable
shared/config.lua	Main system settings	✅ Yes
shared/locale.lua	Language and text customization	✅ Yes

Important: These are the only files you can modify. Other files are protected by FiveM's asset escrow system.

Basic Settings

Access Controls

Configure how players access the coin shop:

Config.Keybind = {
    enabled = true,           -- Enable/disable keybind
    key = "F10",             -- Key to open shop
    mapper = "keyboard"       -- Input type
}

Config.Command = 'coinshop'   -- Chat command to open shop

Server Links

Config.ExternalLinks = {
    Discord = "https://discord.gg/your-server",
    Shop = "https://your-store.tebex.io"
}

Notification System

ESX Notification

Config.Notification = function(source, message, type)
    TriggerClientEvent('esx:showNotification', source, message)
end

QBCore Notification

Config.Notification = function(source, message, type)
    TriggerClientEvent('QBCore:Notify', source, message, type or 'primary')
end

Mythic Notify Integration

Config.Notification = function(source, message, type)
    TriggerClientEvent('mythic_notify:client:SendAlert', source, {
        type = type or 'inform', 
        text = message
    })
end

Database Configuration

ESX Configuration

Config.Database = {
    UserTable = 'users',
    CreditsColumn = 'credits',
    VehicleTable = 'owned_vehicles',
    VehicleOwnerColumn = 'owner',
    VehiclePlateColumn = 'plate'
}

QBCore Configuration

Config.Database = {
    UserTable = 'players',
    CreditsColumn = 'credits', 
    VehicleTable = 'player_vehicles',
    VehicleOwnerColumn = 'citizenid',
    VehiclePlateColumn = 'plate'
}

Hourly Rewards

Configure automatic coin distribution:

Config.HourlyCoins = {
    enabled = true,
    interval = 60,        -- Minutes between rewards
    minute = 30,          -- Minutes to wait for first reward
    amount = 15,          -- Coins per reward
    vipMultiplier = 2,    -- VIP multiplier
    message = nil         -- Custom message (nil = default)
}

VIP System

Configure VIP memberships:

Config.VIP = {
    DefaultDuration = 30,       -- Days
    Multipliers = {
        Coins = 2,              -- 2x hourly coins
        Rewards = 2             -- 2x mission rewards
    },
    PurchaseDiscount = 15,      -- 15% discount on money packs
    Title = "VIP Membership",
    Description = "Unlock premium benefits and exclusive features"
}

VIP Packages

Configure VIP packages available for purchase:

Config.Table[1].VIPPackages = {
    {
        label = "VIP 30 Days",
        name = "vip_30",
        coin = 1000,
        days = 30,
        desc = "1 Month VIP Membership",
        tag = "Popular",
        rarity = "rare"
    },
    {
        label = "VIP 60 Days",
        name = "vip_60",
        coin = 1800,
        days = 60,
        desc = "2 Months VIP Membership",
        tag = "Best Value",
        rarity = "epic"
    }
}

Tebex Integration

Configure coin packages for real money purchases:

Config.CoinPackages = {
    {coins = 100, tebexCommand = "tebex_coins100"},
    {coins = 250, tebexCommand = "tebex_coins250"},
    {coins = 500, tebexCommand = "tebex_coins500"},
    {coins = 1000, tebexCommand = "tebex_coins1000"},
    {coins = 2000, tebexCommand = "tebex_coins2000"},
    {coins = 5000, tebexCommand = "tebex_coins5000"}
}

The tebexCommand should match the command you set up in your Tebex store for each package.

Voting System

Configure server voting rewards:

Config.VotingSystem = {
    Enabled = true,
    VoteURL = "https://your-vote-site.com"
}

Vehicle Configuration

Rental Vehicles

Configure vehicles available for 7-day rental:

Config.Table[1].RentCar = {
    {label = "McLaren T20", name = "t20", coin = 455, category = "Sports"},
    {label = "Bugatti Adder", name = "adder", coin = 800, category = "Super"},
    {label = "Zentorno", name = "zentorno", coin = 750, category = "Super"}
}

Purchase Vehicles

Configure vehicles available for permanent purchase:

Config.Table[1].OwnedCar = {
    {
        label = "McLaren T20", 
        name = "t20", 
        coin = 4550, 
        category = "Sports",
        maximumspeed = "240 km/h",
        acceleration100 = "5.2s",
        fueltankcapacity = "80L"
    }
}

Item Shop Configuration

Configure items available for purchase:

Config.Table[1].Item = {
    {label = "Lockpick", name = "lockpick", category = "Tools", desc = "Used to pick locks", coin = 10},
    {label = "Radio", name = "radio", category = "Communication", desc = "Standard radio device", coin = 25},
    {label = "Repair Kit", name = "fixkit", category = "Tools", desc = "Vehicle repair kit", coin = 75}
}

Mystery Cases Configuration

Configure lootbox cases:

Config.Cases = {
    EnableCases = true,
    ShowOpeningHistory = true,
    MaxHistoryEntries = 10,
    Available = {
        {
            id = 'starter',
            name = 'Starter Case',
            description = 'Perfect for beginners',
            price = 25,
            image = '/ui/images/cases/starter-case.png',
            rarity = 'common',
            color = 'from-gray-500 to-gray-600',
            rewards = {
                { type = 'coin', item = 'Cue Coins', count = 25, rarity = 'common', chance = 40 },
                { type = 'item', item = 'lockpick', count = 3, rarity = 'common', chance = 30 },
                { type = 'coin', item = 'Cue Coins', count = 100, rarity = 'rare', chance = 5 }
            }
        }
    }
}

Case Reward Types

Type	Description	Example
coin	Gives coins to player	{ type = 'coin', item = 'Cue Coins', count = 50 }
item	Gives inventory item	{ type = 'item', item = 'lockpick', count = 3 }
car	Gives vehicle	{ type = 'car', item = 't20', count = 1 }

Money Conversion Packs

Configure coin-to-cash conversion:

Config.Table[1].BuyingCash = {
    {label = "Small Pack", price = 500, money = 25000, tag = "Standard", rarity = "common"},
    {label = "Medium Pack", price = 1000, money = 55000, tag = "Good Value", rarity = "uncommon"},
    {label = "Large Pack", price = 2000, money = 120000, tag = "Great Value", rarity = "rare"}
}

Test Drive System

Configure vehicle test drives:

Config.TestDrive = {
    seconds = 120,                              -- Duration in seconds
    coords = vector4(-1646.28, -2963.90, 13.94, 239.13),  -- Spawn location
    range = 400,                               -- Maximum distance from spawn
    enableBlip = true,                         -- Show blip on map
    blipColor = 2,                            -- Blip color
    blipSprite = 326,                         -- Blip sprite
    returnOnExit = true,                      -- Return player when exiting vehicle
    giveKeys = true,                          -- Give keys during test drive
    keySystem = "keys"                        -- Key system to use
}

Image Path Configuration

Configure how the system loads item and vehicle images:

ox_inventory Integration

Config.ImagePath = {
    type = "ox_inventory",
    baseUrl = "nui://ox_inventory/web/images/",
    fileExtension = ".png",
    vehicleImages = {
        baseUrl = "nui://coinsystem/ui/images/vehicles/",
        fileExtension = ".png"
    }
}

QBCore Inventory Integration

Config.ImagePath = {
    type = "qb_inventory", 
    baseUrl = "nui://qb-inventory/html/images/",
    fileExtension = ".png"
}

Animation Settings

Configure case opening animations:

Config.Animations = {
    CaseOpening = {
        ShakeDuration = 2000,        -- Shake animation duration (ms)
        OpenDuration = 2000,         -- Opening animation duration (ms) 
        RevealDuration = 2000,       -- Reveal animation duration (ms)
        CelebrateDuration = 24000,   -- Celebration animation duration (ms)
        TotalDuration = 30000,       -- Total animation time (ms)
        ShowContinueButton = true,    -- Show continue button
        ContinueButtonDelay = 12000   -- Delay before continue button (ms)
    }
}

Localization

Configure language and currency settings in shared/locale.lua:

Locale = {
    Currency = "Cue Coins",
    CurrencySymbol = "💎",
    Language = "en",        -- "en" for English, "de" for German
    
    Translations = {
        en = {
            shop_title = "Cue Coins Shop",
            balance = "Balance",
            purchase = "Purchase",
            -- ... more translations
        }
    }
}

Configuration Examples

High Economy Server

-- Higher rewards and prices
Config.HourlyCoins.amount = 50
Config.VIP.Multipliers.Coins = 3

-- More expensive items
Config.Table[1].Item = {
    {label = "Lockpick", name = "lockpick", coin = 50}, -- vs default 10
}

Roleplay Focused Server

-- Longer intervals, more realistic
Config.HourlyCoins = {
    enabled = true,
    interval = 120,     -- Every 2 hours
    amount = 25,
    vipMultiplier = 2
}

-- Higher vehicle prices to encourage earning
Config.Table[1].RentCar = {
    {label = "Basic Car", name = "blista", coin = 300}, -- Higher entry cost
}

Pro Tip: Always backup your configuration files before making changes!

Framework Detection: The system automatically detects whether you're using ESX or QBCore and adapts the configuration accordingly.