Installation

Configuration

Let's dive into the initial section of your config file:

-- 🧙‍♂️ keep-harmony
-- General Settings
Config.MagicTouch = false 
Config.use_progressbar = true
Config.language = 'en'

-- Framework and Resource Settings
Config.framework = 'qb' 
Config.inventory = 'qb-inventory' 
Config.target = 'qb-target' 
Config.menu = 'qb-menu' 
Config.input = 'qb-input' 
Config.progressbar = 'qb'
Config.notification = 'qb'
Config.emote = 'dpemotes'

• MagicTouch: This is a developer mode flag. Set it to true for debugging tools, but for regular use, keep it as false.
• use_progressbar: This global flag controls the visibility of progress bars. Set it to false to disable them.
• language: Your preferred language for localization.
• framework: Specify your base framework, either 'qb' or 'esx' (qbox is still qb).
• inventory: Select the inventory script you're using, such as 'qb-inventory', 'ps-inventory', or 'ox_inventory'.
• target: Your target system, either 'qb-target' or 'ox_target'.

Configuration: Resource Naming

Now, let's move on to the second part of your config file, where you can specify name of your resources:

Config.resource_names = {
    framework = 'qb-core',
    inventory = 'qb-inventory',
    target = 'qb-target',
    menu = 'qb-menu',
    input = 'qb-menu'
}

This table enables direct linking to your resources. If you've renamed any resources, simply update their names here. For instance, if you've changed qb-core to my_random_core, make sure to reflect that change in the table.

TIP

It's crucial to use the correct resource names in the configuration.

If you have any questions or need further assistance, feel free to ask! 🤗

Config examples

QBCore

Config example

-- 🧙‍♂️ keep-harmony
-- General settings
Config.MagicTouch = true
Config.use_progressbar = true
Config.language = 'en'

-- Framework and Resource settings
Config.framework = 'qb'          
Config.inventory = 'qb-inventory' 
Config.target = 'qb-target'       
Config.menu = 'qb-menu'           
Config.input = 'qb-input'        
Config.progressbar = 'qb'        
Config.notification = 'qb'        
Config.emote = 'dpemotes'         

-- Resource Name Mapping
Config.resource_names = {
    framework = 'qb-core',
    inventory = 'qb-inventory',
    target = 'qb-target',
    menu = 'qb-menu',  
    input = 'qb-input'
}

ESX

Common issue

It's important to note that while esx is commonly used to refer to the ESX framework, its actual resource name is es_extended.

Below is an example of what you should avoid:

-- Resource Name Mapping (Avoid this)
Config.resource_names = {
    framework = 'esx',
    inventory = 'ox_inventory',
    target = 'ox_target',
    menu = 'ox_lib',  
    input = 'ox_lib'
}

Just use the actual resource name es_extended:

-- Resource Name Mapping (Correct)
Config.resource_names = {
    framework = 'es_extended',
    inventory = 'ox_inventory',
    target = 'ox_target',
    menu = 'ox_lib',  
    input = 'ox_lib'
}

Got it?

Config example

-- 🧙‍♂️ keep-harmony
-- General settings
Config.MagicTouch = true
Config.use_progressbar = true
Config.language = 'en'

-- Framework and Resource settings
Config.framework = 'esx'          
Config.inventory = 'ox_inventory' 
Config.target = 'ox_target'       
Config.menu = 'ox_lib'           
Config.input = 'ox_lib'        
Config.progressbar = 'ox_lib'        
Config.notification = 'ox_lib'        
Config.emote = 'dpemotes'         

-- Resource Name Mapping
Config.resource_names = {
    framework = 'es_extended',
    inventory = 'ox_inventory',
    target = 'ox_target',
    menu = 'ox_lib',  
    input = 'ox_lib'
}

Qbox

Config example

-- 🧙‍♂️ keep-harmony
-- General settings
Config.MagicTouch = true
Config.use_progressbar = true
Config.language = 'en'

-- Framework and Resource settings
Config.framework = 'qb'          
Config.inventory = 'ox_inventory' 
Config.target = 'ox_target'       
Config.menu = 'ox_lib'           
Config.input = 'ox_lib'        
Config.progressbar = 'ox_lib'        
Config.notification = 'ox_lib'        
Config.emote = 'dpemotes'         

-- Resource Name Mapping
Config.resource_names = {
    framework = 'qb',
    inventory = 'ox_inventory',
    target = 'ox_target',
    menu = 'ox_lib',  
    input = 'ox_lib'
}