Skip to content

NikXpro/ox_inventory

 
 

Repository files navigation

Framework

The inventory was designed with the intention to move towards a more generic / standalone structure so it can be integrated into any framework without too much hassle. I will be writing a guide for manually setting up support sometime soon™. In the mean-time, it will work without any alterations if using the latest updates to ESX Legacy.

Experimental support for qb-core has been added, but requires a recent installation. Do not expect 100% compatibility or support.

Config

Refer to the documentation setting your config. When set, you can add the following to your 'server.cfg'

exec @ox_inventory/config.cfg
ensure ox_inventory

Logging

The included logging module utilises datadog to store logging data, which can be expanded for improved analytics and metrics. Register an account at datadoghq. The free plan is enough for most user's purposes and provides far more utility than the typical weird discord logs utilised in other resources.

Once you have registered, generate an API key and add set datadog:key 'apikey' to your server config.

Features

Shops

  • Creates different shops for 24/7, Ammunation, Liquor Stores, Vending Machines, etc.
  • Job restricted shops, such as a Police Armoury.
  • Items can be restricted to specific job grades and licenses.
  • Define the price for each item, and even allow different currency (black money, poker chips, etc).

Items

  • Generic item data shared between objects.
  • Specific data stored per-slot, with metadata to hold custom information.
  • Weapons, attachments, and durability.
  • Flexible item use allows for progress bars, server callbacks, and cancellation with simple functions and exports.
  • Support for items registered with ESX.

Stashes

  • Server-side security prevents arbitrary access to any stash.
  • Support personal stashes, able to be opened with different identifiers.
  • Job-restricted stashes as well as a police evidence locker.
  • Server exports allow for registration of stashes from any resource (see here).
  • Access small stashes via containers, such as paperbags, from using an item.
  • Vehicle gloveboxes and trunks, for both owned and unowned.

Temporary stashes

  • Dumpsters, drops, and non-player vehicles.
  • Loot tables allow users to find random items in dumpsters and unowned vehicles.



Legal Notices

Ox Inventory

Copyright © 2022 Linden, Dunak, Luke

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/

About

Slot-based inventory with metadata.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Lua 79.2%
  • TypeScript 18.6%
  • SCSS 2.1%
  • HTML 0.1%