FX-HOOKAH

#📦 INSTALLATION

bashensure gs_gizmo
ensure fx-hookahprops
ensure fx-hookah

• Place resources into your resources folder
• Add to server.cfg
• Restart your server

---

#⚙️ OPTIONAL DEPENDANCY (Sound)

bashensure xsound

• Required only if sound is enabled
• Works when Config.HookahSound = true

---

#⚙️ REQUIRED DEPENDANCY

textgs_gizmo

• Required for detailed placement system
• Enables precise object positioning

---

#📦 INVENTORY SETUP (RSG)

luahookah_silver = { name = 'hookah_silver' }
tobacco_love66 = { name = 'tobacco_love66' }
hookah_coal = { name = 'hookah_coal' }

• Add items into rsg-core/shared/items.lua
• Includes hookahs, tobacco, and coal

---

#📦 INVENTORY SETUP (VORP)

sqlINSERT INTO items (...)
VALUES ('hookah_silver', 'Silver Hookah', ...)

• Add items into VORP database
• Required for full functionality

---

#🖼️ ITEM IMAGES

textITEMPNG/

• Copy images into inventory image folder
• Required for UI display

---

#⚙️ BASIC SETTINGS

luaConfig.Language = "en"
Config.Debug = false

• Language system
• Debug mode for development

---

#🌐 LOCALE SYSTEM

luaConfig.Locale = {
  ["en"] = {}
}

• Multi-language support
• Supports dynamic variables (${value})

---

#🔊 SOUND SYSTEM

luaConfig.HookahSound = true
Config.HookahSoundDistance = 20.0

• Enables hookah bubbling sound
• Uses xsound resource

---

#🎯 INTERACTION SYSTEM

luaConfig.UseTarget = false

• false → prompt system
• true → target system

---

luaConfig.Prompts = {
  ["carry"] = {},
  ["ground"] = {}
}

• Full interaction system
• Separate prompts for carry / ground

---

#🔥 COAL SYSTEM

luaConfig.CoalDecay = {
  enabled = true,
  decayInterval = 120,
  decayAmount = 1
}

• Coal decreases over time
• Requires refill system

---

#💨 SMOKE SYSTEM

luaConfig.Smoke = {
  key = 0x5415BE48,
  minHoldTime = 300,
  maxHoldTime = 3000
}

• Hold-to-smoke mechanic
• Longer hold = more smoke

---

luatobaccoBaseRate = 0.1

• Controls tobacco consumption speed

---

#🍃 TOBACCO SYSTEM

luaConfig.Tobacco = {
  ["love66"] = {
    duration = 600,
    density = 1.0
  }
}

• Defines tobacco types
• duration → how long it lasts
• density → smoke thickness

---

#🚬 HOOKAH TPYES

luaConfig.Hookahs = {
  ["hookah_gold"] = {
    smokeMultiplier = 1.3
  }
}

• Defines hookah variants
• Each has unique stats

---

#🔗 HOSE SYSTEM

luaConfig.Hose = {
  prop = "fx_shishahand_bk",
  ropeLength = 3.5
}

• Creates rope connection
• Syncs between players

---

#🔧 REPAIR SYSTEM

luaConfig.RepairHookah = {
  allowRepair = true
}

• Allows coal refill / repair
• Can require items

---

#🔒 DELETE SYSTEM

luaConfig.DeleteBoxSettings = {
  allowDelete = true
}

• Controls hookah deletion
• Supports job & group permissions

---

#📦 DATA SYSTEM

jsonhookah.json

• Stores all hookah states
• Includes:
• coal
• tobacco
• position
• usage state

---

#🎭 PROPS

texthookah: fx_shisha_bk
hand: fx_shishahand_bk

• Hookah and hose models

---

#🔄 CORE FEATURES

• Carry / Place hookah
• Hold-to-smoke system
• Coal decay & refill
• Tobacco system
• Rope & hose system
• Sound system
• Multi hookah types
• Synced smoke effects

---

#🔔 NOTIFICATION SYSTEM

luaNotify({
  text = "Message"
})

• Supports VORP / RSG / REDEMRP
• Integrated notify system

---

#⚠️ IPMORTANT NOTES

• Artifact version must match recommendation
• Items must be installed correctly
• xsound required if sound enabled
• gs_gizmo must be installed
• Tobacco required to smoke

---

#🚨 COMMON ISSUES

• Smoke not working → no tobacco
• No sound → xsound missing
• Placement not working → gizmo missing
• Hookah disappears → sync issue
• Cannot smoke → coal empty

---

#🏁 SUMMARY

FX-HOOKAH provides:

• Realistic smoking system
• Coal & tobacco mechanics
• Rope & hose interaction
• Fully synced effects
• Multiple hookah types
• High performance system

---

© Fixitfy Development