Skip to content

PulsarFW/ox_inventory

 
 

Repository files navigation

Pulsar Framework

ox_inventory

Slot-based inventory system — Pulsar Framework edition


Lua FiveM React TypeScript Mantine


Overview · Bridge · Configuration · UI Development · Dependencies


Overview

A production fork of ox_inventory shipping with a full Pulsar Framework bridge. Every resource in the stack — drugs, police, finance, targeting, crafting — interacts with inventory without modification. Item definitions, shop configs, and crafting tables are bundled directly into this resource.

Warning

Do not pull from upstream ox_inventory without reviewing bridge compatibility first. The bridge overrides core server and client behaviours.


Pending

Item Notes
Schematics — per-player unlock + DB storage Recipes register fine; missing the item use handler, MySQL write, and per-player merge on bench open
Notifications via pulsar-notify Item add/remove toasts currently use ox's built-in notify

Configuration

Add to server.cfg:

setr inventory:framework  "pulsar"
setr inventory:slots       50
setr inventory:weight      30000
setr inventory:target      0
Convar Default Description
inventory:framework ox Must be pulsar
inventory:slots 50 Player inventory slots
inventory:weight 30000 Max carry weight (grams)
inventory:target 0 0 = ox_lib points, 1 = ox_target zones
inventory:itemnotify 1 Show item add/remove HUD popups
inventory:loglevel 0 0 = off, 1 = high-value, 2 = all

Data Files

File Purpose
data/pulsar-items/ Item definitions — loaded and converted to ox format at boot
data/pulsar-crafting/crafting_config.lua Crafting bench definitions (label, location, targeting, recipes)
data/pulsar-crafting/schematic_config.lua Schematic recipes (per-player unlock via item use)
data/shops.lua Shop definitions — location-based and ped-spawned
data/licenses.lua License purchase point locations and prices

UI Development

The NUI is a React 18 + Mantine 7 + Redux app compiled with Vite.

cd web
bun install
bun run start    # dev server (http://localhost:3000) with hot reload
bun run build    # production build → web/build/

Theme: web/src/theme.ts — Pulsar purple palette (#7c3aed primary, #0a0614 dark base).
SCSS variables: web/src/index.scss — grid sizing, slot colours, typography.


Dependencies

Resource Purpose
ox_lib Points, callbacks, notify, keybinds, progress
oxmysql Database (inventory persistence)
pulsar-core Framework core — middleware, fetch, callbacks
pulsar-characters Character data — cash, name, SID, jobs
pulsar-pedinteraction Ped interaction events (shops, crafting)
ox_target World targeting (optional, controlled by inventory:target)


Credits

This resource is a fork of ox_inventory, originally developed by Linden and the Overextended team. All core inventory logic, database layer, weapon system, crafting grid, and NUI framework are their work.

The Pulsar Framework bridge (modules/bridge/pulsar/), item conversion pipeline, crafting config loader, cash-as-item sync, and UI retheme are additions made for this project and are not part of the upstream repository.

Original project communityox/ox_inventory
Original author Linden (thelindat)
Contributors Overextended
Bridge & modifications Pulsar Framework team

License

This resource inherits the license of the upstream project.

ox_inventory is licensed under the GNU Lesser General Public License v3.0 (LGPL-3.0).

You may use, modify, and distribute this software under the terms of the LGPL-3.0. Any modifications to the library itself must be released under the same license. See the full license text for details.

The Pulsar Framework bridge code located in modules/bridge/pulsar/ is proprietary and not covered by the upstream LGPL-3.0 license.


Pulsar Framework Built for FiveM License: LGPL v3

About

Ox Inventory with support for pulsar framework

Resources

License

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Lua 87.5%
  • TypeScript 11.5%
  • Other 1.0%