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

# kaze\_lib

The shared library every KazeScripts resource needs. Framework, inventory, target, keys, fuel and database support in one place.

kaze\_lib is the shared library behind every KazeScripts resource. It connects them to your framework, inventory, target, vehicle keys, fuel, dispatch and database, and gives you notifications, text UI and minigames to use in your own scripts.

It is free and included with every KazeScripts purchase. **Every KazeScripts resource that uses kaze\_lib supports everything listed below.**

## Supported resources

Everything is detected automatically. Set a value in `kaze_lib/config.lua` only if it picks the wrong one.

| Category     | Supported                                                                                                                                                              | Config key   |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| Framework    | `qbx_core`, `qb-core`, `es_extended`                                                                                                                                   | `Framework`  |
| Inventory    | `ox_inventory`, `qs-inventory`, `codem-inventory`, `tgiann-inventory`, `core_inventory`, `origen_inventory`, `ak47_inventory`, `qb-inventory`, framework default (ESX) | `Inventory`  |
| Target       | `ox_target`, `qb-target`                                                                                                                                               | `Target`     |
| Vehicle keys | `qbx_vehiclekeys`, `qb-vehiclekeys`, `wasabi_carlock`, `qs-vehiclekeys`, `cd_garage`, `Renewed-Vehiclekeys`                                                            | `Keys`       |
| Fuel         | `ox_fuel`, `cdn-fuel`, `lc_fuel`, `ps-fuel`, `Renewed-Fuel`, `qs-fuelstations`, `LegacyFuel`, native fallback                                                          | `Fuel`       |
| Dispatch     | `ps-dispatch`, `cd_dispatch`, `qs-dispatch`, `rcore_dispatch`, `core_dispatch`                                                                                         | `Dispatch`   |
| Database     | `oxmysql`, `mysql-async`, `ghmattimysql`                                                                                                                               | `Database`   |
| Appearance   | `kaze_appearance`, `illenium-appearance`, `fivem-appearance`, `qb-clothing`, `skinchanger`                                                                             | `Appearance` |

{% hint style="info" %}
Using something that is not on the list? Open a ticket on our Discord and tell us the resource and version.
{% endhint %}

## Installation

{% stepper %}
{% step %}

### Add the resource

Put the `kaze_lib` folder in your `resources` directory.
{% endstep %}

{% step %}

### Start it first

kaze\_lib must start **after** your database resource and **before** every KazeScripts resource:

```cfg
ensure oxmysql
ensure kaze_lib

# KazeScripts resources after it
ensure kaze_ChopShop
ensure kaze_rental
```

{% endstep %}

{% step %}

### Check the config

Everything is detected automatically. Open `kaze_lib/config.lua` only if it picks the wrong resource.
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
After changing kaze\_lib, restart **kaze\_lib first**, then the scripts that use it.
{% endhint %}

## Exports

| Page      | What                                        |
| --------- | ------------------------------------------- |
| Notify    | Notifications from the client or the server |
| Text UI   | Key prompts: a single key, a list or a bar  |
| Minigames | 7 minigames with easy, medium and hard      |