Restaurant Management

💰 Full-Featured, Optimized & Dynamic Restaurant/Business Management System

lcky-restaurant_management is a production-ready restaurant and business management framework built for FiveM. Features lazy-loading architecture, RAM-first caching, and framework-agnostic bridge system.

✨ Features

Core Systems

🏪 Multi-Restaurant Support - Unlimited restaurants with independent menus, recipes, orders
📦 Lazy Loading - Restaurants load from SQL on first access (minimal memory)
⚡ RAM-First Caching - All runtime data cached in memory with instant SQL sync
🔒 Job Grade Permissions - Granular access based on framework job grades

Business Operations

📋 Dynamic Menu Management - Add, edit, remove menu items in real-time
🧑‍🍳 Kitchen Station System - Cooking (Grill, Fryer, Oven, Coffee) and Assembly stations
🍳 Dynamic Recipe System - Restaurant-specific recipes with custom ingredients
🛒 Cart & Order System - Full ordering flow with FIFO queue and real-time kitchen updates
💰 Payment System - Cash and bank card payments with confirmation
🧾 Receipt System - Physical receipt items (ox_inventory) with single/bulk redemption
💲 Tip System - Configurable tip percentages (0-20%)
🏷️ Discount System - Time-limited hourly discounts
📊 Z Report System - Revenue analytics and statistics
🏪 Wholesale Market - Bulk ingredient purchasing via ox_inventory

📦 Dependencies

Dependency	Required
ox_lib	✅
ox_inventory	✅
oxmysql	✅
ox_target or qb-target	✅
qbx_core, qb-core, or ESX	✅

🚀 Installation

Step 1 - Place the Resource

resources/
└── [spc-scripts]/
    └── lcky-restaurant_management/

Step 2 - Import Database

Execute sql/schema.sql - creates:

lcky_restaurants - Restaurant definitions
lcky_menu_items - Menu items
lcky_recipes - Dynamic recipes
lcky_recipe_ingredients - Recipe ingredients
lcky_interaction_points - Interaction points
lcky_orders_log - Order history
lcky_discounts - Discount records

Step 3 - Register Inventory Items

Add items from inventoryitems.lua to your ox_inventory items config.

Step 4 - Add to server.cfg

ensure ox_lib
ensure oxmysql
ensure ox_inventory
ensure ox_target
ensure lcky-restaurant_management

Step 5 - Admin Permission

add_ace group.admin command.restaurantadmin allow

Step 6 - Create Restaurants

Use /restaurantadmin in-game to register restaurants.

📁 Architecture

├── client/      # Point manager, interaction editor, menus, kitchen
├── server/      # Instance, menu, order, recipe, kitchen managers
│   └── repositories/  # SQL abstraction layer
└── shared/
    ├── config.lua     # Main configuration
    ├── config_stations.lua  # Station definitions
    └── bridge/        # Framework auto-detect
        ├── core/      # qb.lua, esx.lua
        ├── inventory/ # ox.lua, qb.lua
        └── target/    # ox.lua, qb.lua

Data Flow

Lazy Loading - Restaurant data loads from MySQL on first access
RAM Cache - Data lives in _G.SPC_RestaurantInstances
Instant Sync - Every mutation writes to SQL first, then updates cache

⚙️ Configuration

Permission Grades

Config.Permissions = {
    accessCashier = 0,      -- All employees
    accessStorage = 1,      -- Chef+
    accessKitchen = 1,      -- Chef+
    editMenu = 2,           -- Manager+
    viewZReport = 2,        -- Manager+
    manageDiscounts = 2,    -- Manager+
}

Restaurant Definitions

Config.Restaurants = {
    ["burgershot"] = { name = "Burger Shot" },
    ["beanmachine"] = { name = "Bean Machine" },
}

Menu Categories

Config.MenuCategories = {
    burger  = { label = "Burgers",  icon = "fas fa-burger" },
    drink   = { label = "Drinks",   icon = "fas fa-glass-water" },
}

🔧 Cooking Stations

Station	Processes
Grill	Raw Meat → Cooked Meat, Raw Bacon → Cooked Bacon
Fryer	Potato → Fries, Onion → Onion Rings
Oven	Dough → Baked Dough, Whole Chicken → Roasted Chicken
Coffee Machine	Coffee Beans → Espresso Shot

Assembly Stations

Dynamic recipe-based stations (Prep Table, Drink Station)

🎮 In-Game Commands

Command	Description
`/restaurantadmin`	Open admin panel
(In-game menus)	Management, Cashier, Kitchen interfaces

📤 Key Exports

Instance Manager

exports['lcky-restaurant_management']:GetRestaurant(jobName)
exports['lcky-restaurant_management']:HasPlayerPermission(source, perm)
exports['lcky-restaurant_management']:PreloadAllRestaurants()

Order Manager

exports['lcky-restaurant_management']:CreateOrder(source, jobName, items)
exports['lcky-restaurant_management']:UpdateOrderStatus(jobName, orderId, status)

Menu Manager

exports['lcky-restaurant_management']:AddMenuItem(jobName, data)
exports['lcky-restaurant_management']:GetRestaurantMenu(jobName)

🛠️ Admin Setup

Grant ACE permission: add_ace group.admin command.restaurantadmin allow
Run /restaurantadmin in-game
Add restaurants and interaction points
Set up menus and recipes
Open for business via Management Menu

📝 License

Quick Action (Radial) Menu Support