# Conversions

## Conversions

To speed up migrating to our resource, we have built conversion tools for popular consumable setups. These tools read your existing item configurations and automatically create equivalent items in zyke\_consumables.

If you use a consumable resource that we don't support yet, let us know in our [Discord](https://discord.gg/zykeresources) and we'll look into adding it.

***

### Table of Contents

* [Supported Resources](#supported-resources)
* [ox\_inventory](#ox_inventory)
* [qb-smallresources](#qb-smallresources)
* [pixel-consumables](#pixel-consumables)
* [Activating Items](#activating-items)
* [FAQ](#faq)

***

### Supported Resources

| Resource          | Command         | Auto-detect on Startup                   |
| ----------------- | --------------- | ---------------------------------------- |
| ox\_inventory     | `ox_convert`    | Yes (if `fetchOxConversions` is enabled) |
| qb-smallresources | `qb_convert`    | No                                       |
| pixel-consumables | `pixel_convert` | No                                       |

All conversion commands are **server console only** (not available in the F8 client console). Remember that you don't prefix the slash for commands in the server console.

Items that are already configured in zyke\_consumables are automatically skipped during conversion.

***

### ox\_inventory

The tool detects items in `ox_inventory/data/items.lua` that have a `client.status` field. It converts status effects (hunger, thirst, stress) into consumption rewards, along with animations and props.

Make sure `fetchOxConversions` is enabled in your config before starting.

{% stepper %}
{% step %}

#### Restart zyke\_consumables

When the script starts, it will display the number of available conversions in the server console.
{% endstep %}

{% step %}

#### Run the command

Run `ox_convert` in the server console. This creates all detected consumable items in zyke\_consumables and generates a cleaned `items.lua` file in the root of the zyke\_consumables folder.
{% endstep %}

{% step %}

#### Replace your items file

The generated `items.lua` contains your items with all the old consumable data stripped out (animations, props, status effects, etc.), leaving only the inventory-relevant fields.

Copy this file into `ox_inventory/data/items.lua`.

Make a backup of your original `items.lua` before replacing it.
{% endstep %}

{% step %}

#### Restart the server

Restart the server so both ox\_inventory and zyke\_consumables pick up the changes.
{% endstep %}

{% step %}

#### Activate items

[See Activating Items below.](#activating-items)
{% endstep %}
{% endstepper %}

***

### qb-smallresources

The tool reads the `Config.Consumables` table from qb-smallresources and processes all categories: food, drink, alcohol, and custom items. Default animations and props are assigned based on item type.

Since qb-smallresources items don't typically have detailed prop/animation data, we recommend customizing these after conversion. The tool allows a blanket-conversion that speeds up getting all of the items over.

{% stepper %}
{% step %}

#### Make sure qb-smallresources is running

The resource needs to be started so the tool can read its config.
{% endstep %}

{% step %}

#### Run the command

Run `qb_convert` in the server console. All converted items are created as **inactive drafts**.

The following categories are processed:

| Category  | Item Type | Default Rewards         |
| --------- | --------- | ----------------------- |
| `eat`     | Food      | Food                    |
| `drink`   | Drink     | Drink                   |
| `alcohol` | Drink     | Drink + Alcohol         |
| `custom`  | Varies    | Based on replenish type |

Open the Creator Menu to review and customize each item before activating.
{% endstep %}

{% step %}

#### Activate items

[See Activating Items below.](#activating-items)
{% endstep %}
{% endstepper %}

***

### pixel-consumables

The tool reads `Config.ConsumablesCustom` from pixel-consumables and converts replenish types (Hunger, Thirst, Stress, Alcohol), animations, and prop data.

{% stepper %}
{% step %}

#### Make sure pixel-consumables is available

The resource needs to be available so the tool can read its config.
{% endstep %}

{% step %}

#### Run the command

Run `pixel_convert` in the server console. Converted items are created as **inactive**.
{% endstep %}

{% step %}

#### Review your items

Open the Creator Menu to review and activate them.
{% endstep %}

{% step %}

#### Activate items

[See Activating Items below.](#activating-items)
{% endstep %}
{% endstepper %}

***

### Activating Items

After conversion, items need to be activated before players can use them.

{% stepper %}
{% step %}

#### Option A: Force activate all

Run `consum:force_activate` in the server console. This is the fastest way to get everything running.
{% endstep %}

{% step %}

#### Option B: Manually activate each item

Open the Creator Menu and activate items individually. This is slower but lets you verify each item first. We recommend this approach since automatic conversions may not always be perfect.
{% endstep %}
{% endstepper %}

***

### FAQ

**Q: Will running a conversion twice create duplicate items?** No. The tool skips any items that are already configured in zyke\_consumables.

**Q: Do I need to remove the old consumable resource after converting?** For ox\_inventory, you replace the items file so the old consumable behavior is removed. For qb-smallresources and pixel-consumables, you should stop those resources after conversion so they don't conflict.

**Q: Can I customize items after conversion?** Yes. All converted items can be fully edited in the Creator Menu. We recommend reviewing converted items since default animations and props may not match your specific items.

**Q: What if the conversion gets something wrong?** You can delete the item in the Creator Menu and recreate it manually, or simply edit the converted item to fix it. The conversion is a starting point, not a final result.
