Configuration

[!IMPORTANT] Most of kartik-clothing is configured in-game, not in these files. Stores, garment restrictions and blacklists, arms/accessory pairing, ped unlocks and design moderation all live in the UI and are saved straight to the database. Start at the Admin Guide, Where To Change What to find the right place for a given task; this page is the reference for the settings that genuinely do live in shared/.

The config files are deliberately small. Seven files in shared/:

🚫 What is not in a config fileCopy Anchor Link

📇 Every Key At A Glance (shared/config.lua)Copy Anchor Link

The sections below explain the ones that need more than a line.

⚙️ Main Configuration (shared/config.lua)Copy Anchor Link

Access To CommandsCopy Anchor Link

Restrict the appearance and shop commands (/clothing, /barber, /tattoos, /wardrobe, /designstudio, /creator, /shopmanager and the lock/compat commands) to administrators (group.admin):

Config.AdminOnlyCommands = true -- false makes the appearance commands public

[!NOTE] This gates command names only. Permission for the actions themselves, saving a lock, editing compatibility, granting a ped, approving a design, is re-checked server side on every call, so a player who spoofs the UI still cannot write anything. What counts as an admin per framework is listed in the Admin Guide.

Take Off / Put On CommandsCopy Anchor Link

/takeoff and /puton are on by default. If another script (for example FiveCode Clothing) already uses those command names, turn ours off so the two don't clash:

Config.TakeoffCommands = false -- true (default) registers /takeoff and /puton

Restart kartik-clothing after changing it. Everything else (shops, wardrobe, saved looks, clothing items) keeps working. See /takeoff & /puton.

Media Fallback URLCopy Anchor Link

An optional remote CDN or GitHub raw base URL used for clothing preview thumbnails when a local NUI asset is missing. Leave it as '' to use local previews and icon fallbacks only.

Config.MediaUrl = 'https://raw.githubusercontent.com/kartik1410/kartik-clothing-images/main/preview'

The default points at the public image repository:

[!TIP] Fork or clone that repository, add your own addon clothing shots, and point Config.MediaUrl at your raw URL. Keep the folder layout identical, the UI builds paths, it does not search.

🗂️ Required Folder & File FormatCopy Anchor Link

Images are looked up at:

<Config.MediaUrl>/<gender>/<folder>/<drawable>.webp          -- texture 0
<Config.MediaUrl>/<gender>/<folder>/<drawable>_<texture>.webp -- texture 1 and up

preview/male/11/19.webp        -- Tops, drawable 19, first colour
preview/male/11/19_2.webp      -- Tops, drawable 19, third colour
preview/female/prop_0/4.webp   -- Hats, drawable 4
preview/male/overlay_1/3.webp  -- Facial hair, style 3

[!WARNING] Texture 0 carries no suffix. There is no 19_0.webp anywhere. Naming the first colour 19_0.webp makes it 404 and show as a blank card, while every other colour of the same garment loads correctly.

[!TIP] Never used GitHub before? Hosting Your Own Preview Images walks through it from making an account to uploading with GitHub Desktop, no command line needed.

The same layout works locally in the resource's own preview/ folder, the UI tries nui://kartik-clothing/preview/... first and falls back to Config.MediaUrl only when that misses. Use /takeshots to generate correctly named shots for your own addon clothing.

Locale & DebugCopy Anchor Link

Config.Locale = 'en'   -- picks the file in locales/
Config.Debug  = false   -- verbose console output

💪 Arms & CompatibilityCopy Anchor Link

These four keys decide how much the script does for a player when they put a top on. See Garment Compatibility.

-- Read the arms GTA ships with a garment and apply them automatically, so
-- sleeves always match. Base-game clothing only - addon clothing has no such
-- metadata to read.
Config.SmartArms = false

-- Arms an admin deliberately paired with a garment via /setarms or the in-shop
-- editor. These are not a guess, so they apply even with SmartArms off - which
-- is the entire point for addon clothing the game knows nothing about.
Config.AuthoredArms = true

-- The GOES WITH side panel, showing undershirts, gloves and chains that match
-- the selected garment. A garment with no data of either kind stays hidden.
Config.CompatPanel = true

-- Whether admins may author compatibility from inside the shop. Off means the
-- editor button never appears and the write callbacks refuse everyone; rows
-- already in kc_item_compat still apply.
Config.CompatEditor = true

Studio LocationsCopy Anchor Link

Where players can open the Custom Garment Design Studio.

Config.Studios = {
    {
        label = 'Vespucci Design Studio',
        coords = vec3(72.29, -1399.1, 29.38),
        heading = 250.0,
        ped = `s_f_y_shop_mid`,
        blip = { sprite = 366, colour = 4, scale = 0.7 },
    },
}

[!NOTE] Clothing shop locations are not configured here, they are stored in the kc_shops table and managed live through /shopmanager.

Pricing Rules & MultipliersCopy Anchor Link

Price for a variation is base + (index * multiplier).

Config.Prices = {
    defaultBase = 25,
    defaultMultiplier = 2,
    components = {
        [11] = { base = 50, multiplier = 3 },   -- Tops (Jackets, Shirts)
        [8]  = { base = 20, multiplier = 2 },   -- Undershirts
        [4]  = { base = 40, multiplier = 2.5 }, -- Pants
        [6]  = { base = 35, multiplier = 2 },   -- Shoes
        [1]  = { base = 30, multiplier = 1.5 }, -- Masks
        [7]  = { base = 25, multiplier = 1 },   -- Chains/Necklaces
        [5]  = { base = 45, multiplier = 3 },   -- Bags/Parachutes
        [9]  = { base = 60, multiplier = 4 },   -- Armor/Vests
        [3]  = { base = 15, multiplier = 1 },   -- Torso/Gloves
        [10] = { base = 25, multiplier = 2 },   -- Decals/Badges
    },
    props = {
        [0] = { base = 20, multiplier = 1.5 },  -- Hats/Caps
        [1] = { base = 15, multiplier = 1 },    -- Glasses
        [2] = { base = 25, multiplier = 2 },    -- Ears
        [6] = { base = 50, multiplier = 5 },    -- Watches
        [7] = { base = 30, multiplier = 2 }     -- Bracelets
    }
}

Camera FramingCopy Anchor Link

Field of view and the distance/height the camera sits at for each zoom stop.

Config.Camera = {
    fov = 40.0,
    lateralRatio = 0.0, -- 0.0 = centered framing
    offsets = {
        head  = { z = 0.65,  dist = 0.95 },
        torso = { z = 0.20,  dist = 1.65 },
        legs  = { z = -0.35, dist = 1.75 },
        feet  = { z = -0.75, dist = 1.25 },
        full  = { z = 0.0,   dist = 2.40 },
    },
    default = { z = 0.0, dist = 2.40 }
}

🧑 Ped Catalog & Change RulesCopy Anchor Link

Config.Peds is a declaration only, listing a ped here makes it available, and it becomes locked the moment you map it to a Tebex package in /shopmanager. See Ped Catalog & Unlocks.

Config.Peds = {
    { model = 'mp_m_freemode_01', label = 'Male',   gender = 'male',   freemode = true },
    { model = 'mp_f_freemode_01', label = 'Female', gender = 'female', freemode = true },

    { model = 'g_m_m_armgoon_01', label = 'Goon',    gender = 'male' },
    { model = 'u_m_y_zombie_01',  label = 'Zombie',  gender = 'male' },
    { model = 'a_m_y_hipster_01', label = 'Hipster', gender = 'male' },
}

[!NOTE] These rules apply to a citizen who already has a saved character. The first character creation is always free.

Ped Changer TabsCopy Anchor Link

The Ped Changer is a full appearance session, not just a model picker: pick a body, then set its face, hair and skin in the same visit.

Config.PedShopTabs = { 'ped', 'heritage', 'face', 'hair', 'beard', 'makeup', 'skin' }

Tab names are the ones listed under Ped Surgery below. 'ped' is the model list itself.

[!TIP] Tabs that need a freemode body, heritage, face, beard, makeup, skin, are dropped automatically while a story ped is selected, because head blend and overlays do nothing on one. You don't need to manage that yourself.

[!WARNING] Config.PedsOpenToAll = true reverses the rule the rest of this section is built on, that changing body is an identity change you pay for once. Combined with the appearance tabs above it turns the Ped Changer into a walk-in character editor. Turn it on for a server where the ped is a costume; leave it off where the ped is a face.

💉 Ped Surgery (shared/config_surgery.lua)Copy Anchor Link

Surgeons change a patient's ped for in-game bank money. Off by default. Tebex peds are never offered. See Ped Surgery for the full flow.

Surgery TabsCopy Anchor Link

A surgery is a full character re-edit by default. The one price covers every tab, and nothing picked inside it is charged through the clothing cart.

Tabs = {
    'ped', 'heritage', 'face', 'hair', 'beard', 'makeup', 'skin', 'clothing', 'tattoos',
}

Trim the list to sell something narrower. An empty list falls back to { 'ped' }.

💇 Player Styling (shared/config_styling.lua)Copy Anchor Link

One player dresses another, inside a shop, with the shop type deciding which tabs open. Off by default. See Player to Player Styling for the full flow.

Tabs = {
    clothing = { 'clothing' },
    barber   = { 'hair', 'beard', 'makeup', 'skin' },
    tattoos  = { 'tattoos' },
    wardrobe = { 'clothing' },
}

[!WARNING] A shop type missing from Tabs hosts no styling at all, which is why ped is absent. A stylist picks your clothes, not your body, and the server strips ped from any list that names it.

🔒 Item Locks & RestrictionsCopy Anchor Link

The locks themselves are not configured here, you author them in the LOCK EDITOR inside any clothing shop (or with /lockitem · /lockworn), and they are stored in kc_item_locks. See Access Control & Blacklists for the full picture and Item Locks for the walkthrough.

These two keys only change how existing locks behave:

🎨 Colour Swatch PalettesCopy Anchor Link

• Config.HairColors: 64 HEX definitions matching GTA V's hair dye swatches (Jet Black, Ash Blonde, Platinum, Auburn, Pastel Pink, Neon Cyan, Lime Green…).
• Config.MakeupColors: 64 HEX definitions for lipstick, eyeshadow, blush and face paint overlays.

Each entry is { id = <game index>, name = '<label>', hex = '#rrggbb' }. The id must stay aligned with the game's palette index; the name and hex are display only.

🧬 Character Creator DataCopy Anchor Link

🎭 Interface Theme (shared/config_theme.lua)Copy Anchor Link

Recolours every screen in the resource. Setting accent alone is usually enough; anything you leave commented out keeps its shipped default. Restart the resource to apply.

To try colours before committing, use /shopmanager → Interface Theme: it previews live, for you only, and generates this block for you to paste. See Interface Theming.

Config.Theme = {
    accent   = '#ffffff', -- Primary action, active tab, selection border, header highlight

    canvas   = '#090a0e', -- Surfaces, darkest to lightest
    panel    = '#111318',
    raised   = '#181b22',
    input    = '#0b0c10',
    line     = '#22262f',
    lineSoft = '#16181f',

    text     = '#f0f2f5', -- Text colours
    text2    = '#b8c0ce',
    text3    = '#8a93a6',

    ok       = '#3d8c75', -- Status colours
    warn     = '#b88d3d',
    bad      = '#a33c30',

    radius   = 12,        -- Corner rounding in px
}

Ready-made accents: Azure #4f8ff7, Sky #38bdf8, Teal #2dd4bf, Emerald #34d399, Violet #a78bfa, Rose #fb7185, Amber #f0b24b, Brass #c5a880, Crimson #ef4444, White #ffffff.

🎒 Item-Based Clothing (shared/config_inventory.lua)Copy Anchor Link

Turns clothing into inventory items. See Inventory Clothing Items.

[!IMPORTANT] When Config.Inventory.Enabled = true, you must register clothing_item (or slot-specific item names) in your inventory system (ox_inventory, qb-core, qs-inventory, codem-inventory). See the Item-Based Clothing Installation Guide for exact item registration code snippets.

Config.Inventory = {
    Enabled        = true,  -- Master toggle for item-based clothing
    RemoveOnEquip  = true,  -- Consume the item once it is on the ped
    UseGenericItem = true,  -- One item for everything, vs slot-specific item names
    DefaultItem    = 'clothing_item',

    AutoEquip      = true,  -- Equip immediately on use
    ToggleEquip    = true,  -- Using it again takes the piece back off

    PinkFrogSync   = 'auto', -- PinkFrog ox_inventory v3 clothing slot sync: 'auto', true or false

    ProgressBar = {
        Enabled  = true,
        Duration = 2000, -- ms
        AnimDict = 'clothingtie',
        AnimClip = 'try_tie_neutral_a',
    },

    Items = {
        ['clothing_item'] = { label = 'Clothing Item', description = 'Generic wearable clothing piece' },
        ['mask']       = { slot = 1,  isProp = false, label = 'Mask' },
        ['gloves']     = { slot = 3,  isProp = false, label = 'Torso / Gloves' },
        ['pants']      = { slot = 4,  isProp = false, label = 'Pants' },
        ['bag']        = { slot = 5,  isProp = false, label = 'Bag / Parachute' },
        ['shoes']      = { slot = 6,  isProp = false, label = 'Shoes' },
        ['accessory']  = { slot = 7,  isProp = false, label = 'Accessory' },
        ['undershirt'] = { slot = 8,  isProp = false, label = 'Undershirt' },
        ['armor']      = { slot = 9,  isProp = false, label = 'Body Armor' },
        ['torso']      = { slot = 11, isProp = false, label = 'Jacket / Top' },
        ['hat']        = { slot = 0,  isProp = true,  label = 'Hat / Cap' },
        ['glasses']    = { slot = 1,  isProp = true,  label = 'Glasses' },
        ['earring']    = { slot = 2,  isProp = true,  label = 'Ear Accessory' },
        ['watch']      = { slot = 6,  isProp = true,  label = 'Watch' },
    }
}

PinkFrogSync keeps PinkFrog's ox_inventory v3 clothing slots in sync. See PinkFrog Inventory.

Bare DefaultsCopy Anchor Link

The drawable a slot falls back to when a piece is removed, with /takeoff, when unequipping an item, or when a locked garment is stripped on save. Set per body, because drawable ids do not line up between the two peds.

Config.BareDefaults = {
    male = {
        components = { [1] = 0, [3] = 15, [4] = 14, [5] = 0, [6] = 1,  [7] = 0, [8] = 15, [9] = 0, [10] = 0, [11] = 15 }
    },
    female = {
        components = { [1] = 0, [3] = 15, [4] = 15, [5] = 0, [6] = 35, [7] = 0, [8] = 14, [9] = 0, [10] = 0, [11] = 15 }
    }
}

Glove arms (Config.GloveArms)Copy Anchor Link

Optional. Lists which arms drawables are gloves for /takeoff gloves, and which bare arms each one swaps to, per gender. Key = arms drawable with gloves, value = bare arms drawable for the same top.

Config.GloveArms = {
    male = { [20] = 0, [21] = 1 },
    female = {}
}

Leave a gender empty ({}) to use the default: arms 0 to 15 count as bare, anything else is taken off to the [3] value in Config.BareDefaults.

🎨 Design Studio Configuration (shared/config_designer.lua)Copy Anchor Link

LimitsCopy Anchor Link

Enforced server-side and mirrored in the UI.

Designer.Limits = {
    maxLayers           = 24,               -- Graphic layers per design
    maxNameLength       = 32,
    maxPendingPerPlayer = 3,                -- Designs awaiting moderation
    maxOwnedPerPlayer   = 25,               -- Approved + live designs
    maxUploadBytes      = 8 * 1024 * 1024,  -- 8 MB ceiling per uploaded file
    canvasMax           = 2048,             -- A base's canvas must match its template texture, or it upscales at bake
    submitBytesPerSec   = 1024 * 1024,      -- Latent-event pacing for a submit
}

CreditsCopy Anchor Link

A credit is one design submission. Every citizen receives StarterAmount once, the first time anything asks for their balance. See Tebex Monetization & Design Credits.

Designer.Credits = {
    Enabled       = true, -- false = submissions cost no credits
    StarterAmount = 3,    -- Free credits, granted once per citizen
    CostPerSubmit = 1,

    Tebex = {
        Enabled = false,  -- Packages are mapped to credit amounts in /shopmanager
    },
}

PriceCopy Anchor Link

Designer.Price = {
    garment = 2500, -- In-game currency charged to publish a garment
}

Base GarmentsCopy Anchor Link

Each entry is a garment shell a player can design on: its mesh, its blank template, the texture target the studio binds its live preview to, and where the baked result lands.

Designer.Bases = {
    {
        id          = 'tee_m',
        label       = 'T-Shirt',
        kind        = 'garment',
        gender      = 'male',
        componentId = 11,
        canvas      = { w = 1024, h = 1024 },
        txd         = 'mp_m_freemode_01_kartikbase^jbib_diff_000_a_uni',
        txn         = 'jbib_diff_000_a_uni',
        blank       = 'assets/bases/tee_m/blank.png',
        ydd         = 'assets/bases/tee_m/mp_m_freemode_01_kartikbase^jbib_000_u.ydd',
        collection  = 'kartikbase',
        pack        = { drawable = 0, slots = 1 },
    },
    -- pant_m, jacket_m, shirt_m, shoes_m ...
}

Shipped bases: tee_m (T-Shirt, 1024²), pant_m (Pants, 2048²), jacket_m (Jacket, 2048²), shirt_m (Shirt, 2048²), shoes_m (Shoes, 2048²).

[!WARNING] Female bases (top_f, top2_f) ship commented out. The apparel meta, collection .ymt and baked filenames are male-ped only, so a female design would bake but never be wearable.

Designer.getBase(id) returns a base table by id, and is available to both client and server scripts.

💉 Tattoo Configuration (shared/config_tattoos.lua)Copy Anchor Link

Config.Tattoos holds the native GTA V tattoo overlays, keyed by zone:

[!NOTE] Tattoos have no lock layer yet, job/gang-restricted or blacklisted tattoos are planned but not in yet. Today the only way to take a tattoo out of circulation is to delete or comment out its entry here. See Access Control.

• ZONE_TORSO (chest, back, stomach)
• ZONE_HEAD (head, face, neck)
• ZONE_LEFT_ARM / ZONE_RIGHT_ARM
• ZONE_LEFT_LEG / ZONE_RIGHT_LEG

Each entry carries the overlay name, a display label, the male and female overlay hashes, its zone, and the collection it streams from (mpbiker_overlays, mpsmuggler_overlays, mpairraces_overlays, …):

{
    name        = "TAT_AR_000",
    label       = "Turbulence",
    hashMale    = "MP_Airraces_Tattoo_000_M",
    hashFemale  = "MP_Airraces_Tattoo_000_F",
    zone        = "ZONE_TORSO",
    collection  = "mpairraces_overlays"
}

🗂️ Categories (shared/categories.lua)Copy Anchor Link

Controls which categories appear in each interface, and the order they appear in:

Categories.List is an alias of Categories.Clothing, kept for older integrations.

[!TIP] shared/categories.lua decides which categories appear in each interface. Every store of the same type shows the same list. kc_shops has a categories column, but the shop UI does not read it yet, so per-store category lists are not supported today.