Consumables: Installation

Download the resourceCopy Anchor Link

The script is free and open source (MIT). Get it from GitHub, see Free scripts.

Keep the folder nameCopy Anchor Link

The folder must be named hype-consumables. The ox_inventory item definitions call hype-consumables.useFood, and the interface and exports resolve through this name.

The interface ships prebuilt in web/build. You only need Node.js if you want to change it (see the FAQ).

Add the itemsCopy Anchor Link

Apply only one of these, depending on your inventory. The item names must match the keys in config/foods.lua. The 13 included items are burger, sandwich, hotdog, taco, fries, donut, chips, egobar, water, sprunk, ecola, coffee and grapejuice.

['burger'] = {
    label = 'Burger',
    weight = 20,
    stack = true,
    close = true,
    consume = 0,
    description = 'Freshly made burger. Eaten bite by bite.',
    client = {
        export = 'hype-consumables.useFood',
    },
    buttons = {
        { label = 'Give to someone', action = function(slot) exports['hype-consumables']:giveFood(slot) end },
        { label = 'Put on the ground', action = function(slot) exports['hype-consumables']:dropFood(slot) end },
    },
},

Both files also contain an optional spoiled_food item. Add it only if you set Spoilage.spoiledItem to 'spoiled_food' (see Spoilage).

DatabaseCopy Anchor Link

Nothing to do in most cases. On the first start the script creates its only table, hype_consumables_drops, which keeps the food left on the ground across restarts. If your database user has no CREATE permission, run INSTALL/install.sql by hand once:

CREATE TABLE IF NOT EXISTS `hype_consumables_drops` (
    `id` VARCHAR(32) NOT NULL,
    `item` VARCHAR(64) NOT NULL,
    `metadata` LONGTEXT NOT NULL,
    `x` FLOAT NOT NULL,
    `y` FLOAT NOT NULL,
    `z` FLOAT NOT NULL,
    `heading` FLOAT NOT NULL DEFAULT 0,
    `owner` VARCHAR(64) NULL DEFAULT NULL,
    `created_at` INT NOT NULL,
    PRIMARY KEY (`id`)
);

Hunger, thirst, remaining amounts and expiry dates live in the item metadata and your framework, not in this table.

Start the resourceCopy Anchor Link

Add it to server.cfg after its dependencies, and set the language.

ensure ox_lib
ensure oxmysql
ensure qbx_core          # or qb-core / es_extended (optional)
ensure ox_inventory      # or qb-inventory / ps-inventory / jpr-inventory
ensure ox_target         # or qb-target

# HypeScripts
ensure hype-consumables

setr ox:locale "en"      # "en" and "tr" are included

Set the basicsCopy Anchor Link

The defaults work out of the box. Open config/config.lua to check the keys, spoil times and drop limits, and config/foods.lua to tune the foods. See Configuration for every option.

Set Debug = true in the config and start the server. Look for these lines in the console:

[DEBUG:SERVER] [INFO] Framework detected: qbx_core
[DEBUG:SERVER] [INFO] Inventory detected: ox_inventory
[hype-consumables] Loaded 0 food drops
[DEBUG:SERVER] [INFO] 13 foods loaded (framework: qbx_core)

If an item is missing from your inventory, the console lists it: These foods are not registered in ox_inventory (see INSTALL): ...

Give yourself a burger and use it. The first bite is taken right away and a small panel opens in the bottom right corner. Press E for more bites and watch the remaining grams go down in the panel and in the inventory.

Press X to put the rest away, then use the burger again: it continues where you left off. Press Q to put it on the ground, then use Inspect and Pick up on it with your target.

With a second player next to you, press H while eating, then Y to send the offer. The other player accepts with Y. When everything works, set Debug = false again.