Resource Configuration

This page provides comprehensive information about our configuration files, assisting in the setup of the resource.

---

cfg.z_interactions

This boolean value allows you to disable the default built-in interaction system for the script, enabling you to implement your own system.

---@field z_interactions boolean
---@description: Set as false if you do not want to use the interaction system build into z_hose
cfg.z_interactions = true

---

cfg.nui

This table allows for the configuration of the inventory user interface colors and logo. To edit the themes, please utilize hex codes. Hex codes can be found here.

---@section nuiDesign
---@description: This section allows for 
cfg.nuiDesign = {
    communityLogo = 'assets/logo.png',
    communityTheme = {
        ['background'] = '#1e1e2f',       /* Background color */
        ['accent'] = '#0788bf',           /* Accent color */
        ['text_primary'] = '#ffffff',     /* Primary text color */
        ['accent_hover'] = '#0788bf',     /* Hover color for accents */
        ['border'] = '#00699d'            /* Neutral border for sections */
    }
}

---

cfg.keybinds

This table facilitates the editing of the keybinds utilized by the resource. These keybinds are represented in string format and can be found in the following location: core > client > classes > enums.lua.

---@section keybinds
---@description: Allow for the customization of keybinds utilized by the resource.
---@comment: https://docs.fivem.net/docs/game-references/controls/
---@comment: core > client > classes > enums.lua > enums.keybinds
cfg.keybinds = {
    -- % Boot Interaction % --
    ['open_boot'] = 'G',
    ['close_boot'] = 'G',
    ['pickup_object'] = 'E',
    ['drop_object'] = 'G'
}

---

cfg.languages

This table allows for the customization of both the language used by the resource and the associated strings. You can configure your preferred language within the fxmanifest.lua file.

---@section languages
---@description: Allow for different languages to be utalised for displayed text.
cfg.languages = {
    ['en'] = {
        ['interactions'] = {
            -- % Boot Interaction % --
            open_boot = 'Open Boot',
            close_boot = 'Close Boot',
            pickup_object= 'Pickup %s',
            view_contents = 'View Contents'
        },

        ['notifications'] = {
            -- % Titles % --
            error = 'Error!',
            success = 'Success!',
            lack_permission = 'You lack the permission for this action!',

            item_taken = '%s taken!',
            item_stored = '%s stored!',

            already_wearing = 'Cannot take a clothing piece you are already wearing!',
            not_wearing = 'Cannot return a clothing piece you are not wearing!',

            already_has_weapon = 'Cannot take a weapon you already have!',
            doesnt_have_weapon = 'Cannot return a weapon you do not have!',

            all_placed = 'All of the taken objects have now been placed!'
        },

        ['contexts'] = {
            transform_mode = 'Transform Mode',
            rotation_mode = 'Rotation Mode',
            local_mode = 'Set Local',
            confirm_place = 'Confirm Place',
            drop_object = 'Drop'
        }
    }
}

---