Update README.md

This commit is contained in:
Jérémie N'gadi
2017-08-01 11:59:31 +02:00
committed by GitHub
parent ecb3572858
commit 0e988247fa
+34
View File
@@ -1,2 +1,36 @@
# fxserver-esx_addoninventory
ESX AddonInventory
[INSTALLATION]
1) CD in your resources folder
2) Clone the repository
```
git clone https://github.com/FXServer-ESX/fxserver-esx_addoninventory esx_addoninventory
```
3) Add this in your server.cfg :
```
start esx_addoninventory
```
[USAGE]
There is two types of inventories : shared and not shared.
- Shared inventories dont belong to a specific user. Example : foodstore items.
- Not shared inventories are created for every user in the server. They are created in db when player is loaded, Example : property items money
You must create the inventory in the database (addon_inventory) before using it :
name = name of the inventory, label = label of the inventory, shared (0 or 1) = Is inventory shared
```
TriggerEvent('esx_addoninventory:getSharedInventory', 'main_grocery', function(inventory)
inventory.addItem('bread', 1)
end)
TriggerEvent('esx_addoninventory:getInventory', 'property', 'steam:0123456789', function(inventory)
inventory.removeItem('water', 1)
end)
```