NightZoom LogoNightZoom

BJJ Inventory

High-level overview of the BJJ Inventory system and its integration points for external collaborators.

BJJ Inventory is a modular, closed-source inventory framework for FiveM. It provides public APIs, state management, and event hooks for inventory, item, and storage features, while keeping internal logic secure.

Core Features

  • Inventory Management: Add, remove, and query items in player and world inventories.
  • Storage & Stashes: Integrate with stashes, shops, and containers using public exports.
  • Item System: Access item metadata, types, and custom logic via safe APIs.
  • Event Hooks: Listen for inventory changes, item usage, and stash events.
  • Permissions: Leverage permission checks for restricted actions.

Supported Versions

  • Integration guides and API references for version 1.x.
  • View detailed docs under /docs/bjj-inventory/v1/.
  • Older versions available upon request.
  • Contact the development team for legacy documentation.

Use the public exports (getInventory, getItem, addItem, removeItem, etc.) to integrate safely. Do not access internal logic directly.

Integration Points

  • Exports: Access inventory and item APIs via exports['bjj_inventory'].
  • Events: Listen for inventory and stash events for reactive features.
  • Callbacks: Use lib.callback for server-client inventory operations.

Further Reading

For additional assistance or to request archived documentation, please contact the BJJ Inventory development team.