# List Inventory

{% hint style="danger" %}

### BETA RELEASE

This is currently a **BETA** release, some issues are to be expected but they will be fixed asap!\
Any additional systems requested can be added down the line. \
\
If you have purchased the **BETA**, you're appreciated :heart:
{% endhint %}

<figure><img src="/files/tmqrTBA4Cz96EDHfC9Nd" alt=""><figcaption></figcaption></figure>

**A flashback to inventory systems that made sense — now modernized, modularized, and way less ugly.**

**Not a Grid. Not a Puzzle. Just an Inventory.**

Built using BDUK’s flexible card UI - think old-school MMOs with 2025 - level extensibility. \
It’s everything you liked about classic inventories, without the trash fires.

***

## What Is This Inventory?

A clean, fully modular inventory system that works out of the box with:

* Player inventories
* Containers (trunks, fridges, drops, whatever)
* Item rarities
* Item degradation
* Containers providing quality preservation
* Stack splitting & transfers
* Props, animations, and usable item logic
* Weapon handling with ammo + attachments
* Weapon serial codes
* Weapon allow-list and clearing

Oh, and it looks good too. Because we're not savages.

***

## Who It’s For

It was built mainly as a working project to learn about inventory systems and provide a different take on to inventory scene, so for anyone tired of inventory systems that:

* Fight you at every turn
* Are bolted onto old RP frameworks
* Have 8000 exports to transfer a sandwich

If you’re building a survival system, hardcore PvP loot loop, or just want something actually usable without 40 dependencies - this is it.

#### You get:

* Simple list-based logic (no weight shenanigans)
* Clean object-oriented design
* Proper registry-based item actions
* A working item degradation system (yes, actually works)
* Support for quick use, props, tooltips, and serials

***

## What It Supports

* **Player + Container Inventories**\
  Uses factory-based logic and clean public/private method splitting.\
  Containers include drops, trunks, gloveboxes, fridges, lockers, etc.
* **Modular Actions**\
  Each item can have custom `use`, `modify`, whatever.\
  Global actions include:
  * Use
  * Drop (full/partial)
  * Split
  * Transfer (all/amount)
  * Modify (attachments, plus more soon..)
* **Attachments & Weapons**\
  Weapons support:
  * Serial numbers
  * Ammo types (via items)
  * Attachments (client component sync)
  * Persistent state per item
* **Item Degradation**\
  Items can lose quality over time - some containers block degrade to preserve items (like fridges).\
  That moldy sandwich? Yeah, it’s coming for you.
* **Stylized Tooltip Cards**\
  Hover. Flex. Cry at the quality stat slowly ticking down.
* **BDUK UI Integration**\
  Uses the full power of the modal and card system. Minimal performance cost. Max vibes.

***

## Structure

```bash
list_inventory/
│
├── core/
│   ├── actions/          # All transferable/useable logic: use, drop, split, transfer, modify
│   ├── containers/       # Container logic: creation, syncing, methods
│   ├── lib/              # Utility functions (slots, item formatting)
│   ├── player/           # Player inventory logic
│   ├── client.lua        # UI and client-side actions
│   ├── degrade.lua       # Quality / durability logic
│   └── registry.lua      # Item registry (on_use hooks etc.)
│
├── data/                 # Preloaded definitions (items, containers, vehicles)
├── images/               # Item icons
├── locales/              # i18n (default: en.lua)
├── wrappers/             # Framework support (QBCore, bdsc, + more asap)
├── fxmanifest.lua        # Manifest
├── install.sql           # Install schema
└── init.lua              # Boot logic and base configuration
```

***

## Quick Install

No 300-step wizard. Just drop and go.

1. Drop into your resources folder
2. Ensure your framework wrapper is configured (`qb.lua`, `bdsc.lua`)
3. `ensure list_inventory` in your server.cfg
4. Run the included SQL file
5. Enjoy.

***

## Why List, Though?

Grid inventories are fine… if you like visual Sudoku every time you pick up a bottle of water.

This isn’t for that.

`list_inventory` is:

* **Fast to use**
* **Easy to extend**
* **Good for gameplay loops where layout doesn’t matter**
* **Still sexy enough to feel modern**

Want a grid or slot inventory? Go write one *(or wait for ours)*. \
Want to *play* your game? Use this.

***

## Notes

This is a **beta** release. That means:

* There *will* be edge cases.
* We *might* bully you if you ignore the docs.
* But we’re also here to fix bugs and improve it.

This isn’t a toy system — it’s powering survival, PvP, and loot-heavy servers already.\
You get full source access. Extend it. Break it. Fork it. Just don’t complain when your fridges explode because you renamed a method called `degrade_item`.


---

# Agent Instructions: 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:

```
GET https://docs.boii.dev/fivem-paid-resources/list-inventory.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.