77 lines
3.5 KiB
Markdown
77 lines
3.5 KiB
Markdown
# MR Consumables
|
|
|
|
Hello, This is a read me file designed to help you understand everything you need to know about the script
|
|
|
|
## Installation
|
|
|
|
Put the script somewhere in your resource folder
|
|
Go to the config in config/sh_config.lua and to config/cl_config.lua and config the script according to your server (Make sure the inventory and core names you wrote in the config are matching the inventory and core your have)
|
|
|
|
(IF YOU ARE USING THE SOUNDS)
|
|
Make sure you have xSound installed, if not. Go to this link and install it https://github.com/Xogy/xsound/releases/tag/1.4.3 (You can also use your own if you have coding knowlage but xSound is the most recommended right now)
|
|
Put the sounds in the sounds folder in xsound/html/sounds for them to work
|
|
|
|
(IF YOU WANT TO USE OUR DEFAULT ITEMS)
|
|
Make sure to put images in your inventories image folder
|
|
|
|
Add the items to your inventory/core
|
|
|
|
#### ox_inventory
|
|
|
|
["ecola"] = {
|
|
label = "eCola",
|
|
weight = 500,
|
|
stack = false,
|
|
close = true,
|
|
description = "For all the thirsty out there",
|
|
},
|
|
["sprunk"] = {
|
|
label = "Sprunk",
|
|
weight = 500,
|
|
stack = false,
|
|
close = true,
|
|
description = "For all the thirsty out there",
|
|
},
|
|
["burger"] = {
|
|
label = "Burger",
|
|
weight = 500,
|
|
stack = false,
|
|
close = true,
|
|
description = "For all the hungry out there",
|
|
},
|
|
["sandwich"] = {
|
|
label = "Sandwich",
|
|
weight = 500,
|
|
stack = false,
|
|
close = true,
|
|
description = "For all the hungry out there",
|
|
},
|
|
|
|
#### qb-inventory
|
|
|
|
['ecola'] = { name = 'ecola', label = 'eCola', weight = 500, type = 'item', image = 'ecola.png', unique = true, useable = true, shouldClose = true, combinable = nil, description = 'For all the thirsty out there' },
|
|
|
|
['sprunk'] = { name = 'sprunk', label = 'Sprunk', weight = 500, type = 'item', image = 'sprunk.png', unique = true, useable = true, shouldClose = true, combinable = nil, description = 'For all the thirsty out there' },
|
|
|
|
['sandwich'] = { name = 'sandwich', label = 'Sandwich', weight = 500, type = 'item', image = 'sandwich.png', unique = true, useable = true, shouldClose = true, combinable = nil, description = 'For all the hungry out there' },
|
|
|
|
['burger'] = { name = 'burger', label = 'Burger', weight = 500, type = 'item', image = 'burger.png', unique = true, useable = true, shouldClose = true, combinable = nil, description = 'For all the hungry out there' },
|
|
|
|
## IMPORTANT
|
|
|
|
If you want to add your own items, duplicate one of our default items in the config and change what you want according to your needs
|
|
|
|
## Make sure your item cannot be stacked (turn off stacked in ox_inventory or unique in qb-inventory) because the item is using metadata to count the amount of consumes remaining
|
|
|
|
And if you want to attach items to the animations specified in our config, Turn on debug in the config (Config.Debug = true) and use the command "consumes:debug" to trigger the animations, stop them and etc
|
|
|
|
The system does not have prop attachment tools (yet) but there are ones i recommened
|
|
|
|
Attach Prop to Player Editor By "PERPGamer" https://forum.cfx.re/t/dev-tool-attach-prop-to-player-editor/4864072
|
|
TGIANN Attach Prop to Player By "TGIANN" https://forum.cfx.re/t/dev-tool-tgiann-attach-prop-to-player/5107789
|
|
|
|
And of course make sure to enable it in your server cfg
|
|
|
|
"ensure mr-consumables"
|
|
|
|
## IF YOU NEED ANY EXTRA HELP FEEL FREE TO OPEN A TICKET IN OUR DISCORD
|