> For the complete documentation index, see [llms.txt](https://mic-scripts.gitbook.io/mic/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mic-scripts.gitbook.io/mic/documentation/vape-system.md).

# Vape System

{% hint style="info" %}
💬 **Need help?** Support, updates and changelogs are on the [**Mic Scripts Discord**](https://discord.gg/86FPzAV73B). Open a ticket with your Tebex transaction ID and the console error.
{% endhint %}

<a href="https://discord.gg/86FPzAV73B" class="button primary">💬 Join the Discord</a> <a href="https://mic.tebex.io/" class="button secondary">🛒 Get it on Tebex</a>

{% embed url="<https://www.youtube.com/watch?v=FzbKLNUuAIk>" %}

## What it is

**mic\_vape** makes vapes usable items. Using one puts a coloured vape in the player's hand; a key press takes a puff, with an animation and a cloud of smoke in that vape's colour that everybody nearby sees.

Forty-one of them — a normal vape and forty flavours — are just for show. Nine more carry a power — invisibility, speed, super jump, teleport, invincibility, health, armour, a faster car, or a random one of those — and every vape runs out after a set number of puffs.

***

### Key features

* **Fifty vapes ready to use** 💨\
  A normal vape, forty flavours from watermelon to paella, and nine power vapes, each with its own label, prop colour and smoke colour.
* **Ten vape models** 🎨\
  Black, blue, green, light blue, orange, pink, purple, red, white and yellow, streamed with the resource.
* **Coloured, synced smoke** 🌫️\
  Every puff sends its cloud to players within 30 metres. A vape can also have rainbow smoke that cycles through six colours.
* **Power vapes** ⚡\
  Invisibility, sprint boost with optional infinite stamina, super jump, teleport to waypoint, invincibility, health, armour and engine power, each with its own duration.
* **Build your own mix** 🧪\
  A `power` list on a vape combines several effects at once, each with its own time or amount.
* **Vapes run out** 🔋\
  Each vape has a puff count. On the last puff it is put away and one is removed from the inventory.
* **Cooldowns and a progress bar** ⏱️\
  A per-vape cooldown between puffs, and an optional on-screen bar shaped like a vape that counts the effect down.
* **No fighting mid-puff** ✋\
  Attack and aim are blocked while the smoke comes out, if you want them to be.
* **Rebindable puff key** ⌨️\
  **E** by default, listed as "Vape Puff" in each player's FiveM key bindings.
* **Open where it matters** 🔓\
  `config.lua`, the locales and the whole `bridge/` folder — framework, notifications, effects, inventory checks and stress — are left open.

***

### What you need

| You need                                | Why                                                                                                                                                                                                  |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ESX**, **QBCore** or **QBox**         | Detected on its own when `es_extended` or `qb-core` is started — QBox through its QBCore compatibility, as `qbx_core` provides `qb-core`. Registers the vapes as usable items and removes empty ones |
| An inventory that supports usable items | Ready-made item definitions ship for ESX, QBCore and ox\_inventory                                                                                                                                   |

No database tables of its own, no target resource. The vape models are inside the resource.

***

### Where to go next

| Page                                                                    | What is in it                                                               |
| ----------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| [🪛 Installation](/mic/documentation/vape-system/installation.md)       | Folder, start order, items, images and the first puff                       |
| [🎒 Items](/mic/documentation/vape-system/items.md)                     | Every vape: item name, what it does, prop, puffs and cooldown               |
| [🎨 Customization](/mic/documentation/vape-system/customization.md)     | Which file decides what, every option, adding a vape, languages, the bridge |
| [🩺 Troubleshooting](/mic/documentation/vape-system/troubleshooting.md) | The problems buyers actually hit, and the fix for each                      |
