> ## Documentation Index
> Fetch the complete documentation index at: https://docs.awokenlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Where the Awoken-specific config lives and what it covers.

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.

<Card title="Standard ox_inventory configuration" icon="link" href="https://overextended.dev/ox_inventory/Config">
  Convars, framework selection, slot/weight defaults, logging, hotbar - all the base settings live in the official Overextended docs.
</Card>

The Awoken-specific settings live in two places:

1. **`config.json`** in the resource root - every visual and UX option the overhaul adds.
2. **`data/containers.lua`** - the new container definitions file. See [Containers](/configuration/containers).

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

Bigger features have their own pages:

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

## Theme & colours

```json config.json theme={"dark"}
{
  "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`).                  |

<Tip>
  `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.
</Tip>

### 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`:

```cfg server.cfg theme={"dark"}
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

```json config.json theme={"dark"}
{
  "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](/configuration/rarity) for the full tier config. |

## Durability - colours & stacking

```json config.json theme={"dark"}
{
  "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. |

```json config.json theme={"dark"}
"durabilityStack": "lowest"
```

## Notifications

```json config.json theme={"dark"}
{
  "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.

```json config.json theme={"dark"}
{
  "appearanceResource": "illenium-appearance"
}
```

| Value                 | Behaviour                                                                                               |
| --------------------- | ------------------------------------------------------------------------------------------------------- |
| `illenium-appearance` | Use [Illenium Appearance](https://github.com/iLLeniumStudios/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.

```json config.json theme={"dark"}
"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)* |

<Info>
  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.
</Info>

## 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.

<Tip>
  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.
</Tip>