Starter
Configuration
Everything is in config.lua.
Core toggles
config.lua
Config.Debug = false
Config.Framework = 'esx' -- 'esx' | 'qbcore'
Config.SQLWrapper = 'oxmysql'
Config.Inventory = 'auto' -- 'auto' | 'ox_inventory' | 'qb-inventory' | 'qs-inventory' | 'esx_default'
Config.UseTarget = false -- false = floating help text
Config.TargetSystem = 'ox_target' -- 'ox_target' | 'qb-target'
-- each one shows or hides its kiosk tab
Config.UseStarterPack = true
Config.UseRoleBasedStarter = false -- true = Civilian / Criminal picker
Config.UseVehicleStarter = false
Config.UseGuideBook = true
Onboarding
config.lua
Config.Onboarding = {
enabled = true,
steps = {
{ id = 'meet', label = 'Meet the intake officer', tab = nil, dialogue = 'intro' },
{ id = 'pack', label = 'Claim your starter pack', tab = 'starter' },
{ id = 'vehicle', label = 'Claim your state vehicle', tab = 'vehicle' },
},
}
Steps complete on their own: meet when the intro dialogue ends, pack and vehicle when claimed.
Dialogue
A tree of nodes. Each node has lines (spoken in order) and choices. A choice can 'openTab', 'advance' a step, go to the 'next' node, or 'close'.
config.lua
Config.Dialogue = {
speaker = 'Intake Officer Calloway',
startNode = 'intro',
nodes = {
intro = {
lines = {
"Welcome to the city. Rough trip in, I'd bet — they always are.",
"I'm your intake officer. Before you wander off and get yourself lost, let's get you set up.",
},
choices = {
{ text = "What have you got for me?", action = 'next', node = 'offer' },
{ text = "I know the drill. Skip it.", action = 'close' },
},
},
offer = {
lines = { "The City Council put together a survival package..." },
choices = {
{ text = "The survival package.", action = 'openTab', tab = 'starter' },
{ text = "The vehicle.", action = 'openTab', tab = 'vehicle' },
{ text = "Just point me to the city guide.", action = 'openTab', tab = 'guidebook' },
},
},
},
}
Starter pack
config.lua
Config.StarterPack = {
Male = {
{ Name = 'black_phone', Quantity = 1 },
{ Name = 'double_burger', Quantity = 10 },
},
Female = {
{ Name = 'purple_phone', Quantity = 1 },
{ Name = 'double_burger', Quantity = 10 },
},
Money = { cash = 10000, bank = 50000 },
}
-- only with Config.UseRoleBasedStarter = true
Config.StarterPackRoles = {
Civilian = { Male = Config.StarterPack.Male, Female = Config.StarterPack.Female, Money = { cash = 10000, bank = 50000 } },
Criminal = { Male = Config.StarterPack.Male, Female = Config.StarterPack.Female, Money = { cash = 15000, bank = 25000 } },
}
Starter vehicle
config.lua
Config.VehicleStarter = {
VehicleInGarage = true, -- true = owned & stored, false = street car + keys
VehicleModels = {
{ Model = 'SP_SURGEARRESTER', Probability = 0.2 },
{ Model = 's1', Probability = 0.8 },
},
}
Config.VehicleSpawn = {
{ position = vector3(-1040.44, -2727.08, 19.87), heading = 241.31 },
{ position = vector3(-1046.26, -2723.98, 20.03), heading = 239.00 },
}
Garage providers
Set Config.Garage.Provider to one of these. Each has a matching entry in Config.Garage.Defaults for the columns it needs.
| Provider | Garage |
|---|---|
| dh_esx | Dirty Halo garage (ESX) |
| esx_default / qbcore_default | Framework default tables |
| jg_advanced_esx / jg_advanced_qb | jg-advancedgarages |
| okok_esx / okok_qb | okokGarage |
| cd_esx / cd_qb | cd_garage |
| codem_esx / codem_qb | codem garage |
| vms_garagesv2_esx / vms_garagesv2_qb | vms_garagesv2 |
| op_garages | op_garages |
Guidebook
config.lua
Config.GuideBook = {
AdminPermissions = { 'god', 'admin' },
Categories = {
{ name = 'WELCOME' },
{ name = 'TUTORIAL' },
{ name = 'JOBS' },
},
}
Config.GuidebookAnimation = {
enabled = true,
dict = 'missheistdockssetup1clipboard@base',
anim = 'base',
prop = { enabled = true, model = 'prop_novel_01', bone = 18905,
position = vector3(0.12, 0.008, 0.03), rotation = vector3(0.0, 0.0, 0.0) },
}
Location & NPC
config.lua
Config.Location = {
position = vector3(-1038.67, -2726.76, 13.63),
interactionDistance = 2.0,
markerSettings = { enabled = true, type = 21, colorR = 77, colorG = 166, colorB = 255, alpha = 200,
useCustomHeight = true, heightOffset = 1.0 },
blipSettings = { enabled = true, id = 835, color = 38, scale = 0.7, display = 2, name = 'New Arrival Intake' },
npcSettings = { enabled = true, heading = 209.14, model = 'a_m_y_business_03',
playAnimation = true, animationScenario = 'WORLD_HUMAN_CLIPBOARD' },
}
UI, text & helpers
Config.UI.colors— the five accent colors plus text and guidebook colorsConfig.UI.translations— every label in the kiosk UIConfig.Translations— every notificationConfig.Functions— help text, notify and vehicle keys. Swap in your own systems here