How Integrations Work#
Restaurant Creator does not hard-code your framework, inventory or target. Each one is detected at start-up by looking for a started resource, and everything resource-specific lives in small, unencrypted bridge files under client/custom/, server/custom/ and custom/.
Layer | Supported | Without it |
|---|---|---|
Framework |
| Required. |
Inventory |
| Required — ingredients, dishes and fridges need it. The standalone fallback only prints a warning. |
Target |
| 3D text and the E key ( |
Text UI |
| ox_lib's text UI and native 3D text. |
Progress bars · HUD |
| ox_lib's progress circle; only the minimap is hidden while a menu is open. |
3D sound |
| The fryer is silent. |
Detection only sees resources that are already running, so start each of these before qs-restaurant-creator in server.cfg.
Renamed Resources#
Running a framework or inventory under another folder name? Add the name to the matching list in config/main.lua, pointing at the bridge it should use:
local frameworks = {
['es_extended'] = 'esx',
['qb-core'] = 'qb',
['qbx_core'] = 'qb',
['my-core'] = 'qb', -- a renamed qb-core
}
local inventories = {
['qs-inventory'] = 'qs',
['ox_inventory'] = 'ox',
['qb-inventory'] = 'qb',
['tgiann-inventory'] = 'tgiann',
['codem-inventory'] = 'codem',
['origen_inventory'] = 'origen',
}Notifications#
By default messages are shown by the script's own interface. To route them through another system, edit Notification in custom/client.lua — ready-made examples for qs-interface and ox_lib are already there, commented out:
-- custom/client.lua
function Notification(msg, type) -- type: 'info' | 'error' | 'success'
lib.notify({ title = 'Restaurant', description = msg, type = type })
endThe same file holds the text UI, progress bar, HUD and 3D sound functions, so any of them can be swapped for your own resource.
Hunger and Thirst#
Eating fills hunger and drinking fills thirst, out of the box. On ESX it goes through esx_status; on QBCore and Qbox it sets the player's hunger and thirst metadata and refreshes the HUD. The amounts are a percentage (0–100) set in config/consumable.lua: 30% by default for food and for drinks.
-- config/consumable.lua
Config.ConsumableOutputs = {
food = { hunger = 30, thirst = 0, ... }, -- every dish
drink = { hunger = 0, thirst = 30, ... }, -- every drink
items = {
-- any item can override the amounts of its template
['cooked_pizza'] = { inherit = 'food', hunger = 50 },
['cooked_fries'] = { inherit = 'food', hunger = 20 },
['cola_drink'] = { inherit = 'drink', thirst = 40 },
},
}Your own multi-step dishes and custom drinks use the food or drink amounts unless you add them to items. Set both to 0 to turn it off. Using another status system? Edit framework:addNeeds in custom/esx/server.lua or custom/qb/server.lua — it receives the player and the two percentages.
Discord Logs#
Paste a Discord webhook URL per category in server/webhooks.lua. Empty categories are simply not logged.
Category | What goes there |
|---|---|
| Restaurants created, edited and deleted. |
| Deposits and withdrawals. |
| Hires, firings and rank changes. |
| Ranks created, edited and deleted. |
| Kiosk orders, status changes and deliveries; supply purchases and claims. |
| Open/closed, image and cooking systems switched on or off. |
| Recipes created, edited and deleted. |
-- server/webhooks.lua
Config.ShowWebhookIP = false -- show players' IPs in log embeds
_G['webhook'] = {
creator = 'https://discord.com/api/webhooks/...',
finance = 'https://discord.com/api/webhooks/...',
workers = '',
ranks = '',
orders = '',
settings = '',
recipes = '',
}Adding an Inventory#
Supporting an inventory that is not on the list takes two files and one line:
Copy the closest bridge
Duplicate the closest pair — for example
client/custom/inventory/qb-inventory.luaandserver/custom/inventory/qb.lua— and rename them after your inventory.Replace the calls
Swap the exports inside for your inventory's: opening a stash (
OpenStash), and on the server the item list and image path.Register it
Add
['your-inventory'] = 'yourname'to theinventorieslist inconfig/main.luaand restart.
Languages and Price Format#
41 translations ship in locales/: ar, bg, bn, ca, cs, da, de, el, en, es, et, fa, fi, fr, he, hi, hr, hu, id, it, ja, ko, lt, lv, ms, nl, no, pl, pt, ro, ru, sk, sl, sv, sw, th, tr, uk, ur, vi and zh. Pick one with Config.Locale, or copy en.json to a new code to write your own.
Prices in every menu follow Config.Intl — set locales = 'es-ES' and currency = 'EUR' to show 1.250 €, for example. It only changes how numbers look, never the amounts.



