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.

Ease of use is a priority for us. If you use a consumable resource that we don't support yet, or if there's a format you'd like the Quick Import to recognize, just ask in our Discord. We are always happy to add more tools and will look into it.

#Table of Contents

• Quick Import
• Generate Blank Items
• Supported Resources
• ox_inventory
• Qbox (qbx_consumables)
• qb-smallresources
• pixel-consumables
• Activating Items
• FAQ

#Quick Import

The consum:import command is the fastest way to bring consumable items into zyke_consumables. Instead of requiring the original resource to be running on your server, you simply paste your item definitions into an in-game form and the system handles the rest.

It currently recognizes:

• ox_inventory item definitions (items with client.status fields).
• Qbox consumables config (qbx_smallresources/qbx_consumables/config.lua). See Qbox (qbx_consumables).

The format is detected automatically, so you don't have to pick one. If you need support for a different format, let us know in our Discord and we can add more preset recognition.

Unlike the other conversion commands, consum:import is an in-game command (not server console).

#Importing from a creator's item pack

Many creators (like DJ's Collections) provide their items in two versions: non-consumable (for your inventory) and consumable (for our import). If the creator provides both, use the fastest method below. If they only provide the consumable version, use Copy Blank Items to copy the clean versions automatically.

#Fastest method (recommended)

Use Copy Blank Items — you only need the consumable item definitions. The system strips out all consumable data and copies clean item definitions ready for your inventory.

#Copy the blank items

Go in-game and type /consum:import. Paste the consumable item definitions into the form and click Copy Blank Items.

#Add clean items to your inventory

The clean item definitions are copied to your clipboard with all consumable data stripped out. Paste them into your ox_inventory/data/items.lua.

Restart your server so ox_inventory picks up the new items.

#Import the consumable definitions

Run /consum:import again. Paste the same consumable item definitions and click Import.

#Review the items

Imported items are active right away. Open the Creator Menu (/consum:ic) to review them and adjust anything that didn't convert perfectly.

#Manual method (if the creator provides both versions)

#Add clean items to your inventory

Copy the non-consumable item definitions from the creator's docs and paste them into your ox_inventory/data/items.lua.

Restart your server so ox_inventory picks up the new items.

#Import the consumable definitions

Go in-game and type /consum:import. Paste the consumable item definitions into the form and click Import.

#Review the items

Imported items are active right away. Open the Creator Menu (/consum:ic) to review them and adjust anything that didn't convert perfectly.

#Importing from your existing server

If you are migrating items that are already consumable on your server (they have client.status in your ox_inventory/data/items.lua):

#Run the import

Go in-game and type /consum:import. Paste the consumable item definitions into the form and click Import.

#Update your inventory items

The import generates a clean file in the import_batches folder inside zyke_consumables (e.g. batch_2026-04-10_18-00-00.lua). This file contains your items with all consumable data stripped out. Copy the contents into your ox_inventory/data/items.lua, replacing the old consumable versions.

Each batch file ends with a trailing comma, so you can safely paste multiple batches into your items file without worrying about Lua syntax errors.

#Restart the server

Restart so ox_inventory loads the clean items and no longer registers them as consumable. This is required so zyke_consumables can register them as usable instead.

#Review the items

Imported items are active right away. Open the Creator Menu (/consum:ic) to review them and adjust anything that didn't convert perfectly.

#Supported Resources

All server console 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.

#Which method should I use?

• Quick Import (consum:import): Best for adding items from creator packs, or importing specific items by pasting their definitions. Works in-game and doesn't require the original resource to be running.
  • Import button: Imports the items into zyke_consumables and generates a clean batch file.
  • Generate Blank Items button: Only generates the clean batch file without importing — useful when you just need the stripped items for your inventory.
• ox_inventory (ox_convert): Best for migrating an entire server in one go. Requires ox_inventory to be running and reads directly from its files. Also generates a cleaned items.lua to replace the original.
• Qbox (qbx_convert): Best for migrating every consumable from a Qbox server in one go. Reads qbx_smallresources/qbx_consumables/config.lua directly. You can also paste the same config into Quick Import.
• qb-smallresources / pixel-consumables: Use these if you are migrating from those specific resources. They read from the running resource's config.

#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.

This is a server-side migration tool. It requires ox_inventory to be running on your server so it can read its item files directly. If you just want to import items from a creator pack, use Quick Import instead.

Make sure fetchOxConversions is enabled in your config before starting.

#Restart zyke_consumables

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

#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.

#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.

#Restart the server

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

#Review your items

Converted items are active right away. Open the Creator Menu (/consum:ic) to review them.

#Qbox (qbx_consumables)

The tool reads the consumables table from Qbox's qbx_smallresources/qbx_consumables/config.lua and converts the food, drink and alcohol categories. Each item keeps its own animation and prop from the Qbox config. If an item has none, Qbox's default progress bar animation and prop are used instead.

There are two ways to run it:

• Server console: Run qbx_convert. It reads the config file straight from qbx_smallresources, so the resource needs to be on your server.
• In-game: Run /consum:import and paste the config into the form. You can paste the full file, the consumables = { ... } block, or only the categories you want (e.g. just food = { ... }).

#Run the conversion

Run qbx_convert in the server console, or paste the config into /consum:import. Converted items are created as active items, ready to use. The console prints how many items were created and skipped.

#Remove the converted items from Qbox

Remove the converted items from qbx_smallresources/qbx_consumables/config.lua. If you skip this, Qbox still registers them as usable and both resources will try to handle the same item.

Your items already exist in ox_inventory/data/items.lua on a Qbox server, so you don't need to change your inventory items.

#Restart the server

Restart so Qbox stops registering the converted items.

#Review your items

Open the Creator Menu (/consum:ic) and look over the converted items. Adjust animations, props and amounts where needed.

How Qbox values are converted:

Every converted item also gets a 48 hour decay and a quality threshold of 80 on its rewards. You can change these in the Creator Menu.

The import also saves a clean batch file in the import_batches folder, like every other Quick Import. On a Qbox server you can ignore it, since your inventory items are already set up.

#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.

#Make sure qb-smallresources is running

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

#Run the command

Run qb_convert in the server console. Converted items are created as active items.

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.

#pixel-consumables

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

#Make sure pixel-consumables is available

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

#Run the command

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

#Review your items

Open the Creator Menu to review and customize them.

#Activating Items

Converted and imported items are active by default, so players can use them right away. You only need these options if you deactivated items yourself, or if some items are still inactive.

#Option A: Batch activate (Quick Import)

If you used consum:import, run /consum:activate_batch in-game (or consum:activate_batch in the server console). This activates the most recent batch of imported items.

#Option B: Force activate all

Run consum:force_activate in the server console. This activates all inactive items across every conversion method.

#Option C: Manually activate each item

Open the Creator Menu (/consum:ic) 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 Qbox, remove the converted items from qbx_consumables/config.lua so Qbox stops registering them as usable. 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.

Q: What's the difference between consum:import and ox_convert? consum:import is an in-game command where you paste item definitions into a form. It doesn't require ox_inventory to be running on your server, making it ideal for adding items from creator packs. It has two buttons: Import (imports items and generates a clean batch file) and Generate Blank Items (only generates the clean batch file without importing). ox_convert is a server console command that reads directly from the ox_inventory resource files. It's designed for full server migrations and also generates a cleaned items.lua to replace the original with.

Q: What does "Generate Blank Items" do? It parses your consumable item definitions and produces a clean file with all consumable data stripped (animations, props, status effects, etc.), leaving only inventory-relevant fields. This is the fastest way to get the non-consumable versions of items into your items.lua — you don't need a separate non-consumable pack from the creator.

Q: What are the files in the import_batches folder? Each time you use consum:import, a timestamped file is generated in the import_batches folder inside zyke_consumables containing the clean (non-consumable) versions of your imported items. Copy these into your ox_inventory/data/items.lua so that ox_inventory doesn't try to handle the consumable behavior itself. Each batch is timestamped and nothing is ever overwritten, even across server restarts.

Q: Can I combine multiple batch files? Yes. Each batch file ends with a trailing comma, so you can safely paste the contents of multiple batch files into your items.lua one after another without Lua syntax errors.