Configuration
Contents of config.lua
Welcome to qs-vehiclekeys configuration! To start configuring your new asset, please read carefully each step in the documentation each step in the documentation we will attach at the end of this message.
Each important part of the configuration will be highlighted with a box. like this one you are reading now, where I will explain step by step each available configuration available inside this file.
This is not all, most of the configurations, you are free to modify them as you wish and adapt them to your as you wish and adapt them to your framework in the most comfortable way possible. The configurable files you will find all of them inside client/custom/* or inside server/custom/*.
Direct link to the resource documentation, read it before starting:
https://docs.quasar-store.com/information/welcome
Config = Config or {}
Locales = Locales or {}
-- âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
Config.Framework = 'esx' -- You can choose between 'esx' or 'qb'.
Config.Language = 'en' -- Available languages by default: 'es', 'en' and 'fr' you can create more if you wish.
--[[
âââââââââââââââââââââââââââââââââââ
âââââââââââââââââââââââââââââââââââ
]]
-- Choose from the following options.
--[[
'qs' for qs-inventory
'qb' for qb-inventory
'core_inventory',
'ox' for
]]
Config.InventoryScript = 'qs'
--[[
âââââââââââââââââââ ââââââââââââââââ
âââââââââââââââââââ ââââââââââââââââ
]]
-- Choose from the following options.
--[[
'ox_lib',
'esx_context',
'esx_menu_default',
'nh',
'qb'
]]
Config.MenuType = 'esx_context' -- Menu type that you will want to use. (Mainly for the copy of the keys and the buying of the plate, if you haven't selected the shop option.)
--[[
ââââââââââââââââ ââââââ
ââââââââââââââââ ââââââ
]]
-- Choose from the following options.
--[[
'Draw3DText',
'ShowHelpNotification',
'ox_lib', -- Most optimized.
'esx_textui', -- not tested on the moment, please report any issues it will be fixed asap !
'qb', -- not tested on the moment, please report any issues it will be fixed asap !
'okokTextUI', -- Most optimized. (A bit loud...)
]]
Config.TextUI = 'esx_textui' -- TextUI shown while getting close to the Peds, for copy of the keys and the buying of the plate.
--[[
âââââââââââââââââââââââ
âââââââââââââââââââââââ
]]
-- Will be improved on fruther...
-- Installing of the plate trough target, stealing peds and much more are coming !
Config.EnableTarget = false -- Used for lock / unlocked of the cars, and for copy of the keys and the buying of the plate. (If enabled it will override the options of the TextUI)
Config.Target = {
-- Choose from the following options.
--[[
'qb' (qb-target)
'ox' (ox_target)
]]
TargetName = 'ox',
distance = 2.0 -- Distance
}
--[[
âââââââââââââââââââââ
âââââââââââââââââââââ
]]
Config.Radial = 'ox' -- Optional radial menu, for car managements, locking car and EngineControl supporting ox default radial menu.
-- Choose from the following options.
--[[
'ox' (ox_lib)
false (Disable fully the use of the radial menus)
]]
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââ âââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
Config.AllVehiclesLocked = false -- Do you want all vehicles in the city to be blocked? (Enable with caution)
--[[
âââââââââââââââââââââââââââââââ
âââââââââââââââââââââââââââââââ
]]
-- client/custom/misc/commands.lua
-- List for the fivem keybinds if you want to change it. https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/
Config.HotKeys = true -- Enable or disable the engine on/off system.
Config.Controls = {
EngineControl = 'IOM_WHEEL_UP', -- Key to start or stop the engine. (Mouse wheel up) for better compatibility with the qs-dispatch already using the G keybind. And also better roleplay
UseKey = 'U', -- Key to lock / unlock the car.
}
Config.Hotwire = true -- True or false for enable / disable the hotwire functions.
Config.UseHotwire = 'H' -- Key to start hotwiring the car.
-- âââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââ
Config.VehicleKeysItem = 'vehiclekeys' -- Name of the item with metadata to open the vehicle.
Config.LockDistance = 20.0
Config.Anim = 'fob_click_fp' -- Modify the animation when opening or closing the vehicle here.
Config.Animdict = 'anim@mp_player_intmenu@key_fob@' -- Modify the animation when opening or closing the vehicle here.
--[[
âââââââââââââââââââââââââ âââââââââââââââââââââââ
âââââââââââââââââââââââââ âââââââââââââââââââââââ
]]
-- Dependency of InteractSound needed for this to work !
-- link here : https://github.com/plunkettscott/interact-sound
--[[
1. -- * Place this sound on the interact-sound folder like shown below :
dir : interact-sound/client/html/sounds/carkeys.ogg
2. -- * Add the file name to the fxmanifest.lua file of the interact-sound ressource.
Like shown below (This is only an example, you could have more sounds listed here):
-- Files needed for NUI
-- DON'T FORGET TO ADD THE SOUND FILES TO THIS!
files {
'client/html/index.html',
'client/html/sounds/demo.ogg',
'/client/html/sounds/carkeys.ogg',
}
]]
Config.Sounds = true -- Use of custom sounds through InteractSound
Config.SoundsDisableDefault = false -- Disable the use of Fivem Default sounds.
Config.SoundsVolume = 0.3 -- Distance on where the sound can be heard
Config.SoundsFileName = 'carkeys' -- Name of the file
Config.SoundsDistance = 2 -- Distance on where the sound can be heard
--[[
ââââââââââââââââ âââââââââââââââ
ââââââââââââââââ âââââââââââââââ
]]
Config.CopyKeysMenu = true --- If you want to use the esx getdistancebetweencoords menu, otherwhise you can make it work with qtarget, the function to open menu is OpenCopyKeys()
Config.OpenCopyKeys = 'E' -- Key to open the key copy menu.
Config.MenuPlacement = 'top-left' -- Position of `esx_menu_default`.
Config.CopyKeysCost = 500 -- Price of the copies of the keys, you can use 0 and it will be free.
Config.CopyKeysLocations = { -- List of stores to copy keys.
vector3(-31.402076721191, -1647.4393310547, 29.282875061035)
}
Config.Blip = true -- True or false for disable the blip.
Config.CopyKeysBlip = { -- Blip of the key copy spot.
BlipName = 'Copy keys',
BlipSprite = 186,
BlipColour = 3,
BlipScale = 0.8,
}
-- âââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââââââââââââââââââââââââââââ
--[[
ââââââââââââââââââââ âââââââââââââââââââ
ââââââââââââââââââââ âââââââââââââââââââ
]]
Config.PlateLetters = 3 -- Modify here the type of plate.
Config.PlateNumbers = 3 -- Modify here the type of plate.
Config.PlateUseSpace = true -- Modify here the type of plate.
Config.TimeToChange = 5000 -- Time to change the plate (ms)
--[[
ââââââââââââââ
ââââââââââââââ
]]
Config.PlateType = 'menu' -- Shop or Menu
-- Choose from the following options.
--[[
'shop' (qs-shop)
'menu' (menu defined above)
]]
-- Both of these items will be present in the shop or menu accessible through Peds.
-- For ESX account should be money, for qbcore it should be cash or bank.
-- Choose from the following options. For the account.
--[[
'money' (ESX ONLY)
'cash' (QBCORE ONLY)
'bank' (BOTH)
]]
Config.PlateItem = 'plate' -- Name of the item plate.
Config.PlatePrice = {
price = 500,
account = 'money',
}
Config.ChangePlateItem = 'screwdriver' -- Item required to use the plate.
Config.ChangePlateItemPrice = {
price = 150,
account = 'money',
}
-- ââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââ
-- You can edit here : qs-vehiclekeys/config/hotwire.lua
-- Find the ox_lib skillCheck documentation listed below :
-- https://overextended.dev/ox_lib/Modules/Interface/Client/skillcheck
Config.MiniGameHotWireStyle = 'easy' -- Available Style 'easy' or 'hard'
--[[
'easy' = lib.skillCheck({'easy', 'easy', 'easy', 'easy', 'easy'})
'hard' = lib.skillCheck({'easy', 'easy', {areaSize=70, speedMultiplier=1}, 'easy'}, {'z', 'q', 's', 'd'})
]]
Config.TimeMin = 1000 -- Minimum time to hotwire
Config.TimeMax = 5000 -- Maximun time to hotwire
Config.ChanceToHotwire = 99
Config.WhitelistVehicles = { -- This list of vehicles won't have hotwire.
'bmx'
}
Config.StealVehiclesPeds = true -- If you enable this, players can target an NPC driver to receive their keys.
Config.StealVehiclesPedsPolice = 50 -- This is the chance for the NPC to call the police after being robbed (1-100).
--[[
âââââââââââââââââââââ
âââââââââââââââââââââ
]]
Config.ReqPolice = false -- Do you want police in your city to enable robberies?
Config.ReqPoliceCount = 1 -- Minimum police to start a robbery.
Config.ReqJobPolice = 'police' -- Police job name.
Config.RefreshPolice = 1000 -- Ammount of time to check por police count again, higher for more performance, don't use below 1000ms.
Config.LockpickItem = 'lockpick' -- Item required to start lockpicking.
Config.LockpickKeepChance = 50 -- Chance of not brekaing the lockpick item and keeping your item (1-100).
Config.LockpickFail = 1
Config.AdvancedLockpickItem = 'caradvancedlockpick' -- Don't need police to lockpick
Config.LockpickAlarm = true -- If you enable this option, the policemen will receive dispatch when the alarm sounds.
Config.StartAlarmChance = 50 -- Chance of the alarm going off, remember this will trigger dispatch to `Config.ReqJobPolice` (1-100).
Config.LockpickWhitelist = { -- This vehicles don't have hotwire
'bmx'
}
-- ââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââ
-- Ped for copy the keys.
Config.CopyKeysNpcName = 's_m_y_xmech_01'
Config.CopyKeysPedLocation = vec4(-31.402076721191, -1647.4393310547, 29.282875061035, 68.450233459473)
-- Ped for buying the plate item.
Config.PlateNpcName = 'mp_m_waremech_01'
Config.PlateNPCLocation = vec4(-40.4748, -1674.6696, 29.4845, 153.7328)
-- Distance you want the ped to render.
Config.PedRenderDistance = 10.0
-- ââââââââââââ ââââ ââââââ âââââââ ââââââââââââââââ âââ âââ âââââââ ââââ âââââââââââ
-- âââââââââââââ âââââââââââââââââââââââââââââââââââââââââ âââââââââââââââââ âââââââââââ
-- âââââââââââââââââââââââââââââââââââ âââ âââââââââââââââââââ âââââââââ âââââââââ
-- âââââââââââââââââââââââââââââââââââ âââ âââââââ âââââââââââ âââââââââââââââââââ
-- âââââââââââ âââ ââââââ ââââââ âââ âââ âââ âââ âââââââââââââââ ââââââââââââââ
-- âââââââââââ ââââââ ââââââ âââ âââ âââ âââ âââ âââââââ âââ âââââââââââââ
Config.Smartphone = false -- If you have qs-smartphone, you can enable this function.
Config.ChargeCommand = 'chargephone' -- Command to load or unload your qs-smartphone.
Config.ChargeStatusCommand = 'chargestatus' -- Command to display or hide the battery percentage while charging.
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
Config.Dispatch = "default" -- Options available : "qs", "qs-smartphone", "default"
-- ââââââââââââââââââââââââââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââĻâââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââ
-- âââââââââââââââââââââââĻâââââââââââââââââââ
-- ââââââââââââââââââââââââââââââââââââââââââ
Config.Debug = false -- If you want to see more about what happens internally in the script use true.
Config.Eventprefix = 'qs-vehiclekeys'Last updated