Configuration
Updated 4/28/2026
🤖 Configuration
This configuration file controls KS Business Creator behavior, UI, colors, messages, commands, and framework integration.
It allows server owners to fully customize businesses, deliveries, crafting, and user interactions.
⚙️ General Settings
Config = {}
-- Debug Mode
Config.Debug = false
-- Core Framework Settings
-- Options: 'qb', 'qbx', 'esx', or 'auto' (auto-detects available resource)
Config.Framework = 'auto'
Config.Inventory = 'auto'
Config.Notify = 'auto'
Config.ProgressBar = 'auto'
-- Target System
-- Options: 'ox_target', 'qb-target', or 'auto' (auto-detect)
Config.TargetSystem = 'auto'
Debug– enable detailed debug output for troubleshootingFramework– choose the core framework (QBCore, QBox, ESX) or auto-detectInventory,Notify,ProgressBar– integrated systems, auto-detect supportedTargetSystem– select targeting interaction system (e.g.,ox_target)
💬 Commands
Config.OrdersCommand = 'orders'
Config.CreatorCommand = 'createbusiness'
OrdersCommand– command for employees to view active ordersCreatorCommand– command to open business creation panel
🎨 UI Theme & Colors
Config.Colors = {
['bg-main'] = '#050507',
['bg-panel'] = '#0e0e11',
['bg-element'] = '#18181b',
['bg-input'] = '#09090b',
['bg-header'] = '#131316',
['bg-badge'] = '#27272a',
['primary'] = '#6366f1',
['primary-hover'] = '#818cf8',
['primary-dim'] = 'rgba(99, 102, 241, 0.15)',
['danger'] = '#f43f5e',
['success'] = '#10b981',
['warning'] = '#f59e0b',
['text-primary'] = '#f8fafc',
['text-secondary']= '#94a3b8',
['border'] = '#27272a',
['radius'] = '10px',
['shadow-main'] = '0 0 50px rgba(0,0,0,0.9)',
['overlay-game'] = 'rgba(5, 5, 7, 0.95)',
-- ...additional colors for hover, scrollbars, shadows, etc.
}
- Customize backgrounds, accents, text, borders, and interactive states
- Includes shadows, overlay opacity, hover states, and radius for a modern UI
💬 Notification Messages
Config.Messages = {
delivery = 'Delivery',
no_access = 'You do not have access to this command!',
created = 'Business created successfully!',
updated = 'Business updated successfully!',
deleted = 'Business deleted!',
duty_toggle = 'Duty status changed.',
deposited = 'You deposited $%s.',
withdrawn = 'You withdrew $%s.',
insufficient_funds = 'Insufficient funds!',
hired = 'Employee hired!',
fired = 'Employee fired!',
voted = 'Thank you for your rating!',
recipe_added = 'Recipe added!',
crafted = 'Successfully crafted %s',
delivery_start = 'Picked up %sx %s. Deliver to client!',
delivery_success = 'Delivery successful! Received $%s',
-- ...more messages for orders, inventory, and crafting
}
- All player notifications are fully configurable
- Messages support dynamic placeholders (
%s)
🎯 Target Interactions
Config.Target = {
duty = 'Toggle Duty (%s)',
open_tray = 'Open Counter',
storage = 'Storage',
takeaway = 'Takeaway / Orders',
menu = 'View Menu',
boss_menu = 'Boss Menu',
rate_us = 'Rate Us',
crafting = 'Workstation',
delivery_start = 'Start Delivery',
delivery_cancel = 'Cancel Delivery',
}
- Defines in-world actions and interactive prompts for each business element
🖥 UI Texts & Labels
Config.UI = {
Sidebar = {
Brand = 'KS SYSTEM',
Management = 'Management',
Dashboard = 'Dashboard',
Businesses = 'Businesses',
Create = 'Create / Edit',
Exit = 'Exit Panel'
},
Dashboard = {
Title = 'Dashboard',
Subtitle = 'Overview & Quick Actions',
TotalBusinesses = 'Total Businesses',
ActiveJobs = 'Active Jobs',
SystemStatus = 'System Status',
StatusOnline = 'Online'
},
Businesses = {
Title = 'Businesses',
Subtitle = 'Manage all active locations',
SearchPlaceholder = 'Search...',
Headers = { Label='Label', Job='Job', Status='Status', Actions='Actions' },
StatusOnline = '● Online'
},
CreateEdit = {
CreateTitle = 'Create Business',
EditTitle = 'Edit:',
Details = 'Details',
Locations = 'Locations',
MapSettings = 'Map Settings (Blip)',
Labels = { Name='Name', Job='Job', BusinessName='Business Name', SpriteId='Sprite ID', ColorId='Color ID', Scale='Scale' }
},
Boss = {
Balance = 'Company Balance',
Deposit = 'Deposit',
Withdraw= 'Withdraw',
ManageRecipes = 'Manage Recipes',
HireBtn = 'HIRE',
Employees = 'Employees'
},
RecipeManager = { Title='Recipes', CreateBtn='Create', StationAbbr='St' },
Crafting = { Title='Workstation', SelectItem='Select Item', CraftBtn='CRAFT' },
CustomerMenu = { Title='Business Menu', SendOrder=' Send Order' },
Orders = { Title='Active Orders', NoOrders='No active orders.', CompleteBtn='COMPLETE' },
Rating = { Title='Feedback', SubmitBtn='Submit', AlreadyVoted='You already voted.' }
}
- All in-game UI labels are configurable for translation or custom naming
- Includes sidebar, dashboard, businesses list, creation/edit menus, boss menus, crafting, orders, and rating panels
✅ Summary
- Full framework auto-detection or manual selection (QBCore, QBox, ESX)
- Fully configurable colors, UI, and themes
- All notification messages editable
- Commands, target prompts, and labels fully customizable
- Designed for fast setup of businesses, deliveries, crafting, and employee management