For the complete documentation index, see llms.txt. This page is also available as Markdown.

2️⃣Config

Config the resource as you wish

Framework

Set your framework in the config.lua

For custom Frameworks please add your own code in Framework/custom

framework = 'qbx', --- currently supports 'qbx', 'qb', 'esx', 'custom' (add your code in framework/ folder)

Locales

Set your language in the config.lua

Add your own Language file in Locales and set it in the config, the resource supports English only by default

locale = 'en', --- language file to use from locales/ folder (e.g. 'en', 'fr', 'de')

Interaction

Set your interaction method in config.lua

Please remember that if you use an interaction system that is not already supported, you must add it to the modules/interact.lua file and set the interaction to 'custom' in the config.lua file.

--- Interaction method
--- 'ox_target' | 'sleepless_interact' | 'qb-target' | 'custom' (add your code in modules/interact.lua)
interaction = 'ox_target', --- its only used if you have the ped enabled to access the ui

UI Access

config.lua

jobs.lua

Other configs are all listed in the Config Folder read the comments on the configs to understand what they do

Last updated