Diamond Uwu Cafe

Overview

Diamond Uwu Cafe is a configurable café job system with customer tablet ordering, employee kitchen/counter dashboards, live stock, offline NPC processing, recipes, combo containers, cats, billing, receipts, and external integration exports.

Compatibility matrix

Requirements

Required resources

• ox_lib — context menus, input dialogs, progress bars, callbacks, and notifications.
• oxmysql — order history, editable prices, and AutoSQL.
• One supported framework — ESX, QBCore, or Qbox.
• One supported inventory — ox_inventory or qs-inventory is recommended for the complete stock workflow.
• ox_target — currently required by the manifest in v1.1.1.

Optional integrations

• peleg-billing, billing_ui, esx_billing, jim-payments, or a compatible framework billing route.
• envi-receipts for customer and staff receipt copies.
• qs-smartphone-pro when its duty export is used as the employee clock-in source.
• qb-management, qb-bossmenu, esx_society, qb-banking, or related framework business resources.
• mythic_notify or Notifier only when selected in the notification configuration.
• cuchi_computer/Food Hub integration when external food delivery is installed.

Installation

1. Keep the folder name.

   Place the resource at resources/[jobs]/diamond_uwu. Keeping the exact folder name preserves all documented export examples and ox_inventory item-export references.

2. Install dependencies.

   Start oxmysql, ox_lib, your framework, inventory, and target before this resource.

3. Add inventory items.

   Use Install/OX_Inventory Items.txt for ox_inventory or Install/QB-core items.txt for QB-style shared item tables. QS users normally adapt the QB-style definitions to their item registry.

4. Copy item images.

   Copy the PNG files from Install/Images into the image folder used by your inventory.

5. Prepare the database.

   AutoSQL is enabled by default. It creates the two script tables and, on ESX databases, attempts to create the Uwu job, grades, society records, and default prices. When AutoSQL is disabled, import Install/uwu.sql manually.

6. Add the job for QB/Qbox.

   AutoSQL does not create QBCore or Qbox job definitions. Add a job named uwu with grades 0–4. Grade 4 is the configured boss grade.

7. Configure billing and receipts.

   Select integrations that are actually installed, then verify the society/job identifier required by that integration.

8. Start and test.

   Restart the server, check the console detection messages, stock the Uwu stash, and complete one order from customer checkout to counter pickup.

Recommended server.cfg order

# Database and library
ensure oxmysql
ensure ox_lib

# Framework (choose one)
ensure es_extended
# ensure qb-core
# ensure qbx_core

# Inventory (choose one; ox or QS recommended for full stock support)
ensure ox_inventory
# ensure qs-inventory
# ensure qb-inventory

# Target
ensure ox_target
# qb-target adapter code exists, but ox_target is still a manifest dependency in v1.1.1

# Optional integrations
# ensure peleg-billing
# ensure envi-receipts

# Start Diamond Uwu Cafe last
ensure diamond_uwu

Database installation

With Config.AutoSQL.Enabled = true, the resource creates:

• uwu_orders — customer order history and processor name.
• uwu_prices — persistent menu prices editable from the UI.

On ESX, it also checks for the standard jobs, job_grades, addon_account, addon_inventory, datastore, and addon_account_data tables before inserting Uwu records.

QBCore-style job example

['uwu'] = {
    label = 'Uwu Café',
    type = 'restaurant',
    defaultDuty = true,
    offDutyPay = false,
    grades = {
        ['0'] = { name = 'Trainee',  payment = 50 },
        ['1'] = { name = 'Employee', payment = 75 },
        ['2'] = { name = 'Chef',     payment = 100 },
        ['3'] = { name = 'Manager',  payment = 125 },
        ['4'] = { name = 'Owner',    payment = 150, isboss = true },
    },
},

Qbox servers should create the same job name and grade structure through the job configuration or management method used by their current Qbox build.

Inventory Items & Images

The package contains 41 item definitions. The configured meal containers also give a paperbag item when opened, so add that item separately unless your server already has it.

Inventory image paths

Required item names

Paper bag add-on

['paperbag'] = {
    label = 'Paper Bag',
    weight = 20,
    stack = true,
    close = true,
},

paperbag = {
    name = 'paperbag',
    label = 'Paper Bag',
    weight = 20,
    type = 'item',
    image = 'paperbag.png',
    unique = false,
    useable = false,
    shouldClose = true,
    description = 'Uwu Café takeaway packaging.'
},

Opening uwu1–uwu4 with ox_inventory

The resource exposes UseMealContainer for ox_inventory. Attach it to each combo item and set consume = 0; the resource removes the container only after the opening progress completes.

['uwu1'] = {
    label = 'Uwu Meal 1',
    weight = 50,
    stack = true,
    close = true,
    consume = 0,
    server = {
        export = 'diamond_uwu.UseMealContainer'
    }
},

Configuration Reference

Framework and inventory detection

Config.Debug = false
Config.ForceFramework = nil   -- 'ESX' | 'QBCore' | 'Qbox' | 'CUSTOM' | nil
Config.ForceInventory = nil   -- 'ox' | 'qs' | 'qb' | 'tgiann' | 'esx' | 'custom' | nil
Config.SocietyName = 'uwu'

Leave both force values at nil for automatic detection. Force a backend only when multiple framework or inventory resources are running and the wrong one is selected.

Business stock

Config.StockSystem = {
    Enabled = true,
    StashId = 'uwu_stock',
    StashSlots = 50,
    StashWeight = 5000000,
    LowStockThreshold = 5,
    DeliverItemsToCustomer = true,
    BossGrade = 4,
    BossOnlyJob = 'uwu',
    MenuItems = { 'uwu_btea', 'uwu_cookie', 'uwu_cupcake', 'uwu_eggroll',
                  'uwu_coleslaw_salad', 'uwu_sushi', 'uwu1', 'uwu2', 'uwu3', 'uwu4' }
}

• The customer menu reads live counts from the stock stash.
• Normal tablet orders reserve/deduct stock when submitted.
• Staff-completed orders are placed in the counter tray for pickup.
• Offline NPC orders are delivered directly after the configured timer.

Counter tray

Config.CounterTrayStash controls the pickup stash ID, label, slots, weight, target coordinates, target distance, and whether the script creates a target. The default OpenTarget = 'ox_only' avoids duplicate targets on QS servers.

Offline cashier

Config.OfflineNPCOrder = {
    Enabled = true,
    JobName = 'uwu',
    ProcessorName = 'Offline NPC',
    TimerSeconds = 45,
    UseQsSmartphoneDuty = false
}

QBCore employees with job.onduty = false do not block the offline cashier. ESX does not provide the same duty flag through this bridge, so any online Uwu employee is treated as active unless the optional QS smartphone duty check is enabled.

Billing

Config.Billing = {
    Mode = 'peleg-billing', -- peleg-billing | billing_ui | esx_billing | jim-payments
    Society = 'uwu',
    Label = 'Uwu Café Order',
    Account = 'bank'
}

Avoid treating none as a guaranteed no-charge mode in v1.1.1. The generic framework billing layer contains a direct cash/bank fallback when a configured billing route does not create an invoice.

Receipts and cosmetic tax

Config.Receipts = {
    Enabled = true,
    Resource = 'envi-receipts',
    BusinessLabel = 'Uwu Café',
    MarkInvoiceAsPaid = false,
    MarkChargeAsPaid = true,
    Tax = { Enabled = true, Percentage = 10, Label = 'Tax' }
}

The tax line is display-only and inclusive. It does not increase the amount charged.

Notifications

Client options: ox, mythic, gta, notifier, or custom. Server options are configured separately in Config.Notify.Type. Implement custom behavior in client/utils.lua and server/utils.lua.

Images

Config.Images = {
    Provider = 'auto', -- auto | ox | qs | qb | custom
    CustomBase = 'nui://ox_inventory/web/images',
    CustomExt = '.png',
    Overrides = {
        -- cocoa_powder = 'your_cocoa_icon',
        -- paperbag = 'your_bag_icon',
    }
}

Targets and coordinates

Edit Config.Targets to move the order tablet, kitchen boards, counter board, boss menu, stations, stock storage, freezer, and order tray. Edit Config.OfflineStoreNPC.coords and Config.Blip.Coords separately.

Cats

Config.UWUCatsToggle sets the command name and job. Cat state is stored in a resource KVP and synchronized to all clients. In v1.1.1, the server command checks the job but does not enforce the configured grade value.

NUI configuration

ui/config.js controls labels, fallback prices, descriptions, image bases, and audio volume. Database prices take over after the server loads uwu_prices. Add new menu products to both the Lua configuration and the NUI configuration.

Recipes & Menu Customization

Recipe tables

Every recipe needs a unique item key, an output amount, one of the configured animation keys, and an ingredient map. It must also be registered in the correct category table so the station menu and public export can find it.

Example: add a preparation recipe

Config.Recipes['uwu_brownie'] = {
    Label = 'Uwu Brownie',
    Amount = 1,
    Animation = 'Prep',
    Ingredients = {
        flour = 1,
        sugar = 1,
        eggs = 1,
        chocolate_chips = 1
    }
}

table.insert(Config.Craftables, {
    event = 'diamond_uwu:prepareBrownie',
    recipeKey = 'uwu_brownie',
    animationLabel = 'Prepare Brownies'
})

New menu product checklist

1. Create the item in the active inventory.
2. Add a PNG with the exact filename or configure an image override.
3. Add the recipe to Config.Recipes.
4. Add it to the correct crafting category table.
5. Add it to Config.StockSystem.MenuItems if customers can order it.
6. Add a default row to uwu_prices or save it from the price UI.
7. Add the label, description, and fallback price to ui/config.js.
8. Test single and batch crafting, stock deduction, ordering, billing, pickup, and receipts.

How the Script Works

Customer workflow

1. Use the order tablet target.
2. Add in-stock products to the cart.
3. Submit the order; the server validates product names, quantities, and stock.
4. If staff are active, the order appears on staff boards.
5. When staff complete the order, products are placed in the counter tray and billing/receipt actions run.
6. If no active staff are available and offline processing is enabled, the offline NPC processes the order after the configured timer and gives the items directly to the customer.

Employee workflow

1. Grab ingredient sets from the freezer; the business society is charged per set.
2. Craft food and drinks at the configured stations.
3. Place finished menu products in uwu_stock.
4. Use kitchen/counter boards to review orders and check completed items.
5. Mark the order complete, then verify billing, receipt copies, and counter-tray placement.

Stock behavior

The stock stash is the source of truth for customer availability. Low-stock and out-of-stock states are calculated with Config.StockSystem.LowStockThreshold. Inventory backends without implemented stash-reading/removal support cannot provide the full live-stock workflow without a custom bridge.

Offline NPC behavior

The offline NPC is used only when no active Uwu employee is detected. QBCore duty status is respected. The NPC typing animation and timer are synchronized through client events, and the order is marked as processed by the configured processor name.

Developer API

Client exports

local accepted = exports['diamond_uwu']:CookItem('cooked_ground_pork', 2)

local accepted = exports['diamond_uwu']:MakeDrink('uwu_btea', 1)

local accepted = exports['diamond_uwu']:GrabIngredients('grabSushi', 3)

local accepted = exports['diamond_uwu']:PrepareMeal('uwu1', 1)

local accepted = exports['diamond_uwu']:CraftItem('uwu_cookie', 4)

local backend = exports['diamond_uwu']:GetInventoryBackend()

local base = exports['diamond_uwu']:GetInventoryImageBase()

local icon = exports['diamond_uwu']:GetInventoryImagePath('uwu_cookie')

Server exports

local ok = exports['diamond_uwu']:INV_AddItem(source, 'uwu_cookie', 1)

local ok = exports['diamond_uwu']:INV_RemoveItem(source, 'uwu_cookie', 1)

local count = exports['diamond_uwu']:INV_CountItem(source, 'uwu_cookie')

local report = exports['diamond_uwu']:INV_GetStockReport()

local counts = exports['diamond_uwu']:INV_GetStashItemCounts('uwu_stock')

local count = exports['diamond_uwu']:INV_CountStashItem('uwu_stock', 'uwu_btea')

local ok, missing = exports['diamond_uwu']:INV_CanRemoveStockItems({ uwu_btea = 2, uwu_cookie = 4 })

local ok, failed = exports['diamond_uwu']:INV_RemoveStockItems({ uwu_btea = 2 })

local ok = exports['diamond_uwu']:INV_RegisterStockStash()

local backend = exports['diamond_uwu']:INV_CurrentBackend()

local ok, message = exports['diamond_uwu']:FoodHubFulfillDelivery(customerSource, { uwu_btea = 1, uwu_cookie = 2 })

server = { export = 'diamond_uwu.UseMealContainer' },
consume = 0

Stock report response

{
    item = 'uwu_btea',
    count = 12,
    low = false,
    out = false,
    threshold = 5
}

Food Hub input formats

FoodHubFulfillDelivery accepts either a name-to-quantity map or an array of rows.

-- Map
{ uwu_btea = 1, uwu_cookie = 2 }

-- Array
{
    { item = 'uwu_btea', qty = 1 },
    { name = 'uwu_cookie', amount = 2 }
}

External client command example

RegisterCommand('makeuwucookies', function()
    local accepted = exports['diamond_uwu']:CraftItem('uwu_cookie', 2)
    if not accepted then
        print('uwu_cookie is not registered in Config.Craftables')
    end
end, false)

External server stock example

RegisterCommand('uwustockcheck', function(source)
    local report = exports['diamond_uwu']:INV_GetStockReport()
    for _, row in ipairs(report) do
        print(('%s: %s'):format(row.item, row.count))
    end
end, true)

Commands & Permissions

Commands

Default target permissions

Troubleshooting

Debug mode

Config.Debug = true
Config.AutoSQL.Debug = true

Disable debug mode after testing to keep the console clean.

Support ticket checklist

• Diamond Uwu Cafe version.
• Framework and exact version.
• Inventory and target resource.
• Billing and receipt resource.
• Relevant Config values.
• Complete server-console error, not only the last line.
• Steps to reproduce.
• Whether the issue occurs for customer, employee, or boss.
• Whether the issue happens with one item/order or all of them.

Updates & File Reference

Escrow-ignored/editable files

Safe update procedure

1. Back up shared.lua, ui/config.js, custom utility/bridge files, and any custom images.
2. Back up the database tables if the update changes order or price storage.
3. Stop diamond_uwu.
4. Replace files according to the release notes; do not blindly overwrite custom bridge files.
5. Merge new configuration keys into the existing configuration.
6. Keep OverwriteExistingPrices = false unless intentionally reseeding prices.
7. Restart dependencies first, then Diamond Uwu Cafe.
8. Run the first-run test checklist again.

First-run acceptance test

• Framework and inventory detection messages are correct.
• AutoSQL completes without errors.
• Customer tablet opens and displays images, prices, and stock.
• Ingredient grab charges the correct society and grants the correct quantities.
• Every station crafts a single item and a batch.
• Finished items can be stocked.
• Staff order appears, checked items synchronize, and completion works.
• Counter tray receives completed products.
• Billing and both receipt copies work.
• Offline NPC completes an order only when no active Uwu employee is available.
• uwu1–uwu4 open correctly and grant their configured contents.
• Exports work from a separate test resource.