-
-
Notifications
You must be signed in to change notification settings - Fork 708
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
37 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,90 +1,58 @@ | ||
| <div align='center'><img src='https://user-images.githubusercontent.com/65407488/147992899-93998c0a-75fb-4055-8c06-8da8c49342d6.png'/> | ||
| <h2><a href='https://overextended.dev/ox_inventory'>Documentation</a></h3></div> | ||
| # ox_inventory | ||
|
|
||
| ## Config | ||
| A complete inventory system for FiveM, implementing items, weapons, shops, and more without any strict framework dependency. | ||
|
|
||
| Resource configuration is handled using convars. Refer to the documentation for more information. | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Framework | ||
| ## 📚 Documentation | ||
|
|
||
| The inventory was designed with limited reliability on frameworks, preferring frameworks _designed to use ox_inventory_. A framework is still necessary for handling certain features such as | ||
| https://overextended.dev/ox_inventory | ||
|
|
||
| - Loading player inventories. | ||
| - Owned vehicles. | ||
| - Licenses. | ||
| - Group/job systems. | ||
| ## 💾 Download | ||
|
|
||
| Compatibility for frameworks is handled in the "bridge" module, and by default includes | ||
| https://github.com/overextended/ox_inventory/releases/latest/download/ox_inventory.zip | ||
|
|
||
| ## ✨ Features | ||
|
|
||
| - Server-side security ensures interactions with items, shops, and stashes are all validated. | ||
| - Logging for important events, such as purchases, item movement, and item creation or removal. | ||
| - Supports player-owned vehicles, licenses, and group systems implemented by frameworks. | ||
|
|
||
| ### Supported frameworks | ||
| - [ox_core](https://github.com/overextended/ox_core) | ||
| - [es_extended](https://github.com/esx-framework/esx_core) | ||
| - [qbx-core](https://github.com/Qbox-project/qbx_core) or [qb-core](https://github.com/qbcore-framework/qb-core) | ||
| - [nd_core](https://github.com/ND-Framework/ND_Core) | ||
|
|
||
| Do not expect 100% compatibility or support for third party frameworks. | ||
|
|
||
| ## Features | ||
|
|
||
| ## Logging | ||
|
|
||
| Logging is built-in using ox_lib's [logger](https://overextended.dev/ox_lib/Modules/Logger/Server#liblogger) module, using Datadog or Grafana Loki. Discord is not and will not be supported. | ||
|
|
||
| ### 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 | ||
| - Inventory items are stored per-slot, with customisable metadata to support item uniqueness. | ||
| - Overrides default weapon-system with weapons as items. | ||
| - Weapon attachments and ammo system, including special ammo types. | ||
| - Durability, allowing items to be depleted or removed overtime. | ||
| - Internal item system provides secure and easy handling for item use effects. | ||
| - Compatibility with 3rd party framework item registration. | ||
|
|
||
| - 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. | ||
| ### Shops | ||
| - Restricted access based on groups and licenses. | ||
| - Support different currency for items (black money, poker chips, etc). | ||
|
|
||
| ### Stashes | ||
| - Personal stashes, linking a stash with a specific identifier or creating per-player instances. | ||
| - Restricted access based on groups. | ||
| - Registration of new stashes from any resource. | ||
| - Containers allow access to small stashes when using an item, such as a paperbag. | ||
| - Access gloveboxes and trunks for any vehicle. | ||
| - Random item generation inside dumpsters and unowned vehicles. | ||
|
|
||
| - 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](https://github.com/overextended/ox_inventory_examples/blob/main/server.lua)). | ||
| - 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. | ||
|
|
||
| <br><div><h4 align='center'><a href='https://discord.gg/hmcmv3P7YW'>Discord Server</a></h4></div><br> | ||
|
|
||
| <table><tr><td><h3 align='center'>License</h3></tr></td> | ||
| <tr><td> | ||
| Ox Inventory | ||
|
|
||
|
|
||
| Copyright © 2023 Overextended (https://github.com/overextended) | ||
|
|
||
| Linden (https://github.com/thelindat) | ||
|
|
||
| Luke (https://github.com/LukeWasTakenn) | ||
|
|
||
| Dunak (https://github.com/dunak-debug) | ||
| ## Copyright | ||
|
|
||
| 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. | ||
| Copyright © 2024 Overextended <https://github.com/overextended> | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| You should have received a copy of the GNU General Public License | ||
| along with this program. | ||
| If not, see <https://www.gnu.org/licenses/> | ||
| 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. | ||
|
|
||
| </td></tr></table> | ||
| You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. |