> For the complete documentation index, see [llms.txt](https://f4-studio.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://f4-studio.gitbook.io/documentation/resources/f4-inventory.md).

# f4-inventory

Welcome to the official GitBook documentation for F4 Inventory.

This documentation is written for servers using the escrow-protected package. It only describes the files and public integration surfaces that customers are expected to access:

* `shared/config.lua`
* `shared/definitions.lua`
* `shared/locales/`
* `client/open.lua`
* `server/open.lua`
* Public exports, hooks, events, commands, and convars

Encrypted source files are not part of the customer editing surface. When a behavior depends on encrypted runtime code, the documentation explains the public contract instead of asking you to edit protected files.

{% hint style="info" %}
Keep your custom work in the open files listed above. This makes updates safer and avoids losing changes when replacing escrow files.
{% endhint %}

## What you can do with these docs

* Install F4 Inventory on QBX, QB-Core, or ESX.
* Configure inventory behavior, storage limits, drops, hotbar keys, robbery rules, clothing slots, vehicle storage, back weapons, and logs.
* Add items, weapons, ammo, attachments, shops, stashes, evidence lockers, and crafting benches.
* Create and override locales.
* Add safe client-side UX checks in `client/open.lua`.
* Add real server-side security checks in `server/open.lua`.
* Integrate other resources through native exports, compatibility exports, hooks, and public events.
* Import data from supported inventory resources.

## Recommended reading order

1. [Installation](/documentation/resources/f4-inventory/getting-started/installation.md)
2. [Escrow and Editable Files](/documentation/resources/f4-inventory/getting-started/escrow-and-editable-files.md)
3. [Main Configuration](/documentation/resources/f4-inventory/configuration/main-configuration.md)
4. [Definitions Overview](/documentation/resources/f4-inventory/definitions/definitions-overview.md)
5. [Items](/documentation/resources/f4-inventory/definitions/items.md)
6. [Shops](/documentation/resources/f4-inventory/definitions/shops.md)
7. [Open Hooks and Security](/documentation/resources/f4-inventory/customization/open-hooks-and-security.md)
8. [Server Exports](/documentation/resources/f4-inventory/api/server-exports.md)
9. [Complete Examples](/documentation/resources/f4-inventory/cookbook/complete-examples.md)

##