Config
Configuration parameters and customization settings available in config.lua.
General Settings
| Variable | Type | Default | Description |
|---|---|---|---|
Config.Locale |
string | 'en' |
Active language locale code matching locales/ file. |
Config.SignalRadius |
number | 100.0 |
Maximum distance in meters for key fob signal reach. |
Config.LockNPCVehicles |
boolean | true |
Locks random NPC-driven or parked ambient vehicles by default. |
Config.VirtualNPCKey |
boolean | true |
Gives players virtual keys upon carjacking an NPC. |
Config.PreventAutoEngineOff |
boolean | true |
Keeps vehicle engine running after driver exits. |
Config.EngineOffWithLockVehicle |
boolean | true |
Turns off vehicle engine automatically upon locking. |
Commands and Controls
Config.Commands = {
givekey = 'givekey', -- Command to transfer a virtual key
engine = 'engine', -- Command to toggle engine
lockpick = 'lockpick', -- Command to lockpick a vehicle
togglevlock = 'togglevlock', -- Command to toggle lock/unlock
}
Config.LockUnlockKey = 'L' -- Default keybind for locking/unlocking
Config.EngineButton = 'G' -- Default keybind for toggling engineLocksmith Settings
Config.LockSmith = {
position = vector3(464.95, -750.57, 27.36), -- World coordinates for Locksmith shop
heading = 90.0, -- NPC facing heading
pedModel = 's_m_m_autoshop_01', -- Ped model name
interactionDistance = 2.5, -- Distance in meters to open menu
blip = {
enable = true,
sprite = 134,
color = 1,
name = 'Locksmith',
scale = 1.0
},
cost = {
duplicatekey = 1500, -- Price to create duplicate physical key
changelock = 5000, -- Price to change vehicle door lock
},
}Search and Hotwiring Settings
Config.VehicleSearchTime = 10 -- Seconds required to search glovebox
Config.VehicleHotwireTime = 20 -- Seconds required to hotwire
Config.GetKeyBySearchingGloveboxChance = 25 -- % chance to find key when searching glovebox
Config.HotwireAlert = {
enable = true, -- Trigger police alert on hotwire attempt
chance = 70, -- % chance police are alerted
playernotify = true, -- Notify player if activity was reported
}
Config.HotwireAlarmChance = 100 -- % chance car alarm sounds during hotwire
Config.HotwireSuccessChance = 90 -- % base chance for hotwire success
Config.HotwirePlayerOwnedVehicle = true -- Allow hotwiring player-owned vehicles
Config.HotwireMinigame = function()
-- Custom hotwire minigame function (returns true on success, false on fail)
return math.random(1, 100) <= Config.HotwireSuccessChance
endLockpicking Settings
Config.LockPickItem = nil -- Item required (e.g. 'lockpick') or nil if none
Config.LockPickBreakChanceOnFail = 70 -- % chance item breaks on failure
Config.EnableLockPickMinigame = true -- Enable/disable lockpick minigame
Config.LockPickWaitTime = 10 -- Seconds duration if minigame disabled
Config.LockPickAlarmChance = 100 -- % chance car alarm goes off
Config.LockPickPlayerOwnedVehicle = true -- Allow lockpicking player-owned vehicles
Config.LockPickMinigame = function()
-- Native Lib47 Tension minigame integration
if not Config.EnableLockPickMinigame then return true end
if Lib47.StartTensionMinigame then
return Lib47.StartTensionMinigame('momentum', 'easy', {
icon = 'fa-solid fa-key',
barSize = 15
})
end
return true
end
Config.LockPickAlert = {
enable = true, -- Trigger police alert on lockpick attempt
chance = 70, -- % chance police are alerted
playernotify = true, -- Notify player if activity was reported
}Carjacking Disabled Weapons
Config.DisabledCarjackWeapons = {
[`WEAPON_UNARMED`] = true,
[`WEAPON_FLASHLIGHT`] = true,
[`WEAPON_NIGHTSTICK`] = true,
[`WEAPON_STUNGUN`] = true,
[`WEAPON_KNIFE`] = true,
}Job and Ignored Vehicles
Job Vehicles
Whitelists vehicle models for specified jobs without requiring key items:
Config.JobVehicles = {
[`police`] = {'police', 'sheriff'},
[`sheriff`] = {'police', 'sheriff'},
[`ambulance`] = {'ambulance'},
}Ignored Vehicles and Classes
Vehicles and vehicle classes that bypass the locking system:
Config.IgnoreVehicles = {
[`bmx`] = true,
[`cruiser`] = true,
}
Config.IgnoreClass = {
[13] = true, -- 13 = Cycles / Bicycles
}On this page