Skip to content

Requirements and Compatibility

Check required dependencies and the providers needed for each feature.

Check these dependencies before creating a restaurant. After installation, test the panel, inventory and food preparation in FiveM.

What you need#

RequirementWhy Restaurant needs itWhat to check
FiveM with onesync1Shared food props, stations and mobile vehiclesEnable OneSync in the server configuration
MySQL/MariaDB through oxmysqlRestaurants, published setups, stock, orders and money recordsA working connection and oxmysql 2.12.0 or newer with MySQL.startTransaction support
ox_libShared interface featuresResource starts without errors
0r_libRequired Restaurant dependencyInstalled and started before 0r-restaurant
One supported frameworkCharacter identity and framework accountsqbx_core, qb-core or es_extended
One supported inventoryMaterial packets, finished products and delivery bagsox_inventory or qb-inventory with the required item definitions
Target provider when using TargetSelectable world interactionsox_target or qb-target

Use the actual provider installed on your server. Do not start several frameworks just to satisfy this table. Built-in detection prefers Qbox, then QBCore, then ESX when several are present; a deliberately mixed server needs careful provider review.

Maps and mobile features#

A map preset2 supplies saved locations. Install its matching mlo or map3 separately before using those coordinates. With another building, choose no map preset and place your stations manually.

Supported fixed interactions can use textui interaction4 instead of Target. Mobile carts and vehicles require a working target provider. Mobile food vehicles also require qbx_vehiclekeys, qb-vehiclekeys or a correctly configured custom vehicle-key bridge. A working fixed kitchen does not prove that these additional mobile dependencies are ready.

Inventory compatibility is more than the resource name#

Register the three Restaurant items, keep their saved details and install their PNG files. Modified versions of an inventory can behave differently from the supported version. Check compatibility before using storage or food items.

See Inventory Items and Images for the exact registration examples. See Providers before integrating a custom fork.

Existing data and first startup#

Restaurant creates its tables during the first startup after the database connects. A fresh installation needs no manual SQL import. For an existing database, follow the instructions supplied with the update.

Keep one owning Restaurant resource per database. Renaming a second copy does not create a safe second installation over the same tables.

Ready to continue#

Proceed when the required dependencies start successfully and the database is reachable. Follow Installation and Start Order, then complete one real item transfer and production flow in your test server. Keep any provider error intact for diagnosis; Installation Problems explains the first checks.

Fixed products that still use Target#

Coffee and Soda stations, plus Donut baking/decoration, use target interactions. Install and start ox_target or qb-target for those products even when the restaurant profile uses TextUI. Mobile carts/vehicles always require a target provider, and Ice Cream vehicles also need supported vehicle keys.

Footnotes

  1. The FiveM networking mode Restaurant needs for shared food props, stations and vehicles. Read the definition. ↩

  2. A set of predefined locations for a particular installed map. Read the definition. ↩

  3. The separately installed game environment in which a restaurant can be placed. Read the definition. ↩

  4. A nearby text/key prompt used for supported fixed restaurant interactions. Read the definition. ↩