Overview

This page covers only the Awoken rework’s additions to ox_inventory. For the standard ox_inventory convars (framework selection, slot count, weight limit, police groups, hotbar slots, logging, etc.), refer to the upstream documentation - those are unchanged.

Standard ox_inventory configuration

Convars, framework selection, slot/weight defaults, logging, hotbar - all the base settings live in the official Overextended docs.

The Awoken-specific settings live in two places:

config.json in the resource root - every visual and UX option the overhaul adds.
data/containers.lua - the new container definitions file. See Containers.

config.json ships plaintext and is intended for non-developer editing. Save the file and ensure ox_inventory - no rebuild required.

Bigger features have their own pages:

Rarity - the five-tier rarity system.
Tags - the multi-select filter and tag definitions.
Containers - paper bags, gun boxes, first-aid kits, whitelist/blacklist rules.
Throwable Items - make any item physically throwable with a prop model and hand offset.

Theme & colours

config.json

{
  "accentColor":         "#00E5FF",
  "panelBlur":           true,
  "panelOpacity":        0.60,
  "backdropColor":       "#212121",
  "backdropOpacity":     0.85,
  "backdropGlowOpacity": 0.06
}

Key	Effect
`accentColor`	Highlights, borders, active states, default notification colour.
`panelBlur`	Frosted-glass blur behind inventory panels.
`panelOpacity`	Panel transparency (`0.0`–`1.0`).
`backdropColor` / `backdropOpacity`	Dark overlay behind the UI while open.
`backdropGlowOpacity`	Subtle radial glow behind the UI (`0.0`–`1.0`).

accentColor drives every “active” element in the UI - selected sort mode, active filter button, hotbar key chip, etc. Set it once and the whole inventory rethemes.

Global Awoken accent (cross-resource theming)

If you run multiple Awoken-branded resources and want them all to share the same accent colour, set a single convar in server.cfg:

server.cfg

setr awoken:primaryColor "#00E5FF"

When this convar is set, it overrides accentColor in config.json. Leave it unset (or empty) to use the config.json value. The convar value is read at UI load and applied immediately - no rebuild required.

Item display toggles

config.json

{
  "showItemLabels": true,
  "circularWeight": true,
  "showRarity":     true
}

Key	Effect
`showItemLabels`	Show the item name text inside every slot.
`circularWeight`	Display the circular weight ring in the inventory header (otherwise weight is text-only).
`showRarity`	Master toggle for rarity glow / borders / badges. See Rarity for the full tier config.

Durability - colours & stacking

config.json

{
  "durabilityGood":   "#27ae60",
  "durabilityMedium": "#f59e0b",
  "durabilityBad":    "#ef4444",
  "durabilityStack":  "weighted_average"
}

The three colours render the three-tier durability bar on every slot, hotbar slot, and notification.

`durabilityStack` - three modes

Controls how durability is resolved when two stacks of the same item with different durability values are merged.

Mode	Behaviour	Worked example (10× @ 100 + 5× @ 40)
`weighted_average`(default)	Count-proportional average. Realistic but technically exploitable (mixing one broken into a fresh stack barely shifts the average).	→ 15× @ 80
`lowest`	Take the worst durability of the two. Unexploitable - players can’t “wash” a worn stack by mixing it with fresh items.	→ 15× @ 40
`block`	Stacks with different durability refuse to merge at all. They stay as separate slots.	The two stacks swap slots instead of merging.

config.json

"durabilityStack": "lowest"

Notifications

config.json

{
  "notificationPosition": "right-center",
  "notificationActions": {
    "ui_added":     "#2ecc71",
    "ui_removed":   "#e74c3c",
    "ui_holstered": "#f39c12",
    "ui_equipped":  "#3498db"
  }
}

notificationPosition accepts: bottom-center, top-center, right-center, left-center, top-right, top-left, bottom-right, bottom-left. Any action key not listed in notificationActions falls back to accentColor.

Clothing Panel

A dedicated 12-slot panel for clothing (Hat, Glasses, Mask, Gloves, Jacket/Shirt, Neck, Armour, Bag, Pants, Shoes, Watch, Bracelet). Players toggle the panel from the hotbar.

config.json

{
  "appearanceResource": "illenium-appearance"
}

Value	Behaviour
`illenium-appearance`	Use Illenium Appearance for clothing get/set.
`ox_appearance`	Use ox_appearance.
`fivem-appearance`	Use fivem-appearance.
`none`	Fall back to raw GTA natives (limited functionality).

Naked drawable overrides (custom MP peds)

When a player strips a clothing slot via the Clothing Panel, the resource applies a “naked” drawable ID for that slot. Defaults match the standard mp_m_freemode_01 / mp_f_freemode_01 peds. Override only the slots you need to fix - any slot not listed falls back to the default.

config.json

"clothing": {
  "nakedDrawables": {
    "comp_4": { "male": 21, "female": 15 },
    "comp_6": { "male": 34, "female": 35 }
  }
}

Slot key	What it is
`comp_1`	Mask
`comp_3`	Gloves / arms
`comp_4`	Pants
`comp_5`	Bag / backpack
`comp_6`	Shoes
`comp_7`	Neck accessory
`comp_9`	Vest / armour
`comp_11`	Jacket / top (also clears undershirt, torso, decals)

Common symptom that this fixes: “the strip toggle only works on the jacket / top”. That usually means your custom ped pack has different drawable counts and the hardcoded values for the other slots don’t exist on your peds.

Right-clicking an item shows Use, Give and Drop, plus any extra actions the item defines through buttons in data/items.lua. A button entry takes an optional icon so a custom action matches the built-ins instead of sitting there bare next to them.

data/items.lua

['testburger'] = {
    label = 'Test Burger',
    buttons = {
        {
            label = 'Lick it',
            icon  = 'Eye',
            action = function(slot)
                print('You licked the burger')
            end
        },
    },
}

Supported icon names: Circuitry, Coins, Eye, Gear, HardDrive, Key, Note, Package, Pill, SimCard, Toolbox, Wrench

icon is optional. A name that is not on the list renders the button without an icon rather than breaking the menu, so a typo costs you an icon and nothing else.

The list is deliberately fixed. Resolving an arbitrary icon name at runtime means shipping the entire icon set in the UI bundle, so adding one is a small code change: add it to web/src/components/inventory/buttonIcons.ts and rebuild the web UI. The right-click menu and the item tooltip each have their own colours. The menu settings also theme the split window, since that is opened from the menu.

config.json

{
  "contextMenuColor": "#06080E",
  "contextMenuOpacity": 0.97,
  "contextMenuTextColor": "#FFFFFF",
  "contextMenuIconColor": "#8B94A3",

  "tooltipColor": "#06080E",
  "tooltipOpacity": 0.97,
  "tooltipTextColor": "#FFFFFF",
  "tooltipLabelColor": "#8B94A3"
}

Setting	What it covers
`contextMenuColor` / `contextMenuOpacity`	Menu and split window background. Opacity runs 0.0 to 1.0
`contextMenuTextColor`	Menu entry labels, and the split window title, numbers and buttons
`contextMenuIconColor`	Menu entry icons, and the split window item name
`tooltipColor` / `tooltipOpacity`	Tooltip background
`tooltipTextColor`	Item name, description and stat values
`tooltipLabelColor`	Weight, and the stat names beside their values

The rarity badge keeps its colour from your rarity entries, and the crafting duration keeps the accent colour, so both stay readable whatever you set here.

Splitting a stack

Right-click any stack of more than one and choose Split. The window opens at an even split, and you can drag the slider or type into either box, the other side follows. An odd stack leaves the larger half where it is. The new stack goes into the first free slot in the same inventory. If there is no free slot the confirm button says so rather than failing when clicked.

There is nothing to configure here. Splitting is a normal item move as far as the server is concerned, so it obeys weight, slot and container rules exactly as dragging does.

Bags on the floor

A dropped bag can be opened by standing over it and pressing the inventory key, by looking at it with ox_target, or both. Both are on by default.

config.json

{
  "dropTarget": true,
  "dropKeypress": true
}

Setting	Effect
`dropTarget`	Adds an ox_target option on the bag. Needs ox_target running
`dropKeypress`	Keeps the inventory key opening a bag you are stood over

dropTarget does not need inventory:target. That convar decides whether stashes and shops use target zones instead of markers, and plenty of servers leave it off while still running ox_target for everything else.

Set inventory:dropprops 1 in your server.cfg to spawn a bag prop instead of a marker, and inventory:dropmodel to change which prop. The target sits on the bag either way.

Search, Sort & Filters

The toolbar at the top of every inventory grid exposes:

Search - toggle the search bar with the hotbar Search button. Filters items by name in real time.
Sort - 9 sort modes: default, name (asc/desc), weight (asc/desc), count (asc/desc), rarity (asc/desc).
Rarity filter - multi-select chips for each rarity tier you’ve defined.
Tag filter - multi-select chips for each tag present in the open inventory.

These are always available - there’s no config.json toggle to disable them. The rarity filter button is hidden automatically if showRarity is false; the tag filter button is hidden if no items in the current inventory have any tags.

Filter state (search query, sort mode, active rarities, active tags) persists across opening and closing the inventory within the same session. Left and right inventory grids keep an independent filter state.

Get Started

Awoken Scripts

Standard ox_inventory configuration

Theme & colours

Global Awoken accent (cross-resource theming)

Item display toggles

Durability - colours & stacking

`durabilityStack` - three modes

Notifications

Clothing Panel

Naked drawable overrides (custom MP peds)

Item context-menu buttons

Right-click menu & tooltip colours

Splitting a stack

Bags on the floor

Search, Sort & Filters

Standard ox_inventory configuration

​Theme & colours

​Global Awoken accent (cross-resource theming)

​Item display toggles

​Durability - colours & stacking

​durabilityStack - three modes

​Notifications

​Clothing Panel

​Naked drawable overrides (custom MP peds)

​Item context-menu buttons

​Right-click menu & tooltip colours

​Splitting a stack

​Bags on the floor

​Search, Sort & Filters

Theme & colours

Global Awoken accent (cross-resource theming)

Item display toggles

Durability - colours & stacking

`durabilityStack` - three modes

Notifications

Clothing Panel

Naked drawable overrides (custom MP peds)

Item context-menu buttons

Right-click menu & tooltip colours

Splitting a stack

Bags on the floor

Search, Sort & Filters