👱SLEEK HUD

Here check the installation guide

INSTALLATION GUIDE

  1. Download from KEYMASTER and Unzip the forge-hud.pack.zip and place this folder in your server's resource folder.

  2. Add the resource to your server start config: ensure forge-hud,the name of the folder must not be changed or the resource will not function correctly.

  3. Delete any other HUD you have. Like the QB or ESX HUD. You must delete them. Only Forge's can remain.

  4. Clear the cache of your server and also of your own FiveM.

  5. Reboot the entire server with the forge script well ensured in your server.cfg.

  6. This script does not have any SQL to install.

  7. Do not rename this script, this may cause it to fail when opening the interface.

IMPORTANT REMEMBER: The HUD cannot be ENSURED within the server (ensure forge-hud cannot be used in F8 or in your chat), as many things will fail.

The HUD can only be reset with a FULL RESET of the server.

CONFIG

The following will explain all the settings, one of the most important things that I recommend you spend a few minutes to understand in order to offer your users the best possible experience.

Fill all the CONFIG very carefully. You can hide and modify many parts of the HUD from here. Look at it very carefully, everything is explained with comments.

Config = Config or {}

--  _____ _____ _   _ ______ _____ _____ _   _______  ___ _____ _____ _____ _   _ 
-- /  __ \  _  | \ | ||  ___|_   _|  __ \ | | | ___ \/ _ \_   _|_   _|  _  | \ | |
-- | /  \/ | | |  \| || |_    | | | |  \/ | | | |_/ / /_\ \| |   | | | | | |  \| |
-- | |   | | | | . ` ||  _|   | | | | __| | | |    /|  _  || |   | | | | | | . ` |
-- | \__/\ \_/ / |\  || |    _| |_| |_\ \ |_| | |\ \| | | || |  _| |_\ \_/ / |\  |
--  \____/\___/\_| \_/\_|    \___/ \____/\___/\_| \_\_| |_/\_/  \___/ \___/\_| \_/

--WARNING!: The HUD cannot be ensured with the server open, it has to be done with a full server restart, or else some things will not work like the location marker or the connected people marker.

Config.Debug = false -- Use it for debug
Config.Framework = "qb" -- Use "esx" or "qb" - If you use a different framework or a renamed esx/qb in the config_framework you can modify all the functions
Config.Delay = 100 -- Delay in milliseconds for script operations. Higher values reduce consumption but may cause delays. Recommended range: 100-200ms for optimal performance.

Config.ShowTotalPlayers = true -- If you set false, the grid showing how many players are online will disappear.
Config.MaxPlayers = GetConvarInt('sv_maxclients', 32) -- Use it for get max players
Config.KeyChangeCyclePromixity = GetConvar('voice_defaultCycle', 'F11') -- Key for the cycle proximity for pma-voice
Config.UseStaticID = false -- Owners that want to use static id should add their export in config_framework > MAV.Functions.GetStaticId

Config.UseKeyOpen = true -- Set if the hud config can be open with Config.OpenMenu
Config.OpenMenu = 'I' -- See the list : https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/

Config.UseWeaponSystem = true -- If shet to true show the weapon you are using and its bullets. This causes the HUD to increase its consumption when activated, this is normal
Config.UseWeaponImages = true -- If true it will display a PNG image of the weapon along with the bullets, if false it will display just the bullets with nothing else

Config.UseRadarMiniMap = true -- If it is true the minimap will appear and if it is false it will not appear at all
Config.ShowRadarOnlyInVehicle = true -- Show the player radar only if the player is in a car
Config.UseAddressMarker = true -- If it is true the address marker will appear on the screen and if it is false it will not appear at all

Config.UseMPH = false -- Use mp/h with "true" and km/h with "false"
Config.UseLowFuel = true -- If set to true the fuel level is checked

Config.ShowMoneyInHud = true -- Show the cash and bank on the hud
Config.ExtraMoney = { -- Activate it if you want a third money rectangle, for example if you want to show black money, cryptos or anything. You must go to the config_framework to modify the function to your liking.
    Active = false,
    Image = 'wallet.svg' -- The icon to be seen. You will have to add it in the nui > images folder and put the name of the file.
}

Config.ShowGang = true -- ONLY if you use QB - It will show in the HUD the gang and the rank of your character

Config.CustomStress = false -- If you set it to TRUE it will use system stress from esx_status or whatever you put in config_framework.lua
Config.UseStress = true -- Use stress. An internal system created from scratch and optimized
Config.StressChance = 0.1 -- Default: 10% • Percentage stress chance when shooting (0-1)
Config.MinimumStress = 50 -- Minimum stress level for screen shaking
Config.MinimumFuel = 20 -- Under this % of fuel, the player is notify (Config.Notification.FuelIsLow = true) and with sound (Config.Sounds['FUEL'])
Config.MinimumSpeed = 100 -- Going over this speed will cause stress
Config.MinimumSpeedUnbuckled = 80 -- Going over this Speed without seatbelt will cause stress
Config.DisableStressJobs = true -- If true will disable stress for people with the job you choose below
Config.StressWhitelistJobs = { 'police', 'ambulance' } -- You can add all the jobs you want that do not add stress

Config.UseSeatBelt = true -- Seat belt system
Config.UseKeyToggleseatbelt = true -- Set if the seatbelt can be toggled by Config.ToggleSeatbelt
Config.ToggleSeatbelt = 'B' -- See the list : https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/
Config.EjectSpeed = 45.0 -- Minimum speed at which a player can be ejected from a vehicle
Config.EjectAccel = 100.0 -- Minimum acceleration for ejection

Config.Notification = {
    HudIsLoaded = true, -- Show notification when the hud settings is loaded.
    MapIsLoaded = true, -- Show notification when the map is loaded.
    FuelIsLow = true, -- Show notification when the fuel is low.
    GainStress = true, -- Show notification when player gain stress
    Seatblet = true, -- Shows notification when the player puts on or removes the car seat belt.
    CashChange = true, -- Show notification when there is a cash transaction.
    BankChange = true, -- Show notification when there is a bank account change.
    LowHealth = true, -- Show notification when player's health is low.
    LowThirst = true, -- Show notification when player's thirst is low.
    LowHunger = true, -- Show notification when player's hunger is low.
}

Config.Settings = {
    ShowJob = true, -- If set to false, hide the job grid
    ShowHealth = true, -- Show health bar on HUD
    ShowHunger = true, -- Show hunger indicator on HUD
    ShowThirst = true, -- Show thirst indicator on HUD
    ShowArmor = true, -- Show armor indicator on HUD
    ShowOxygen = true, -- Show oxygen level when underwater
    ShowMicroVolume = true, -- Show microphone volume indicator
    ShowSpeedometer = true -- Show speedometer on HUD
}

Config.Commands = { 
    Cinematic = 'cinematic', -- Command to start/stop cinematic mode
    NoHud = 'nohud', -- Command to show / hide the HUD
    ResetHUD = 'resethud', -- Command name to reset the configuration
    Announce = 'announce', -- Command name to launch a announcement
    OpenHUD = 'menu', -- Command name to open the hud configuration
    ZoneTP = 'zone', -- Command to test zone (only available with : Config.Debug = true)
    ToggleSeatbelt = 'toggleseatbelt', -- Command name to toggle seatbelt
}

Config.Sounds = { -- See the list : https://pastebin.com/DCeRiaLJ
    ['BUCKLE'] = {
        Enabled = true,
        AudioName = 'Beep_Red',
        AudioRef = 'DLC_HEIST_HACKING_SNAKE_SOUNDS',
    },
    ['UNBUCKLE'] = {
        Enabled = true,
        AudioName = 'Beep_Red',
        AudioRef = 'DLC_HEIST_HACKING_SNAKE_SOUNDS',
    },
    ['FUEL'] = {
        Enabled = true,
        AudioName = 'Beep_Red',
        AudioRef = 'DLC_HEIST_HACKING_SNAKE_SOUNDS',
    },
    ['ANNOUNCE'] = {
        Enabled = true,
        AudioName = 'CHARACTER_SELECT',
        AudioRef = 'HUD_FRONTEND_DEFAULT_SOUNDSET',
    },
}

Config.Zones = { -- The Safe Zone and Red Zone system will warn you with a sign on the HUD that you are in the Safe Zone and Red Zone. You can add as many as you want
    ['RED'] = {
        {
            coords = vector3(-1852.42, -778.63, 6.75), -- The co-ordinate of the centre of the zone where you want it to be red zone/hot zone.
            radius = 5.0, -- This is the radius, the larger the number, the larger the area.
        },
     -- {
     --     coords = vector3(-1852.42, -778.63, 6.75), -- The co-ordinate of the centre of the zone where you want it to be red zone/hot zone.
     --     radius = 5.0, -- This is the radius, the larger the number, the larger the area.
     -- },
    },
    ['SAFE'] = {
        {
            coords = vector3(-1871.06, -724.59, 8.3),
            radius = 5.0,
        },
     --  {
     --       coords = vector3(-1871.06, -724.59, 8.3),
     --       radius = 5.0,
     --   },
    }
}

Config.Menu = { -- Default HUD display mode for players (options: normal, reduced, minimal)
    isNormal = true,
    isReduced = false,
    isMinimal = false,
    size = 1, -- Default size for HUD elements
    color = "#31afd4" -- Default color for HUD elements

}

Config.Jobs = {  -- Here you have to add all the jobs that will appear in your HUD. This ensures that it appears the way you want it to appear, and it also reduces the HUD consumption by half.
    ['unemployed'] = { [0] = 'Freelancer' },
    ['police'] = { [0] = 'Recruit', [1] = 'Officer', [2] = 'Sergeant', [3] = 'Lieutenant', [4] = 'Chief' },
    ['ambulance'] = { [0] = 'Recruit', [1] = 'Paramedic', [2] = 'Doctor', [3] = 'Surgeon', [4] = 'Chief' },
    ['realestate'] = { [0] = 'Recruit', [1] = 'House Sales', [2] = 'Business Sales', [3] = 'Broker', [4] = 'Manager' },
    ['taxi'] = { [0] = 'Recruit', [1] = 'Driver', [2] = 'Event Driver', [3] = 'Sales', [4] = 'Manager' },
    ['bus'] = { [0] = 'Driver' },
    ['cardealer'] = { [0] = 'Recruit', [1] = 'Showroom Sales', [2] = 'Business Sales', [3] = 'Finance', [4] = 'Manager' },
    ['mechanic'] = { [0] = 'Recruit', [1] = 'Novice', [2] = 'Experienced', [3] = 'Advanced', [4] = 'Manager' },
    ['judge'] = { [0] = 'Judge' },
    ['lawyer'] = { [0] = 'Associate' },
    ['reporter'] = { [0] = 'Journalist' },
    ['trucker'] = { [0] = 'Driver' },
    ['tow'] = { [0] = 'Driver' },
    ['garbage'] = { [0] = 'Collector' },
    ['vineyard'] = { [0] = 'Picker' },
    ['hotdog'] = { [0] = 'Sales' },
    ['firefighter'] = { [0] = 'Recruit', [1] = 'Fire fighter', [2] = 'Lieutenant', [3] = 'Captain', [4] = 'Boss' }
}

Config.WhitelistedWeaponStress = { `weapon_petrolcan`, `weapon_hazardcan`, `weapon_fireextinguisher` } -- List of weapons that do not cause stress when used

Config.EffectInterval = { -- If you activate the use of Stress, there will be a blur effect whenever your character is stressed.
    [1] = { min = 50, max = 60, timeout = math.random(50000, 60000) },
    [2] = { min = 60, max = 70, timeout = math.random(40000, 50000) },
    [3] = { min = 70, max = 80, timeout = math.random(30000, 40000) },
    [4] = { min = 80, max = 90, timeout = math.random(20000, 30000) },
    [5] = { min = 90, max = 100, timeout = math.random(15000, 20000) }
}

Config.Intensity = { -- Configures the intensity of stress effects based on stress level
    ["BLUR"] = {
        [1] = { min = 50, max = 60, intensity = 1500 },
        [2] = { min = 60, max = 70, intensity = 2000 },
        [3] = { min = 70, max = 80, intensity = 2500 },
        [4] = { min = 80, max = 90, intensity = 2700 },
        [5] = { min = 90, max = 100, intensity = 3000 },
    }
}

Config.Cruise = {
    Active = true, -- Toggle the cruise control feature
    Keybind = 'U', -- Keybind to toggle cruise control
    Command = 'cruise' -- Command to toggle cruise control
}

Config.Weapons = { -- These are the images of the weapons, if there are weapons you don't like, you can change them inside the NUI images folder.
    [GetHashKey('WEAPON_UNARMED')] = { 'WEAPON_UNARMED' },
    [GetHashKey('WEAPON_KNIFE')] = { 'WEAPON_KNIFE' },
    [GetHashKey('WEAPON_NIGHTSTICK')] = { 'WEAPON_NIGHTSTICK' },
    [GetHashKey('WEAPON_HAMMER')] = { 'WEAPON_HAMMER' },
    [GetHashKey('WEAPON_BAT')] = { 'WEAPON_BAT' },
    [GetHashKey('WEAPON_GOLFCLUB')] = { 'WEAPON_GOLFCLUB' },
    [GetHashKey('WEAPON_CROWBAR')] = { 'WEAPON_CROWBAR' },
    [GetHashKey('WEAPON_PISTOL')] = { 'WEAPON_PISTOL' },
    [GetHashKey('WEAPON_COMBATPISTOL')] = { 'WEAPON_COMBATPISTOL' },
    [GetHashKey('WEAPON_APPISTOL')] = { 'WEAPON_APPISTOL' },
    [GetHashKey('WEAPON_PISTOL50')] = { 'WEAPON_PISTOL50' },
    [GetHashKey('WEAPON_MICROSMG')] = { 'WEAPON_MICROSMG' },
    [GetHashKey('WEAPON_SMG')] = { 'WEAPON_SMG' },
    [GetHashKey('WEAPON_ASSAULTSMG')] = { 'WEAPON_ASSAULTSMG' },
    [GetHashKey('WEAPON_ASSAULTRIFLE')] = { 'WEAPON_ASSAULTRIFLE' },
    [GetHashKey('WEAPON_CARBINERIFLE')] = { 'WEAPON_CARBINERIFLE' },
    [GetHashKey('WEAPON_ADVANCEDRIFLE')] = { 'WEAPON_ADVANCEDRIFLE' },
    [GetHashKey('WEAPON_MG')] = { 'WEAPON_MG' },
    [GetHashKey('WEAPON_COMBATMG')] = { 'WEAPON_COMBATMG' },
    [GetHashKey('WEAPON_PUMPSHOTGUN')] = { 'WEAPON_PUMPSHOTGUN' },
    [GetHashKey('WEAPON_SAWNOFFSHOTGUN')] = { 'WEAPON_SAWNOFFSHOTGUN' },
    [GetHashKey('WEAPON_ASSAULTSHOTGUN')] = { 'WEAPON_ASSAULTSHOTGUN' },
    [GetHashKey('WEAPON_BULLPUPSHOTGUN')] = { 'WEAPON_BULLPUPSHOTGUN' },
    [GetHashKey('WEAPON_STUNGUN')] = { 'WEAPON_STUNGUN' },
    [GetHashKey('WEAPON_SNIPERRIFLE')] = { 'WEAPON_SNIPERRIFLE' },
    [GetHashKey('WEAPON_HEAVYSNIPER')] = { 'WEAPON_HEAVYSNIPER' },
    [GetHashKey('WEAPON_GRENADELAUNCHER')] = { 'WEAPON_GRENADELAUNCHER' },
    [GetHashKey('WEAPON_GRENADELAUNCHER_SMOKE')] = { 'WEAPON_GRENADELAUNCHER_SMOKE' },
    [GetHashKey('WEAPON_RPG')] = { 'WEAPON_RPG' },
    [GetHashKey('WEAPON_MINIGUN')] = { 'WEAPON_MINIGUN' },
    [GetHashKey('WEAPON_GRENADE')] = { 'WEAPON_GRENADE' },
    [GetHashKey('WEAPON_STICKYBOMB')] = { 'WEAPON_STICKYBOMB' },
    [GetHashKey('WEAPON_SMOKEGRENADE')] = { 'WEAPON_SMOKEGRENADE' },
    [GetHashKey('WEAPON_BZGAS')] = { 'WEAPON_BZGAS' },
    [GetHashKey('WEAPON_MOLOTOV')] = { 'WEAPON_MOLOTOV' },
    [GetHashKey('WEAPON_FIREEXTINGUISHER')] = { 'WEAPON_FIREEXTINGUISHER' },
    [GetHashKey('WEAPON_PETROLCAN')] = { 'WEAPON_PETROLCAN' },
    [GetHashKey('WEAPON_FLARE')] = { 'WEAPON_FLARE' },
    [GetHashKey('WEAPON_SNSPISTOL')] = { 'WEAPON_SNSPISTOL' },
    [GetHashKey('WEAPON_SPECIALCARBINE')] = { 'WEAPON_SPECIALCARBINE' },
    [GetHashKey('WEAPON_HEAVYPISTOL')] = { 'WEAPON_HEAVYPISTOL' },
    [GetHashKey('WEAPON_BULLPUPRIFLE')] = { 'WEAPON_BULLPUPRIFLE' },
    [GetHashKey('WEAPON_HOMINGLAUNCHER')] = { 'WEAPON_HOMINGLAUNCHER' },
    [GetHashKey('WEAPON_PROXMINE')] = { 'WEAPON_PROXMINE' },
    [GetHashKey('WEAPON_SNOWBALL')] = { 'WEAPON_SNOWBALL' },
    [GetHashKey('WEAPON_VINTAGEPISTOL')] = { 'WEAPON_VINTAGEPISTOL' },
    [GetHashKey('WEAPON_DAGGER')] = { 'WEAPON_DAGGER' },
    [GetHashKey('WEAPON_FIREWORK')] = { 'WEAPON_FIREWORK' },
    [GetHashKey('WEAPON_MUSKET')] = { 'WEAPON_MUSKET' },
    [GetHashKey('WEAPON_MARKSMANRIFLE')] = { 'WEAPON_MARKSMANRIFLE' },
    [GetHashKey('WEAPON_HEAVYSHOTGUN')] = { 'WEAPON_HEAVYSHOTGUN' },
    [GetHashKey('WEAPON_GUSENBERG')] = { 'WEAPON_GUSENBERG' },
    [GetHashKey('WEAPON_HATCHET')] = { 'WEAPON_HATCHET' },
    [GetHashKey('WEAPON_RAILGUN')] = { 'WEAPON_RAILGUN' },
    [GetHashKey('WEAPON_COMBATPDW')] = { 'WEAPON_COMBATPDW' },
    [GetHashKey('WEAPON_KNUCKLE')] = { 'WEAPON_KNUCKLE' },
    [GetHashKey('WEAPON_MARKSMANPISTOL')] = { 'WEAPON_MARKSMANPISTOL' },
    [GetHashKey('WEAPON_FLASHLIGHT')] = { 'WEAPON_FLASHLIGHT' },
    [GetHashKey('WEAPON_MACHETE')] = { 'WEAPON_MACHETE' },
    [GetHashKey('WEAPON_MACHINEPISTOL')] = { 'WEAPON_MACHINEPISTOL' },
    [GetHashKey('WEAPON_SWITCHBLADE')] = { 'WEAPON_SWITCHBLADE' },
    [GetHashKey('WEAPON_REVOLVER')] = { 'WEAPON_REVOLVER' },
    [GetHashKey('WEAPON_COMPACTRIFLE')] = { 'WEAPON_COMPACTRIFLE' },
    [GetHashKey('WEAPON_DBSHOTGUN')] = { 'WEAPON_DBSHOTGUN' },
    [GetHashKey('WEAPON_FLAREGUN')] = { 'WEAPON_FLAREGUN' },
    [GetHashKey('WEAPON_AUTOSHOTGUN')] = { 'WEAPON_AUTOSHOTGUN' },
    [GetHashKey('WEAPON_BATTLEAXE')] = { 'WEAPON_BATTLEAXE' },
    [GetHashKey('WEAPON_COMPACTLAUNCHER')] = { 'WEAPON_COMPACTLAUNCHER' },
    [GetHashKey('WEAPON_MINISMG')] = { 'WEAPON_MINISMG' },
    [GetHashKey('WEAPON_PIPEBOMB')] = { 'WEAPON_PIPEBOMB' },
    [GetHashKey('WEAPON_POOLCUE')] = { 'WEAPON_POOLCUE' },
    [GetHashKey('WEAPON_SWEEPER')] = { 'WEAPON_SWEEPER' },
    [GetHashKey('WEAPON_WRENCH')] = { 'WEAPON_WRENCH' },
    [GetHashKey('WEAPON_PISTOL_MK2')] = { 'WEAPON_PISTOL_MK2' },
    [GetHashKey('WEAPON_SNSPISTOL_MK2')] = { 'WEAPON_SNSPISTOL_MK2' },
    [GetHashKey('WEAPON_REVOLVER_MK2')] = { 'WEAPON_REVOLVER_MK2' },
    [GetHashKey('WEAPON_SMG_MK2')] = { 'WEAPON_SMG_MK2' },
    [GetHashKey('WEAPON_PUMPSHOTGUN_MK2')] = { 'WEAPON_PUMPSHOTGUN_MK2' },
    [GetHashKey('WEAPON_ASSAULTRIFLE_MK2')] = { 'WEAPON_ASSAULTRIFLE_MK2' },
    [GetHashKey('WEAPON_CARBINERIFLE_MK2')] = { 'WEAPON_CARBINERIFLE_MK2' },
    [GetHashKey('WEAPON_SPECIALCARBINE_MK2')] = { 'WEAPON_SPECIALCARBINE_MK2' },
    [GetHashKey('WEAPON_BULLPUPRIFLE_MK2')] = { 'WEAPON_BULLPUPRIFLE_MK2' },
    [GetHashKey('WEAPON_COMBATMG_MK2')] = { 'WEAPON_COMBATMG_MK2' },
    [GetHashKey('WEAPON_HEAVYSNIPER_MK2')] = { 'WEAPON_HEAVYSNIPER_MK2' },
    [GetHashKey('WEAPON_MARKSMANRIFLE_MK2')] = { 'WEAPON_MARKSMANRIFLE_MK2' }
}

If you want to edit the aesthetics or design. You have the HTML open so you can modify the style and everything as you want.

The script is RESPONSIVE for all resolutions as well.

PreviousTriggers and ExportsNextCommands

Last updated