Discord Store
Halo Backrooms

Configuration

Everything is in config.lua, which is server-only. Outside-world code lives in server/utils.lua and client/utils.lua, both left open when the resource is escrowed.

Integration

config.lua
Config.Integration = {
    level       = 'dh_urbansupply',  -- 'dh_urbansupply' | 'custom' | 'none'
    restaurants = 'dh_restaurants',  -- 'dh_restaurants' | 'standalone' | 'custom'
    selling     = 'builtin',         -- 'builtin' (/movegoods) | 'external'
}
SettingOptionsWhat it does
level'dh_urbansupply' · 'custom' · 'none'Where the level gate comes from. For 'custom', edit Utils.GetPlayerLevel(src). 'none' lets everyone in
restaurants'dh_restaurants' · 'standalone' · 'custom'Where House Specials appears (see below)
selling'builtin' · 'external''external' turns off /movegoods so you can add the real items to your own drug script

Restaurant modes

  • dh_restaurants — the item drops into the House Specials tab of the dh_restaurants menu
  • standalone — works with any restaurant script, even escrowed ones. Give the business a shop point; only qualified players get a target there. useUI = true opens the same menu UI as dh_restaurants, false opens a simple quantity dialog
  • custom — your restaurant script calls Backrooms' exports (below)

Modes can be set per business with mode = '…', e.g. Cat Café standalone and everything else on dh_restaurants.

Access & caps

config.lua
Config.TabLabel      = 'House Specials'
Config.RequiredLevel = 3        -- Urban Supply level (3 = Hustler)
Config.MaxPerWindow  = 100      -- per player, per business
Config.WindowSeconds = 10800    -- 3 hours, starts on first purchase
Config.ProximityCheck     = true
Config.MaxCounterDistance = 6.0

Config.BlockedJobs = {
    enabled    = true,
    onDutyOnly = false,  -- true = only blocked while on duty
    jobs       = { 'police', 'sheriff', 'state', 'ambulance', 'ems' },
}

Config.Admin = {
    ace      = 'halo_backrooms.admin',
    commands = { check = 'hbcheck', reset = 'hbreset', restock = 'hbrestock' },
}
ESX off-duty jobs (e.g. offpolice) are separate job names. Add them to jobs if you want them blocked too.

Businesses

config.lua
Config.Businesses = {
    burgershot = {
        enabled       = true,
        restaurant    = 'burgershot',   -- dh_restaurants name
        front         = { item = 'hb_works_combo', label = 'The Works Combo', price = 1500 },
        realItem      = 'hb_loaded_fries',
        craft         = { input = 1, output = 1 },
        RequiredLevel = nil,            -- per-business override
        maxPerWindow  = nil,            -- per-business cap override
        counters      = { vector3(-1194.35, -891.62, 13.10), vector3(-1193.13, -893.29, 13.10) },
    },
    catcafe = {
        enabled    = true,
        mode       = 'standalone',
        restaurant = 'catcafe',
        front      = { item = 'hb_catcafe_bento_box', label = 'Cat Café Bento Box', price = 1500 },
        realItem   = 'hb_biscuit_pouch',
        craft      = { input = 1, output = 1 },
        shop = {
            coords = vector4(-585.46, -1062.15, 22.34, 189.19),
            size   = vector3(1.2, 1.2, 1.5),
            useUI  = true,
            label  = 'UwU Cafe',
            theme  = { color = '#E58FB4', bg = '#161014', surface = '#21171D' },
        },
    },
}
BusinessFront itemReal item
burgershothb_works_combohb_loaded_fries
lotuswokhb_golden_dragon_rollhb_japanese_bento_box
catcafe (standalone)hb_catcafe_bento_boxhb_biscuit_pouch
gritsngravyhb_country_kitchen_specialhb_cornbread_tin
seafood (disabled)hb_bayou_seafood_baskethb_black_tide_package
suncafehb_cafe_breakfast_boxhb_dirty_chai

Crafting

config.lua
Config.Crafting = {
    enabled         = true,
    requireLevel    = true,
    targetLabel     = 'Work the goods',
    secondsPerBatch = 4,
    maxBatches      = 25,
    risk = {
        ruinChance   = 5,    -- % each batch is ruined
        alertBatches = 15,   -- runs this long or longer...
        alertChance  = 20,   -- ...have this % chance to alert police
    },
    spots = {
        -- recipes = { 'burgershot' } -> only that product, nil -> everything
        { label = 'Burger Shot kitchen', enabled = true, coords = vector4(0.0, 0.0, 0.0, 0.0), size = vector3(1.5, 1.5, 2.0), recipes = { 'burgershot' } },
        { label = 'Master kitchen',      enabled = false, coords = vector4(0.0, 0.0, 0.0, 0.0), size = vector3(1.5, 1.5, 2.0), recipes = nil },
    },
}

/movegoods

config.lua
Config.Selling = {
    command         = 'movegoods',
    stopCommand     = 'stopgoods',
    requireLevel    = true,
    minPolice       = 0,
    policeJobs      = { 'police', 'sheriff' },
    cornerRadius    = 25.0,      -- walk farther than this = stop
    phoneSeconds    = 4,
    maxCustomers    = 15,
    serveKey        = 38,        -- E
    minSaleInterval = 5,         -- seconds between serves
    blackAccount    = 'black_money',
    rejectChance    = 10,
    copAlertChance  = 20,        -- % of rejections called in
    robChance       = 10,        -- % of rejections that become a robbery
    rob = {
        goodsChance      = 50,   -- % they take goods (else money)
        goodsMax         = 5,
        money            = { 1000, 20000 },
        blackMoneyChance = 50,
        reclaimSeconds   = 30,   -- kill the robber within this to get it back
        escapeSeconds    = 45,
    },
    items = {
        -- price per 1,000-unit brick, same as Urban Supply
        ['hb_loaded_fries'] = { quantity = { min = 1, max = 5 }, price = { min = 500, max = 500 }, blackMoney = true },
    },
}

All player-facing text is in Config.Text, written in character so players never see a raw error.

Exports (custom restaurant mode)

your_restaurant/server.lua
-- Build menu: only add the tab if this returns something
local special = exports.Halo_Backrooms:GetSpecial(src, 'burgershot')
-- -> { business, item, label, price, remaining, tabLabel } or nil

-- Purchase: reserve BEFORE charging, settle AFTER
local entry, reason = exports.Halo_Backrooms:ReservePurchase(src, 'burgershot', special.item, qty)
if not entry then return notify(src, reason) end
-- charge entry.price * entry.quantity, give entry.grantItem x entry.quantity, then:
exports.Halo_Backrooms:SettlePurchase(entry.token, paidOk)  -- false refunds the cap

GetMenuCategories(src, restaurant) returns the same data shaped as a dh_restaurants-style category.

Editable hooks

FileHookUse it for
server/utils.luaGetPlayerLevelYour own level/rep system (level = 'custom')
server/utils.luaNotify · PoliceAlert · GetPoliceCountMessages and dispatch
server/utils.luaCanStartSellingBlock /movegoods in safe zones, require a burner phone, etc.
server/utils.luaChargePlayer · OnFrontPurchaseStandalone payments, society money, receipts
server/utils.luaOnCraft · OnSold · OnRobbed · OnReclaimedLogging or XP in your own systems (empty by default)
client/utils.luanotify, serve prompt, progress bar, targetSwap in your own UI pieces