Installation

Requirements, server.cfg, the first start and admin access.

This page takes you from the downloaded package to a running Obsi Inventory with admin access. It replaces an existing ox_inventory, or installs fresh.

Requirements

RequirementNotes
FiveM server build 6116 or newerWith OneSync enabled
oxmysqlDatabase access
ox_libMust start before the inventory
A frameworkESX Legacy, Qbox, ox_core or ND Core
illenium-appearance or fivem-appearanceOptional: real clothing images and saving the appearance after a change
ox_targetOptional: target options for shops, stashes, dumpsters and trunks

Install

  1. Put the resource in place

    Unpack the package into your resources folder and name the folder ox_inventory. If you already run ox_inventory, move the old folder out of resources first, so only one copy starts.
  2. Add it to server.cfg

    Start the dependencies first, then the inventory:
    server.cfg
    ensure oxmysql
    ensure ox_lib
    ensure es_extended            # your framework
    ensure illenium-appearance    # optional
    ensure ox_inventory
    
    setr inventory:framework esx  # esx / qbx / ox / nd
    setr inventory:slots 35       # 5 pockets + 20 base slots + 10 backpack slots
    setr inventory:target false   # true = use ox_target for shops and stashes
    
    add_ace group.admin command.invadmin allow
  3. Start the server

    The obsi_inv_* tables are created on the first start. There is no SQL file to import.
  4. Open the admin panel

    Type /invadmin in chat. Players with the group.admin ace get every page. Give other staff a role on the Permissions page.

Item images

Put PNG images named after the item into web/images/, for example web/images/backpack_large.png. Until an image exists, the slot shows an icon instead.

The items that ship with Obsi Inventory are clothing, clothing_hanger, backpack_small, backpack_large, armor_vest, plate_light, plate_medium, plate_heavy and tint_1 to tint_7.

Check it works

  • Press F2 (the default key, set by the inventory:keys convar) and the three-column console opens.
  • The pockets at the bottom left show slots 1 to 5.
  • Under the grid, NEED A BACKPACK shows the locked backpack slots.
  • /invadmin opens the ADMIN PANEL tab.

Building from source

Release packages already contain the built interface. If you work from the source repository, build it yourself:

pnpm --dir web install
pnpm --dir web build