From 018dcca6cc7ddfc13616104ffdebc44975bd0c82 Mon Sep 17 00:00:00 2001
From: Jim Shield <gothicjim@gmail.com>
Date: Thu, 24 Jul 2025 22:51:21 +0100
Subject: [PATCH] Update README.md

---
 README.md              | 11 ++++++++++-
 shared/consumables.lua | 18 ++++++++++++++++--
 2 files changed, 26 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index a937536..7193ae1 100644
--- a/README.md
+++ b/README.md
@@ -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`
diff --git a/shared/consumables.lua b/shared/consumables.lua
index 0ab779e..ab361c7 100644
--- a/shared/consumables.lua
+++ b/shared/consumables.lua
@@ -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
+--        }
+--    },
 }
\ No newline at end of file