beyond_hud
Configuration Examples
This page provides complete, copyable configuration defaults. Feel free to copy and paste these into your config.lua whenever you need to.
Default Configuration
beyond_hud/config/_config.lua
--[[ ██████╗ ███████╗██╗ ██╗ ██████╗ ███╗ ██╗██████╗ ██╔══██╗██╔════╝╚██╗ ██╔╝██╔═══██╗████╗ ██║██╔══██╗ ██████╔╝█████╗ ╚████╔╝ ██║ ██║██╔██╗ ██║██║ ██║ ██╔══██╗██╔══╝ ╚██╔╝ ██║ ██║██║╚██╗██║██║ ██║ ██████╔╝███████╗ ██║ ╚██████╔╝██║ ╚████║██████╔╝ ╚═════╝ ╚══════╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝╚═════╝ Join our Discord for support! https://discord.gg/beyond ]] -- Config = {} Config.ReinstallDatabase = false Config.Keymaps = { Settings = 'O', ShowCityID = 'F10', } Config.Hotkeys = { { key = Config.Keymaps.Settings, label = 'Settings' }, { key = '`', label = 'Talk Range' }, { key = 'T', label = 'Chat' }, { key = 'M', label = 'Phone' }, } Config.ShouldHideHUD = function() -- Add exports or other logic here to determine if the HUD should be hidden. Will be checked every 500ms. -- Ex: exports.randol_freecam:Active() return false end Config.Features = { Player = { Enabled = true, -- Show vitals data on the HUD. Options = { TextUI3D = true, ShowCompassForEmergencyServicesOnly = true, EmergencyServices = { 'police', 'ambulance', }, }, Voice = { Custom = false, IsCustomRadioOn = function() -- export function here or code related to the custom radio being on end, GetCustomRadioChannel = function(pid) -- custom radio channel code here end, IsCustomRadioMuted = function() -- custom radio muted code here end, GetCustomRadioPlayersInChannel = function(channel) -- custom radio players in channel code here end } }, Vehicle = { Enabled = true, -- Show vehicle related data when inside a vehicle. FuelResource = false, -- Defaults to LegacyFuel or GetVehicleFuelLevel (works for most resources) if not started, false to use default OwnedVehicleNames = false, ElectricVehicles = { [`buffalo5`] = true, [`tezeract`] = true, [`surge`] = true, [`iwagen`] = true, [`voltic`] = true, [`voltic2`] = true, [`raiden`] = true, [`cyclone`] = true, }, EmergencyVehicles = { POLICE = { [`riot`] = true, -- Police Riot [`riot2`] = true, -- RCV [`pbus`] = true, -- Police Prison Bus [`police`] = true, -- Police Cruiser [`police2`] = true, -- Police Buffalo [`police3`] = true, -- Police Interceptor [`police4`] = true, -- Unmarked Cruiser [`sheriff`] = true, -- Sheriff SUV [`sheriff2`] = true, -- Sheriff Cruiser [`policeold1`] = true, -- Police Rancher [`policeold2`] = true, -- Police Roadcruiser [`policet`] = true, -- Police Transporter [`policeb`] = true, -- Police Bike [`polmav`] = true, -- Police Maverick [`fbi`] = true, -- FIB Buffalo [`fbi2`] = true, -- FIB Granger [`polgauntlet`] = true, -- Gaunlet Interceptor [`police5`] = true, -- Impaler SZ Cruiser [`polimpaler5`] = true, -- Impaler LX Cruiser [`polimpaler6`] = true, -- Impaler LX Cruiser [`poldominator10`] = true, -- Dominator FX Interceptor [`polgreenwood`] = true, -- Greenwood Cruiser [`poldorado`] = true, -- Dorado Cruiser [`predator`] = true, -- Police Boat (Predator) [`pranger`] = true -- Park Ranger }, EMS = { [`polmav`] = true, -- Police Maverick (Shows up with EMS liveries too, I'd recommend using something more specific and disabling this.) [`ambulance`] = true, -- Ambulance [`firetruk`] = true, -- Fire Truck [`lguard`] = true, -- Lifeguard [`seashark2`] = true, -- Seashark Lifeguard } }, CustomSeatbelt = false, Seatbelt = function() -- custom seatbelt code here end, CustomHarness = false, Harness = function() -- custom harness code here end, CustomNitrous = false, Nitrous = function() -- custom nitrous code here -- return { -- level = 0, -- hasNitrous = false -- } end, CustomCruise = false, Cruise = function() -- custom cruise code here end }, Notifications = { Enabled = true, -- Show notifications on the HUD. Type = 'default', -- 'default', 'framework' or 'custom' Announcements = 'default', -- 'default' or 'custom' OnQBCoreDefaultDispatchMessageNotification = function(data) -- Add your own handler logic for framework dispatch messages on QB end, CustomNotify = function(title, text, type, duration, position, style) -- Add your own custom notification logic here and set Config.Features.Notifications.Type to 'custom'. end, CustomAnnounce = function(title, text, duration) -- Add your own custom notification logic here and set Config.Features.Notifications.Announcements to custom end, }, ProgressBar = { Enabled = true, useRadial = false, }, Chat = { Enabled = true, -- See Config.Chat.lua for customization options. } }
Chat Configuration
Default Chat Configuration
beyond_hud/config/config.chat.lua
--[[ ██████╗ ███████╗██╗ ██╗ ██████╗ ███╗ ██╗██████╗ ██╔══██╗██╔════╝╚██╗ ██╔╝██╔═══██╗████╗ ██║██╔══██╗ ██████╔╝█████╗ ╚████╔╝ ██║ ██║██╔██╗ ██║██║ ██║ ██╔══██╗██╔══╝ ╚██╔╝ ██║ ██║██║╚██╗██║██║ ██║ ██████╔╝███████╗ ██║ ╚██████╔╝██║ ╚████║██████╔╝ ╚═════╝ ╚══════╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝╚═════╝ Join our Discord for support! https://discord.gg/beyond ]] -- Config.Chats = { Type = 'Modes', -- Default, Commmand-Only, Modes } Config.Chats.Default = { commandNameColor = 'white', chatNameColor = 'white', playerNameColor = 'white', textColor = 'white', badgeTextColor = 'black', style = "" } Config.Chats.ProximityChatCommands = { -- Prevents all messages going to everyone and only allows it by the /everyone command Enabled = true, -- Say (Default), Shout, Everyone (Disable below, if wanted) DefaultMessageRange = 10.0, -- Default Message Range without any command (Say) EveryoneCommand = true, -- (Auto-disabled if Modes on and ALL Channel is active) EveryoneCommandColor = 'purple', ShoutCommandRange = 20.0, ShoutCommandColor = 'orange' } Config.Chats.Commands = { -- Custom commands that create message types tweet = { description = 'Send a tweet to the sky.', help = { '/tweet [message]' }, requiredArgs = { message = 'What\'s on your mind?' }, commandNameColor = 'lightblue', playerNameColor = 'white', playerNamePrefix = '@', textColor = 'white', showCommandName = false, -- Show the command name in the message toSender = true, -- Only send to the player who sent the message style = "background-color: blue; padding: 10px;", callback = function(source, args) -- code here end, }, } Config.Chats.Modes = { Channels = { -- All Caps for Channel Name ALL = true, -- Default ALL Channel, disable if you only want to allow job or ace permission based channels. OOC = { description = 'Out of character chat.', chatNameColor = 'gray', playerNameColor = 'gray', textColor = 'gray', badgeTextColor = 'white', logToAdmins = true }, ADMIN = { description = 'Admin chat.', chatNameColor = 'red', playerNameColor = 'red', textColor = 'red', badgeTextColor = 'white', permissions = { 'admin', 'god' } }, LOCAL = { description = 'Local area chat.', chatNameColor = 'green', playerNameColor = 'green', textColor = 'green', badgeTextColor = 'white', logToAdmins = true, proximity = 100.0, style = "background-color: black; padding: 10px;" }, POLICE = { description = 'Police comms.', chatNameColor = 'blue', -- HTML Color Names, rgb or hex values playerNameColor = 'blue', textColor = 'blue', badgeTextColor = 'white', proximity = 10.0, -- Determines messages are sent to matching players with proper permissions. permissions = 'police', jobLocked = true, -- Determines whether to use ace perms or jobs onDutyRequired = true, -- Only on duty have access to this channel }, EMS = { description = 'EMS comms.', chatNameColor = 'red', playerNameColor = 'red', textColor = 'red', badgeTextColor = 'white', proximity = 10.0, permissions = 'ambulance', jobLocked = true -- Determines whether to use ace perms or jobs }, EMERGENCY = { description = 'Police and EMS comms.', chatNameColor = 'red', playerNameColor = 'red', textColor = 'red', badgeTextColor = 'white', proximity = 10.0, permissions = { 'police', 'ambulance' }, jobLocked = true } -- JOBNAME = { -- description = 'A very cool job chat.', -- color = '#ffd10d', -- proximity = 10.0, -- permissions = 'emergency', -- jobLocked = true -- logToAdmins = true, -- }, } } Config.Chats.Spam = { Block = false, -- default is false Timeframe = 1, -- Time in seconds to reset spam count Limit = 3, -- Number of messages allowed within the timeframe before timeout TimeoutDuration = 30, -- Duration of timeout in seconds WarningMessage = "You have been temporarily timed out from chat due to spamming." } Config.Chats.Filters = { Enabled = true, Replaces = { Enabled = true, words = { badword = "goodword", anotherbadword = "anothergoodword", -- Add more word replacements here } }, Prevents = { Enabled = true, words = { "verybadword", "extremelybadword", -- Add more words to prevent here } } }