circle-nodesConversions

All information you would need regarding the conversion tools.

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 Discordarrow-up-right and we'll look into adding it.


Table of Contents


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.

1

Restart zyke_consumables

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

2

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.

3

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.

4

Restart the server

Restart the server so both ox_inventory and zyke_consumables pick up the changes.


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.

1

Make sure qb-smallresources is running

The resource needs to be started so the tool can read its config.

2

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.


pixel-consumables

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

1

Make sure pixel-consumables is available

The resource needs to be available so the tool can read its config.

2

Run the command

Run pixel_convert in the server console. Converted items are created as inactive.

3

Review your items

Open the Creator Menu to review and activate them.


Activating Items

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

1

Option A: Force activate all

Run consum:force_activate in the server console. This is the fastest way to get everything running.

2

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.


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.

Last updated