⚙️Configuration

All configuration is handled inside config.lua. Below is a complete reference for every option.

You can disable either Quick Wear or Outfit Bag from the hub via enableQuickWear and enableOutfitBag. Setting one to false skips the hub entirely and opens the remaining feature directly when the bag is used.

---

🕹️ General Settings

Config.Command = 'clothing'         -- Command to open the wardrobe menu (set to false to disable)
Config.MenuKey = 'F4'               -- Key to open the wardrobe menu (set to false to disable)
Config.QuickWearKey = 'K'           -- Key to open Quick Wear radial menu directly (set to false to disable)
Config.ShowSettingsInQuickWear = true -- Show UI settings button when opening Quick Wear with the key

Option	Type	Description
Command	string / false	Chat command to open wardrobe. Set false to disable.
MenuKey	string / false	Keybind to open wardrobe. Set false to disable.
QuickWearKey	string / false	Keybind to open Quick Wear radial. Set false to disable.
ShowSettingsInQuickWear	boolean	Shows UI settings inside the Quick Wear menu.

---

🏗️ Framework

Config.Framework = {
    enabled = true,
    type = 'QB',          -- 'ESX', 'QB', 'QBox', or 'Standalone'
    multicharacter = true,
}

Option	Type	Description
enabled	boolean	Enable framework detection
type	string	Your framework: 'ESX', 'QB', 'QBox', 'Standalone'
multicharacter	boolean	Enable multicharacter support (uses citizenid or char:license)

---

🎒 Bag Item

Config.BagItem = {
    enabled = true,
    itemName = 'outfitbag',
    bagObject = 'prop_big_bag_01',
    maxOutfitsPerBag = 50,
    allowSharing = true,
    onlyAllowOneBagOnGround = true,
    enableQuickWear = true,   -- Show Quick Wear option in hub (false = skip hub, open Outfit Bag directly)
    enableOutfitBag = true,   -- Show Outfit Bag option in hub (false = skip hub, open Quick Wear directly)
    bagAnimation = { ... },
    bagDespawning = { ... },
}

Option	Type	Description
enabled	boolean	Enable the physical bag item system
itemName	string	The item name registered in your inventory
bagObject	string	GTA prop model used when the bag is placed in the world
maxOutfitsPerBag	number	Max outfits a single bag can store
allowSharing	boolean	Allow other players to browse public outfits in your bag
onlyAllowOneBagOnGround	boolean	Removes the previous bag when a new one is placed
bagDespawning.enabled	boolean	Enable automatic bag despawn
bagDespawning.time	number	Minutes before an placed bag despawns

---

🎯 Targeting System

Config.Target = {
    enabled = true,
    system = 'qb-target',  -- 'ox_target' or 'qb-target'
    distance = 2.5,
    pickupKey = 'G',
    openKey = 'E',
}

Option	Type	Description
enabled	boolean	Enable target system. If false, uses key interaction instead.
system	string	Which target resource to use: 'ox_target' or 'qb-target'
distance	number	Interaction distance in meters
pickupKey	string	Key to pick up bag (used when targeting is disabled)
openKey	string	Key to open bag (used when targeting is disabled)

---

📷 Camera

Config.Camera = {
    Distance = 3.0,
    Height = 0.2,
    FOV = 50.0,
    RotationSpeed = 0.5,
}

Option	Type	Description
Distance	float	Camera distance from the player ped
Height	float	Vertical offset of the camera
FOV	float	Field of view angle
RotationSpeed	float	Mouse rotation speed for camera control

---

🗄️ Database

Config.MaxOutfits = 20      -- Legacy option, use BagItem.maxOutfitsPerBag instead
Config.UseOxMySQL = true    -- Set to false if using a different MySQL resource

Config.MaxOutfits is kept for backwards compatibility. Use Config.BagItem.maxOutfitsPerBag to control outfit limits.

---

🎬 Animations

Config.UseItemAnimations = true  -- Play animation when toggling individual clothing items

Config.OutfitChangeAnimations = {
    top = {
        duration = 4000,
        dict = 'mp_safehouseshower@male@',
        anim = 'male_shower_towel_dry_to_get_dressed',
    },
    bottom = {
        duration = 4000,
        dict = 'clothingshoes',
        anim = 'try_shoes_positive_d',
    },
}

Option	Type	Description
UseItemAnimations	boolean	Play per-item animation when clicking individual clothes
OutfitChangeAnimations	table	Animations for full outfit apply (top & bottom sequence)

---

👔 Job Outfits

Config.JobOutfits = {
    enabled = true,
    outfits = {
        police = {
            { name = 'Short Sleeve', gender = 'male', outfit = { ... } },
            { name = 'SWAT',         gender = 'male', outfit = { ... } },
            -- female variants...
        },
        ambulance = { ... },
        realestate = { ... },
    }
}

Each job entry contains a list of outfit presets. Each preset has:

Field	Type	Description
name	string	Display name shown in the JOB tab
gender	string	'male' or 'female'
outfit	table	Clothing component drawables and textures

Adding a Custom Job

Config.JobOutfits.outfits['mechanic'] = {
    {
        name = 'Work Uniform',
        gender = 'male',
        outfit = {
            ['top']   = {drawable = 192, texture = 0, type = 'drawable', id = 11},
            ['pants'] = {drawable = 96,  texture = 0, type = 'drawable', id = 4},
            ['shoes'] = {drawable = 25,  texture = 0, type = 'drawable', id = 6},
        }
    },
}

Use Ace Permissions for job detection on Standalone servers by uncommenting the relevant block at the bottom of config.lua.

---

🔔 Notifications

Config.Notification = {
    system = 'ox_lib',   -- 'native', 'ox_lib', or 'custom'
    title = 'Wardrobe',
}

Option	Type	Description
system	string	Notification system to use: 'ox_lib', 'native', 'custom'
title	string	Title shown on ox_lib notifications

Custom Notification

To use your own notification resource, set system = 'custom' and add:

Config.Notification = {
    system = 'custom',
    customFunction = function(source, message, type)
        TriggerEvent('your_notify:client', message, type)
    end
}

---

🌍 Translations

All UI text and notification messages are fully translatable inside Config.Translations. Example:

Config.Translations = {
    ['notify_outfit_saved']   = 'Outfit saved successfully!',
    ['notify_no_bag']         = "You don't have an outfit bag!",
    ['ui_wardrobe']           = 'WARDROBE',
    ['ui_quick_wear']         = 'Quick Wear',
    -- ... and many more
}

To translate the script, simply replace the string values in Config.Translations with your language of choice. No other files need to be changed.