Configuration
Professional configuration guide for the Taintless Vehicle Shop system. Complete documentation for system configuration and customization options.
Documentation Sections
System Configuration (Customize
Table)
Customize
Table)Global system parameters and operational settings.
Customize = {
Locale = 'en',
Framework = nil,
NotifySystem = nil,
NotifyStyle = 'top-center',
TestDriveTime = 35,
Currency = 'USD',
DebugMessage = false,
Finance = {
Command = 'vfinance',
},
Client = {
SetUI = function(value) -- ... end,
GiveKeys = function(plate, vehicle, type) -- ... end,
}
}
Locale
Locale
Determines the language for the UI.
Values:
'en'
,'tr'
,'de'
,'es'
,'fr'
,'bg'
,'cs'
,'it'
,'pt'
etc.
Framework
Framework
Specifies your server's framework.
Values:
nil
(for auto-detection),'QBCore'
,'ESX'
,'Qbox'
.
NotifySystem
NotifySystem
Selects the notification system.
Values:
nil
(for auto-detection),'ox_lib'
.
NotifyStyle
NotifyStyle
Defines the on-screen position for notifications.
Values:
'top-left'
,'top-center'
,'bottom-right'
, etc.
TestDriveTime
TestDriveTime
Sets the duration of test drives in seconds.
Value:
35
(in seconds).
Currency
Currency
Sets the currency symbol used throughout the shop.
Values:
'USD'
,'EUR'
,'GBP'
, etc.
DebugMessage
DebugMessage
Enables or disables debug prints in the console.
Values:
true
orfalse
.
Finance.Command
Finance.Command
The chat command for players to check their vehicle financing status.
Value:
'vfinance'
.
Client.SetUI
Client.SetUI
A client-side function to manage UI visibility (e.g., hide the HUD) when the shop is open.
SetUI = function(value) -- true: hide, false: show
if GetResourceState('uz_PureHud') == 'started' then
exports['uz_PureHud']:SetHudVisibility(value)
end
end,
Client.GiveKeys
Client.GiveKeys
A client-side function that handles giving vehicle keys to a player after a purchase or for a test drive. Configure this to match your server's key system.
GiveKeys = function(plate, vehicle, type) -- type: 'buy' or 'testdrive'
if GetResourceState('qb-vehiclekeys') == 'started' then
TriggerEvent("vehiclekeys:client:SetOwner", plate)
end
end
PlateFormat
PlateFormat
Custom license plate format configuration.
PlateFormat = '1AA111AA'
Format Options:
1
: Number (0-9)A
: Letter (A-Z)Example:
'1AA111AA'
generates plates like2AB345CD
Example:
'AA1111'
generates plates likeAB1234
Dealership Management (Customize.DealershipLocations
)
Customize.DealershipLocations
)Individual dealership configuration and operational parameters.
name
name
Dealership identification and map blip label.
name = 'Premium Deluxe Motorsport',
categories
categories
Available vehicle categories. Must correspond to Customize.Vehicles
keys.
categories = {'sports', 'super', 'muscle'},
job
job
Job-based access control for dealership.
job = 'cardealer', -- Optional: Restricts dealership access to specific job
Configuration:
Set to job name for restricted access
Remove or set to
nil
for public accessSupports multiple dealerships with different job requirements
coords
coords
Dealership coordinate configuration.
openShowroom
:vector3
- Dealership menu access pointshowroomVehicleSpawn
:vector3
- Showroom vehicle display locationbuyVehicleSpawn
:vector4
- Purchase vehicle spawn locationtestDriveSpawn
:vector4
- Test drive vehicle spawn locationalternativeSpawns
:{vector4, ...}
- Secondary spawn locations
blip
blip
Map marker configuration.
hide
:false
id
:326
(Marker identifier)color
:3
(Marker color)scale
:0.6
(Marker scale)
interactType
& drawtextType
interactType
& drawtextType
User interaction configuration.
interactType
:'default'
(marker),'target'
(target system)drawtextType
:'default'
(native text display)
setMarker
setMarker
Marker rendering function for showroom location.
setMarker = function(coords)
DrawMarker(21, coords.x, coords.y, coords.z, ... )
end,
interaction
interaction
Showroom vehicle interaction system.
interaction = {
enabled = true, -- Global interaction control
engine = { enabled = true, icon = 'fa-solid fa-gear' },
boot = { enabled = true, icon = 'fa-solid fa-box' },
bonnet = { enabled = true, icon = 'fa-solid fa-car-battery' },
doors = { enabled = true, icon = 'fa-solid fa-door-closed' },
lights = { enabled = true, icon = 'fa-solid fa-lightbulb' },
},
customRoom
customRoom
Virtual showroom configuration.
enabled
:true
- Virtual room activationimage
:'1.gif'
- Background image (webp, jpg, png, gif)roomDimensions
:{...}
- Room size parametersWall
:{...}
- Wall visibility configuration
colourOptions
colourOptions
Vehicle color configuration system.
colourOptions = {
{ hex = '#000000', index = 0 }, -- Black
{ hex = '#e81416', index = 27 }, -- Red
},
finance
finance
Dealership financing configuration.
paymentCount
: Total installment quantitydownPaymentRate
: Initial payment percentage (e.g.,0.2
for 20%)interestRate
: Applied interest rate (e.g.,0.05
for 5%)paymentIntervalHours
: Payment frequency (in-game hours)repoGracePeriodHours
: Repossession grace period
camera
camera
Showroom camera system configuration.
distance
,height
,angle
,fov
: Camera positioning parameterssensitivityX
,sensitivityY
: Input sensitivity settingsmin/maxDistance
,min/maxHeight
: Camera movement constraints
Vehicle Configuration
Vehicle category management and inventory configuration.
Customize.CategoryLabels
Customize.CategoryLabels
Vehicle category display configuration.
Customize.CategoryLabels = {
['sports'] = 'Sports Cars',
['sedans'] = 'Sedans',
['super'] = 'Super Cars',
}
Customize.Vehicles
Customize.Vehicles
Complete vehicle inventory configuration.
Customize.Vehicles = {
['super'] = { -- Category identifier
{
name = 'Adder', -- Display name
brand = 'Truffade', -- Manufacturer
model = 'adder', -- Spawn model
price = 86065, -- Base price
hash = `adder`, -- Model hash
},
},
}
Configuration Note: Vehicle additions require entry in appropriate category. New categories require
CategoryLabels
andVehicles
configuration.
Last updated
Was this helpful?