Skip to main content
skill CX Codex

ox-inventory — Claude Code skill: features and install

This Claude Code skill guides Lua work with ox_inventory, from item changes to stashes, shops, and inventory hooks. It activates for requests to register storage or move code from qb-inventory or esx inventory.

MIT 104 installs ★ 20 updated 2026-10-17

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add germanfndez/fiveai-skills --skill ox-inventory -a claude-code
Open on GitHub

What ox-inventory does

The skill shows how to call ox_inventory exports and keep server-side changes separate from client-side display logic. Item grants and removals belong on the server; client exports handle presentation and UI choices. When code introduces an item, the skill includes its definition in data/items.lua.

For a trade, it orders the checks and changes: call CanCarryItem, take payment, run AddItem, then inspect the result. AddItem can fail when the inventory exceeds its weight limit or has no free slots. Calls use exports.ox_inventory; there is no global table.

Start ox_lib and the framework core before ox_inventory. The skill covers ox_core, esx, and qbx_core, and recommends hooks for reacting to moves, inventory openings, or purchases instead of polling.

What it helps with

  • grant or remove an item on the server
  • check an item's count and available capacity
  • register a stash or shop
  • define an item in data/items.lua
  • react to inventory actions with hooks

Example prompts for the agent

  • Write server-side code to grant an item and check whether it succeeded.
  • Register a stash for this location in ox_inventory.
  • Move this inventory logic from qb-inventory to ox_inventory.

How to install ox-inventory

1Skills CLI (Vercel)

npx skills add germanfndez/fiveai-skills --skill ox-inventory -a claude-code

2Manually: put the files in place

~/.claude/skills/ox-inventory/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/ox-inventory/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about ox-inventory

How do I install ox-inventory in Claude Code?

Run npx skills add germanfndez/fiveai-skills --skill ox-inventory -a claude-code. The skill file is at ~/.claude/skills/ox-inventory/SKILL.md.

What does ox-inventory do?

It guides Lua code for ox_inventory items, stashes, shops, and hooks. It also distinguishes server-side inventory changes from client-side display logic.

Which frameworks does ox-inventory support?

It supports ox_core, esx, and qbx_core. ox_lib and the framework core must start before ox_inventory.

Source text

SKILL.md · MIT
---
name: ox-inventory
description: "Trigger: ox_inventory, items, stash, AddItem, RemoveItem, metadata, item registration, inventory hooks, shops. Server and client exports for ox_inventory."
license: MIT
metadata:
  author: germanfndez
  version: "1.0.0"
---

# ox_inventory

Slot-based inventory with weight, metadata, stashes, shops and hooks. Supports ox_core, esx and qbx_core.

## Activation Contract

Load this skill when the user asks to give, take, count or check items, register a stash or shop, define a new item, react to inventory actions, or migrate from qb-inventory or esx inventory.

## Hard Rules

- Call everything through `exports.ox_inventory:<fn>(...)`. There is no global table.
- Grant, remove and count items on the SERVER only. Client exports are for display and UI decisions.
- `AddItem` can fail. Always check the return value: the player may be over weight or out of slots.
- Check `CanCarryItem` BEFORE taking payment or removing the traded item, never after.
- Never invent item names. An item must exist in `data/items.lua` or it silently fails.
- `inv` is a player source, an identifier, or a stash id. Passing the wrong one returns nil, not an error.
- Metadata makes items non-stackable when it differs. Do not put volatile data in metadata.

## Decision Gates

| Goal | Call |
|---|---|
| Give an item | `AddItem(inv, item, count, metadata, slot)` |
| Take an item | `RemoveItem(inv, item, count, metadata, slot)` |
| Check space first | `CanCarryItem(inv, item, count, metadata)` |
| How many does the player have | `GetItemCount(inv, item, metadata, strict)` |
| Read one slot | `GetSlot(inv, slot)` |
| Find items across slots | `Search(inv, 'slots'\|'count', item, metadata)` |
| Persistent storage | `RegisterStash(...)` |
| Short-lived storage | `CreateTemporaryStash(properties)` |
| React to a player action | `registerHook(event, cb, options)` |

## Execution Steps

1. Confirm `ox_inventory` starts after `ox_lib` and the framework core.
2. Decide the side: mutation is server, display is client.
3. For a trade or reward, order the calls: `CanCarryItem` -> take payment -> `AddItem` -> verify the return.
4. Define any new item in `data/items.lua` before referencing it. Read rules/items.md.
5. Use hooks instead of polling when reacting to moves, opens or purchases.

## Output Contract

Return runnable Lua using `exports.ox_inventory`, with the server/client split explicit. Include the `data/items.lua` entry whenever a new item is introduced.

## References

- rules/server-exports.md — item and inventory functions on the server.
- rules/client-exports.md — weight, current weapon, opening inventories.
- rules/items.md — defining items in data/items.lua.
- rules/stashes.md — stashes, shops and temporary storage.
- rules/hooks.md — registerHook and cancelling actions.

Upstream docs: https://overextended.dev/ox_inventory

© germanfndez · MIT · germanfndez/fiveai-skills

Similar skills

All skills for Game dev and 3D: Unity, Unreal, Godot, Blender →

From the same set12

The whole set →
lua-basics lua-basics — a skill that makes your coding agent follow Lua conventions for FiveM resources: naming, locals, tables and error handling. CX Codex +1 436installs fivemanage Teaches the agent to use the Fivemanage SDK: capture player screenshots, upload images and push logs to the dashboard via exports.fmsdk. CX Codex +1 367installs esx-framework esx-framework keeps an AI coding agent inside the ESX Legacy API when it writes FiveM resources: server and client sides, player objects, callbacks, jobs, money. CX Codex +1 319installs qbcore-framework qbcore-framework helps build FiveM resources on qb-core by generating server and client Lua code with argument validation, callback handling, and proper Player object methods. CX Codex +1 272installs oxmysql This Claude Code skill writes server-side SQL for FiveM through oxmysql. It activates for database queries and migrations from mysql-async. CX Codex +1 124installs oxlib This Claude Code skill helps write Lua code with ox_lib in FiveM resources. It activates for UI, zones, commands, and client-server requests. CX Codex +1 117installs fivem-deployment The fivem-deployment Claude Code skill selects and checks FXServer builds. It activates for server updates, server.cfg edits, or client connection problems after an update. CX Codex +1 114installs ox-target This Claude Code skill builds FiveM interactions with ox_target. It activates for target options, interaction zones, or migrations from qb-target. CX Codex +1 102installs

Project sponsors

Companies that keep this analytics open