> 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_inventory/items-and-images.md).

# Items and images

The item format, the default items and how images are found.

Items live in `data/items.lua`, weapons, ammo and attachments in `data/weapons.lua`. The common FiveM item format is used, so item lists from most scripts can be pasted straight in.

## Item format

```lua
['water'] = {
    label = 'Water',
    weight = 500,
    stack = true,
    close = true,
    description = 'Ice cold.',
    client = {
        status = { thirst = 200000 },
        anim = { dict = 'mp_player_intdrink', clip = 'loop_bottle' },
        prop = { model = `prop_ld_flow_bottle`, pos = vec3(0.03, 0.03, 0.02), rot = vec3(0.0, 0.0, -1.5) },
        usetime = 2500,
    },
},
```

| Field                                          |                                                                                                     |
| ---------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `label`, `weight`, `description`               | Name, weight in grams, tooltip text                                                                 |
| `stack`, `close`                               | Stacks in one slot; closes the inventory when used                                                  |
| `rarity`                                       | `common`, `uncommon`, `rare`, `epic`, `legendary`, `mythic` (slot colour)                           |
| `category`                                     | Tab the item shows under                                                                            |
| `degrade`                                      | Minutes until the item spoils                                                                       |
| `client.status`                                | Hunger, thirst or stress change when used                                                           |
| `client.anim`, `client.prop`, `client.usetime` | Use animation, prop in hand, time in ms. `anim = 'eating'` uses a preset from `data/animations.lua` |
| `client.export`, `client.event`                | Run your own code when used                                                                         |
| `server.export`                                | Server side use handler                                                                             |
| `client.image`                                 | Image file name or link, when it differs from the item name                                         |

## Default items

* **Basics**: bandage, burger, sprunk, water, mustard, parachute, garbage, paper bag, panties, lockpick, phone, radio, identification, mastercard, scrap metal, money, black money.
* **Food and medical**: coffee, sandwich, painkillers, first aid.
* **Valuables**: gold bar, gold chain, rolex, diamond ring.
* **Documents**: ID card, driver license.
* **Gear**: armour, heavy armour, armour plate, advanced lockpick, clothing.
* **Weapons**: every GTA weapon, ammo type and attachment in `data/weapons.lua`.

## Images

Images are in `web/images` and found by item name: `water.png` or `water.webp`. Images for every default item, weapon, ammo and attachment are included.

{% hint style="info" %}
Add an image for a new item by dropping `<item name>.png` into `web/images`. Square PNGs around 100 to 200 px look best. You can also set `client.image` to another file name or an `https://` link.
{% endhint %}

The [creator](/kazescripts/kaze_inventory/creator-and-designer.md) can also download an image from a link for you.