Configuration
Updated 4/28/2026
🤖 Configuration
⚙️ Base Configuration
Config = {}
Config.ChatKey = 'T'
ChatKey
The key players must press to open the chat.
🔧 Feature Toggles
Config.EnableEmojis = true
Config.AllowMove = true
Config.AllowRotate = true
| Feature | Description |
|---|---|
| EnableEmojis | Enables emoji rendering inside the chat. |
| AllowMove | Allows players to reposition the chat UI. |
| AllowRotate | Allows players to rotate the chat UI in 3D. |
🧍♂️ /me System
Config.Me = {
Distance = 15.0,
Color = "me",
Prefix = "",
Avatar = "ME"
}
| Option | Description |
|---|---|
| Distance | Visibility radius for /me messages. |
| Color | Color key linked to Config.Colors. |
| Prefix | Text before the message ("" = none). |
| Avatar | Icon text shown in the UI. |
🔌 System Toggles
Config.EnableOOC = true
Config.EnableMe = true
| System | Description |
|---|---|
| EnableOOC | Enables/Disables OOC chat entirely. |
| EnableMe | Enables/Disables /me functionality. |
💬 OOC Settings
Config.ProximityOOC = false
Config.OOCDistance = 20.0
Config.ImplicitOOC = true
| Setting | Description |
|---|---|
| ProximityOOC | If true → OOC is local only. |
| OOCDistance | Distance for proximity OOC. |
| ImplicitOOC | If enabled: typing normally = OOC message. |
🛡️ Admin Identifiers
Config.Admins = {
'license:0f8357b4b5e9aad0fd2cecbe5cc39777819b637a',
'license:xxxxxxxxxxxxxxxxxxxxxxxx',
}
Only listed identifiers can execute admin-only commands.
📘 Command Parameters Table
All supported commands with help descriptions and parameters for autocomplete.
Config.CommandParams = {
['/car'] = { help = "Spawn a vehicle", params = { { name = "model", help = "Vehicle Model Name" } } },
['/dv'] = { help = "Delete vehicle", params = { { name = "radius", help = "Radius (Optional)" } } },
['/tp'] = { help = "Teleport to coords", params = { { name = "x", help = "X" }, { name = "y", help = "Y" }, { name = "z", help = "Z" } } },
['/tpm'] = { help = "Teleport to waypoint", params = {} },
['/giveitem'] = { help = "Give an item to a player", params = { { name = "id", help = "Player ID" }, { name = "item", help = "Item Name" }, { name = "amount", help = "Amount" } } },
['/setjob'] = { help = "Set a player's job", params = { { name = "id", help = "Player ID" }, { name = "job", help = "Job Name" }, { name = "grade", help = "Grade" } } },
['/revive'] = { help = "Revive a player", params = { { name = "id", help = "Player ID (Optional)" } } },
['/noclip'] = { help = "Toggle noclip", params = {} },
['/fix'] = { help = "Repair vehicle", params = {} },
-- QBCore / Qbox
['/admin'] = { help = "Open Admin Menu", params = {} },
['/god'] = { help = "Toggle Godmode", params = { { name = "id", help = "Player ID (Optional)" } } },
['/givemoney'] = { help = "Give money to a player", params = { { name = "id", help = "Player ID" }, { name = "type", help = "cash, bank, crypto" }, { name = "amount", help = "Amount" } } },
['/setmoney'] = { help = "Set a player's money", params = { { name = "id", help = "Player ID" }, { name = "type", help = "cash, bank, crypto" }, { name = "amount", help = "Amount" } } },
['/removemoney'] = { help = "Remove money from a player", params = { { name = "id", help = "Player ID" }, { name = "type", help = "cash, bank, crypto" }, { name = "amount", help = "Amount" } } },
['/kill'] = { help = "Kill a player", params = { { name = "id", help = "Player ID" } } },
['/names'] = { help = "Toggle overhead player names", params = {} },
['/blips'] = { help = "Toggle player blips", params = {} },
['/weather'] = { help = "Change the weather", params = { { name = "type", help = "Weather Type" } } },
['/time'] = { help = "Change the time", params = { { name = "hour", help = "Hour" }, { name = "minute", help = "Minute" } } },
['/setgang'] = { help = "Set a player's gang", params = { { name = "id", help = "Player ID" }, { name = "gang", help = "Gang Name" }, { name = "grade", help = "Grade" } } },
['/clearinv'] = { help = "Clear player inventory", params = { { name = "id", help = "Player ID" } } },
['/jail'] = { help = "Jail a player", params = { { name = "id", help = "Player ID" }, { name = "time", help = "Time in minutes" } } },
['/unjail'] = { help = "Unjail a player", params = { { name = "id", help = "Player ID" } } },
-- ESX
['/setaccountmoney'] = { help = "Set account money", params = { { name = "id", help = "Player ID" }, { name = "account", help = "money, bank, black_money" }, { name = "amount", help = "Amount" } } },
['/giveaccountmoney'] = { help = "Give account money", params = { { name = "id", help = "Player ID" }, { name = "account", help = "money, bank, black_money" }, { name = "amount", help = "Amount" } } },
['/giveweapon'] = { help = "Give weapon to player", params = { { name = "id", help = "Player ID" }, { name = "weapon", help = "Weapon Name" }, { name = "ammo", help = "Ammo Count" } } },
['/clearinventory'] = { help = "Clear player inventory", params = { { name = "id", help = "Player ID" } } },
['/clearloadout'] = { help = "Clear player weapons", params = { { name = "id", help = "Player ID" } } },
['/goto'] = { help = "Teleport to player", params = { { name = "id", help = "Player ID" } } },
['/bring'] = { help = "Teleport player to you", params = { { name = "id", help = "Player ID" } } },
['/skin'] = { help = "Open Skin Menu", params = { { name = "id", help = "Player ID (Optional)" } } },
['/heal'] = { help = "Heal a player", params = { { name = "id", help = "Player ID (Optional)" } } },
['/announce'] = { help = "Send an announcement", params = { { name = "message", help = "Text" } } },
['/clearall'] = { help = "Clear chat for everyone", params = {} },
['/refreshjobs'] = { help = "Refresh job database", params = {} },
}
📡 Chat Channels
Config.Channels = {
['twt'] = { prefix = "TWT", color = "twitter", avatar = "TWT" },
['me'] = { prefix = "", color = "me", avatar = "ME" },
['yellowpages'] = { prefix = "YP", color = "yp", avatar = "YP" },
}
Each channel has its own color, label, and avatar.
🌍 Locales (Translations)
Config.Locales = {
server_command = "Server Command",
client_command = "Client Command",
access_denied = "ACCESS DENIED",
must_begin_with_slash = "Messages must begin with '/'.",
no_permission_command = "You do not have permission.",
error_prefix = "ERROR",
system_prefix = "SYSTEM",
announcement_usage = "Usage: /announcement [message]",
placeholder = "Type a message...",
toggle_move_mode = "Toggle Move Mode",
reset_chat_position = "Reset Position",
move_instructions = "Drag to move. Shift + Drag to rotate.",
command_param_missing = "Required argument missing.",
defaults_saved = "Global chat defaults saved!"
}
These strings can be fully localized to any language.
🎨 Color Configuration
Config.Colors = {
ooc = "#ff0000ff",
twitter = "#00ACEE",
me = "#C275F3",
yp = "#FFC107",
error = "#E74C3C",
system = "#c06f12",
player_name = "#FFFFFF",
background = "rgba(35, 39, 45, 0.85)",
border = "rgba(255, 255, 255, 0.1)",
text_primary = "#EAEAEA",
text_secondary = "#B0B3B8",
suggestion_background = "#1C1F25",
suggestion_hover = "#3498DB",
input_focus_border = "#3498DB",
scrollbar_track = "#20232A",
scrollbar_thumb = "#4A505A",
scrollbar_thumb_hover = "#3498DB"
}
Everything in the UI is customizable — backgrounds, text, borders, suggestions, and scrollbar.