> For the complete documentation index, see [llms.txt](https://docs.kojascripts.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kojascripts.eu/koja-lib/inventory/overview.md).

# Overview

koja-lib provides a unified inventory API that works across multiple inventory resources. The same function calls work regardless of which inventory is installed.

## Supported Inventories

| Resource          | Detection Name         |
| ----------------- | ---------------------- |
| ox\_inventory     | `ox_inventory`         |
| qb-inventory      | `qb-inventory`         |
| qs-inventory      | `qs-inventory`         |
| codem-inventory   | `codem-inventory`      |
| jaksam\_inventory | `jaksam_inventory`     |
| Framework native  | `framework` (fallback) |
| Custom            | `custom`               |

## Detection Order

When `Config.Inventory = "auto"`, koja-lib checks for running resources in this order:

1. `ox_inventory`
2. `qb-inventory`
3. `qs-inventory`
4. `codem-inventory`
5. `jaksam_inventory`

The first one in `started` state wins. If none are running, koja-lib falls back to the framework's native item functions (ESX `addInventoryItem` / QB `Player.Functions.AddItem`).

## Runtime Value

```lua
print(KOJA.Inventory)
-- "ox_inventory" | "qb-inventory" | "qs-inventory" | "codem-inventory"
-- "jaksam_inventory" | "framework" | "custom"
```

## Forcing an Inventory

```lua
-- editable/shared/config.lua
Config.Inventory = "ox_inventory"
```

If the specified resource is not started, koja-lib prints a warning and falls back to auto-detection.

## Adapter Coverage

| Feature               | ox\_inventory | qb-inventory  | qs-inventory | codem-inventory | jaksam\_inventory |
| --------------------- | ------------- | ------------- | ------------ | --------------- | ----------------- |
| AddItem               | ✅             | ✅ (framework) | ✅            | ✅               | ✅                 |
| RemoveItem            | ✅             | ✅ (framework) | ✅            | ✅               | ✅                 |
| GetItemCount (server) | ✅             | ✅ (framework) | ✅            | ✅               | ✅                 |
| GetItemCount (client) | ✅             | ✅ (framework) | ✅            | ✅               | ✅                 |
| GetItems (server)     | ✅             | ✅ (framework) | ✅            | ✅               | ✅                 |
| GetItems (client)     | ✅             | ✅ (framework) | —            | ✅               | ✅                 |
| metadata support      | ✅             | —             | ✅            | ✅               | ✅                 |
| slot support          | ✅             | —             | ✅            | ✅               | ✅                 |

> `qb-inventory` and its forks keep QB's native item functions intact. koja-lib uses those automatically via the framework fallback, so you do not need a dedicated adapter for them.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kojascripts.eu/koja-lib/inventory/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.