FumeNodes/jim-consumables
1
0
Fork 0
mirror of https://github.com/jimathy/jim-consumables.git synced 2026-08-16 22:16:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jim Shield
2025-07-24 22:51:21 +01:00
parent e27b840a5e
commit 018dcca6cc
2 changed files with 26 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -1,5 +1,14 @@
# Jim-Consumables
Consumables script for QBCore
MultiFrameork Consumables script
## [JixelPatterns GitBook Documentation](https://jixelpatterns.gitbook.io/docs)
## If you need support I have a discord server available, it helps me keep track of issues and give better support.
## [JixelPatterns Discord](https://discord.gg/9pCDHmjYwd)
## If you think I did a good job here, consider donating as it keeps by lights on and my cat round:
## [JixelPatterns Kofi](https://ko-fi.com/jixelpatterns)
# What is this?
This script WAS designed as a replacement/override for food and drink consumables in `qb-smallresources`

18
shared/consumables.lua
View File

@@ -47,7 +47,7 @@ Config.Consumables = {
-- heal = 0, -- Set amount to heal by after consuming
-- armor = 5, -- Amount of armor to add
-- type = "food", -- Type: "alcohol" / "drink" / "food"
-- canRun = true, -- If true player can run while using the item, not to it will cancel the event
-- canRun = true, -- If true player can run while using the item, if not it will cancel the event
--
-- stats = {
-- screen = "thermal", -- The screen effect to be played when after consuming the item "rampage" "turbo" "focus" "weed" "trevor" "nightvision" "thermal"
@@ -74,7 +74,7 @@ Config.Consumables = {
-- Example Box Item
-- ["9_box"] = { -- Name of the box item in the shared
-- emote = "uncuff", -- The emote than should run when "unboxing"
-- canRun = true, -- If true player can run while using the item, not to it will cancel the event
-- canRun = true, -- If true player can run while using the item, if not it will cancel the event
-- time = 3500, -- How long it takes to use the item
-- type = "pack", -- Designate it as a "pack" to the script knows what to do
-- pack = {
@@ -83,4 +83,18 @@ Config.Consumables = {
-- },
-- },
-- Example Cigar Item wiht requirements
-- ["cigar"] = { -- Name of the item in your shared items
-- emote = "smokecigar", -- The emote than should run when "smoking"
-- canRun = true, -- If true player can run while using the item, if not it will cancel the event
-- time = math.random(5000, 6000), -- How long it takes to use the item
-- type = "smoke", -- Designate it as a "smoke" to the script knows what to do
-- requiredItem = "lighter", -- Set a required item making it unsable if they don't have it
-- stats = {
-- effect = "stress",
-- time = 5000,
-- amount = math.random(10, 15),
-- canOD = false
-- }
-- },
}