Configuration
Configuration Overview
Config.SystemSettings = {
Language = "en", -- en - English | es - Spanish | zh_tw - Chinese (Traditional) | kr - Korean | fr - French | pt_br - Portuguese (Brazil)
Debug = false,
theme = "gblue", -- gblue | theme2 | theme3 | theme4 | theme5 - defalt theme
-- Even if you use an NPC delivery job with OpenMenuVia == "target", you still need a text UI to park the vehicle.
OpenMenuVia = "target", -- target | textui | custom
}
-- TextUI settings
Config.Key = 38 -- 38 = [E] https://docs.fivem.net/docs/game-references/controls/#controls
Config.KeyName = "[E] "
Config.TextUI = "ox_lib" -- supported Notifications TextUi's - "ox_lib" | "okok" | "esx" | "qbcore"
-- g-notifications package - https://groot-development.tebex.io/package/6838310
Config.Notify = "g-notifications" -- supported Notification's' - "g-notifications" | "ox_lib" | "esx" | "qbcore" | "okok" | 17mov | standalone
-- You can add your custom ProgressBar in src/client/cl_edit.lua.
Config.ProgressBar = "ox_lib" -- supported ProgressBars's - "ox_lib" | "qbcore" | "custom"
Config.PosSettings = {
enableClickSound = true,
MaxQuantityPerItem = 10,
CurrencySymbol = "$",
isTimeFormat24 = true,
TaxPercentage = 10,
MaxPriceEditAmount = 20000,
totalTables = 7,
pos_tablet_item = "pos_tablet",
pos_receipt_item = "pos_receipt",
-- This is the type used when you deposit or withdraw money from the POS.
deposit_and_withdraw_type = "cash", -- cash | bank
useTablet3DEffect = true,
nearbyDist = 10.0, -- distance radius to detect nearby players
-- update 1.1.0
enablePagerNotification = false,
Crafting = {
enable = true,
-- if type is inbuilt, the menu will show in the pos tablet
-- if type is external, the menu will show in the external menu
type = "external", -- inbuilt | external
},
-- update 1.3.0
enablePosJob = false,
-- if this false system will use inbuilt society system
-- If true, deposits and withdrawals will use your framework’s society/banking system
UseSocietyPayouts = false,
POSPlayerCommission = {
enabled = false, -- Enable commission system for POS sales
commissionMoneyType = "bank", -- cash | bank - type of money for player commission
},
-- update 1.4.0
enableSelfOrderSystem = true,
-- update 1.6.0
enableItemCreator = false,
-- update 1.8.0
-- Key to close the NPC customer order slip (View / Give order items UI). Use lowercase, e.g. "g", "escape"
NpcOrderSlipCloseKey = "g",
MaxItemsCanNpcOrder = 1, -- Max number of different items an NPC can order (order will have 1..MaxItemsCanNpcOrder items)
-- NPC order completion payout (who gets the money when player gives items to NPC)
NpcOrderPlayerPercentage = 15, -- % to player (0 = all society, 100 = all player). Rest goes to business society.
NpcOrderPlayerMoneyType = "cash", -- Where player cut goes: "cash" | "bank"
}
Config.OrderSystems = {
["cat_cafe"] = { -- job name
name = "Cat Cafe",
allowProductPageGrades = { 2, 3, 4 },
allowManagementPageGrades = { 3, 4 },
allowCraftingPageGrades = { 2, 3, 4 },
-- crafting config
-- This will only work if you enable the crafting in the pos settings
crafting = {
kitchenCoords = {
-- Station 1: Food only (lunch, dinner, snacks, sauces) - default BBQ animation
{
coords = vec3(-1195.2734, -899.5384, 13.8862),
categories = { "lunch", "dinner", "snacks", "sauces" },
animation = {
dict = "amb@prop_human_bbq@male@base",
clip = "base",
prop = "prop_fish_slice_01",
-- Optional: per-prop attach offsets (x, y, z = position; rotX, rotY, rotZ = rotation)
-- attachOffsets = { x = 0.118, y = 0.051, z = -0.008, rotX = 0.0, rotY = 0.0, rotZ = 160.88 },
-- attachBone = 57005, -- optional, default 57005 (right hand). 18905 = left hand
},
},
-- Station 2: Drinks only (beverages) - drink animation, prop optional
{
coords = vec3(-1202.6993, -896.9389, 13.8862),
categories = { "beverages" },
animation = {
dict = "anim@amb@business@coc@coc_unpack_cut_left@",
clip = "coke_cut_v3_coccutter",
},
},
},
},
playerPercentage = 15, -- Percentage of sale that goes to the player who made the sale (if 0 rest goes to society)
-- update 1.4.0
SelfOrderSystem = {
coords = {
vec3(-1189.2491, -887.4050, 13.8862),
},
},
-- update 1.5.0
Blip = {
Enable = true,
coords = {
vec3(-1189.2491, -887.4050, 13.8862),
-- add more coords if you want more blips
},
BlipSprite = 214, -- https://docs.fivem.net/docs/game-references/blips/
BlipScale = 0.8,
BlipColor = 26,
BlipName = "Cat Cafe",
},
-- update 1.8.0
NpcCustomers = {
enable = true,
maxActiveNpcOrders = 2,
-- min/max in SECONDS (e.g. 60-180 = 1 to 3 minutes between each NPC spawn)
npcSpawnInterval = { min = 60, max = 180 },
npcStayTime = 90,
spawnPoint = vec3(-1173.0112, -864.2252, 14.1107),
standPoints = {
vec4(-1191.9237, -893.3458, 13.8862, 159.2819),
vec4(-1193.6121, -892.8024, 13.8862, 162.8840),
},
-- Optional: one path for all NPCs - first coords, then next; last segment is to assigned stand. For MLOs include at least one waypoint inside the interior.
walkPath = {
vec3(-1178.2249, -868.5001, 14.0393), -- first: go here e.g. near door
vec3(-1180.7178, -885.5883, 13.8872), -- second: then here e.g. inside
vec3(-1187.6572, -890.5612, 13.8862), -- third: then here e.g. inside
},
},
},
-- You can add as many restaurants as you need.
}
POS items
-- These are header category and these category will be shown in the main page
Config.CategoryIcons = {
['breakfast'] = {
text = "Breakfast",
icon = "fa-solid fa-bread-slice"
},
['lunch'] = {
text = "Lunch",
icon = "fa-solid fa-hamburger"
},
['dinner'] = {
text = "Dinner",
icon = "fa-solid fa-utensils"
},
['snacks'] = {
text = "Snacks",
icon = "fa-solid fa-cookie"
},
['desserts'] = {
text = "Desserts",
icon = "fa-solid fa-ice-cream"
},
['sauces'] = {
text = "Sauces",
icon = "fa-solid fa-bottle-droplet"
},
['beverages'] = {
text = "Beverages",
icon = "fa-solid fa-mug-saucer"
},
-- Add more if you want
}
-- Config for products. These products can only be added to a restaurant.
-- AllowedJobs = {'<job_name>'} → If empty, all jobs can add this item to their shop.
Config.Items = {
[1] = {
itemName = "water",
itemLabel = "Water",
image = "water.png",
AllowedJobs = { "cat_cafe", "bar", "police" },
Category = "beverages",
},
[2] = {
itemName = "fries",
itemLabel = "Fries",
image = "fries.png",
AllowedJobs = { "cat_cafe", "bar", "police" },
Category = "snacks",
},
[3] = {
itemName = "mustard",
itemLabel = "Mustard",
image = "mustard.png",
AllowedJobs = { "cat_cafe", "bar", "police" },
Category = "sauces",
},
[4] = {
itemName = "pizza_ham",
itemLabel = "Ham Pizza",
image = "pizza_ham.png",
AllowedJobs = { "cat_cafe", "bar", "police" },
Category = "dinner",
},
-- Add more items as needed
}
Pos Cooking/Crafting items
Config.PosCraftingItems = {
["water"] = {
label = "Water",
item = "water",
image = "water.png",
ingredients = {},
craftingTime = 5000, -- in milliseconds
maxCraft = 10,
category = "beverages",
jobs = { "cat_cafe", },
},
["burger"] = {
label = "Burger",
item = "burger",
image = "burger.png",
ingredients = {
{ item = "bun", label = "Bun", image = "bun.png", quantity = 1 },
{ item = "patty", label = "Patty", image = "patty.png", quantity = 1 },
{ item = "lettuce", label = "Lettuce", image = "lettuce.png", quantity = 1 },
{ item = "tomato", label = "Tomato", image = "tomato.png", quantity = 1 },
},
craftingTime = 5000, -- in milliseconds
maxCraft = 10,
category = "lunch",
--[[
You can assign the job you want for crafting the item, so you don’t have to create multiple versions of the same item.
--]]
jobs = { "cat_cafe"},
},
["fries"] = {
label = "Fries",
item = "fries",
image = "fries.png",
ingredients = {
{ item = "potato", label = "Potato", image = "potato.png", quantity = 2 },
{ item = "oil", label = "Oil", image = "oil.png", quantity = 1 },
},
craftingTime = 3000, -- in milliseconds
maxCraft = 5,
category = "snacks",
jobs = { "cat_cafe", },
},
["mustard"] = {
label = "Mustard",
item = "mustard",
image = "mustard.png",
ingredients = {
{ item = "mustard", label = "Mustard", image = "mustard.png", quantity = 1 },
},
category = "sauces",
jobs = { "cat_cafe", },
},
["pizza_ham"] = {
label = "Ham Pizza",
item = "pizza_ham",
image = "pizza_ham.png",
ingredients = {
{ item = "dough", label = "Dough", image = "dough.png", quantity = 1 },
{ item = "ham", label = "Ham", image = "ham.png", quantity = 1 },
},
category = "dinner",
jobs = { "cat_cafe"},
},
['sprunk'] = {
label = "Sprunk",
item = "sprunk",
image = "sprunk.png",
ingredients = {
{ item = "sprunk", label = "Sprunk", image = "sprunk.png", quantity = 1 },
},
category = "beverages",
jobs = { "cat_cafe", "police" },
},
}
Last updated