Installation
Fifteen minutes. Two folders, a few settings, and the items. Nothing is stored in the database, so there is nothing to import for the resource itself.
Before you start
Section titled “Before you start”| You need | Why |
|---|---|
| ESX, QBCore or QBox, running | Items, owners and jobs go through it |
| ox_target or qb-target, running | Every interaction with a placed hookah or chair |
Both folders from your purchase: mic_hookah and mic_hookah_prop | The script, and the hookah models |
| Access to your inventory’s item list and image folder | Hookahs, furniture, supplies and flavours are items |
1. Put both folders in place
Section titled “1. Put both folders in place”Drop mic_hookah and mic_hookah_prop into your resources, for example inside resources/[mic]/.
mic_hookah_prop holds the ten hookah models (mic_hookah_black … mic_hookah_yellow) and their mic_hookah.ytyp. It has no code; it only streams. The tables and chairs are base-game models and need nothing extra.
2. Start order
Section titled “2. Start order”In server.cfg, below your framework, your inventory and your target resource, add ensure mic_hookah_prop and then ensure mic_hookah.
It worked when both start with no red lines under them.
3. Framework and target
Section titled “3. Framework and target”Open config.lua:
| Option | Set it to | Default |
|---|---|---|
Config.Framework | esx, qbcore or qbox | esx |
Config.Target | ox_target or qb-target | ox_target |
Config.ESXResourceName | The folder name of ESX, if you renamed it | es_extended |
Config.QBResourceName | The folder name of QBCore, if you renamed it | qb-core |
Config.QBoxResourceName | The folder name of QBox, if you renamed it | qbx_core |
Config.QBTargetResourceName | The folder name of qb-target, if you renamed it | qb-target |
Nothing is detected on its own here: these values decide which framework and which target are used.
4. The database
Section titled “4. The database”Nothing for the resource: placed hookahs and furniture live in the server’s memory, not in a table. On ESX with the default inventory, the items go in the items table — next step.
5. Add the items
Section titled “5. Add the items”The full list is on 🎒 Items. In short:
| Item | What it does |
|---|---|
hookah_black, hookah_blue, hookah_green, hookah_grey, hookah_orange, hookah_pink, hookah_purple, hookah_red, hookah_skyblue, hookah_yellow | Use it to carry and place that hookah |
hookah_table … hookah_table5 | Use it to place a table |
hookah_chair … hookah_chair6 | Use it to place a chair you can sit on |
hookah_coal | Fills the charcoal from the setup menu |
hookah_water | Fills the water from the setup menu |
hookah_<flavour>_flavor | Sixty flavours, chosen from the setup menu |
Where the ready-made definitions are, in inventory_items/ inside mic_hookah:
| File | For | What to do |
|---|---|---|
esx_items.sql | ESX with its default inventory | Import it once into your database |
ox_items.md | ox_inventory | Paste its lines into ox_inventory/data/items.lua |
qb_items.md | QBCore / QBox with qb-inventory | Paste its lines into qb-core/shared/items.lua |
Images: the icons are in inventory_images/, one PNG per item named after it. Copy them into your inventory’s image folder — ox_inventory/web/images/ or qb-inventory/html/images/.
Then point Config.InventoryImagePath at that same folder, so the flavour icons show in the setup menu. It ships as nui://ox_inventory/web/images/; for qb-inventory use nui://qb-inventory/html/images/.
It worked when you can give yourself hookah_red and it shows in your inventory with its picture.
6. First test
Section titled “6. First test”Give yourself hookah_red, hookah_coal, hookah_water and hookah_mint_flavor.
- Use
hookah_red. Your character holds it on a tray. Press E. - A preview follows your aim. Turn it with the mouse wheel, raise or lower it with the arrow keys, and press E to set it down.
- Target the hookah and choose Open Setup Menu. Add charcoal, add water, pick Mint, then Light Hookah.
- Close the menu, target the hookah again and choose Grab Hose. Press E.
It worked when a hose runs from the hookah to your character, and on E you take a puff and pale green smoke comes out. The charcoal and water in the menu drop a little with each puff.
Before you open your city
Section titled “Before you open your city”- Decide who may manage hookahs.
Config.AdminGroupsships asfalse, which lets every player open the menu of, and pick up, any hookah or piece of furniture. Set it to your admin groups to limit that to the owner and staff. See Customization. Config.InventoryImagePathpoints at the image folder you actually use.- Stress:
Config.Stressis on, butReduceStressinserver_functions.luais empty until you put your call in it. - Tell your players that hookahs and furniture are not saved: they are cleared when the resource or the server restarts.