Skip to content

Configuration

You need to do the following steps to setup BZN Blip Handler.

Open config.lua decide what settings you want to use.

Open client/register_groups.lua remove or edit the 3 default groups, I recommend you keep all your groups in this file, makes it faster to add/remove groups when keeping them in one location, insted of moving them to other scripts.

Config Variable Data Type Optional Default Value Explanation
Config.EnableDebug boolean No true Set to false when you are done integrating to avoid users getting console spam.
Config.BlipHandlerCommand string No 'blipsettings' Change the command to open Blip Handler UI default is /blipsettings.
Config.UseKeyMapping boolean No false You can select if you want to use key mapping for opening Blip Handler UI.
Config.DefaultBlipHandlerKey string No 'U' Default key to open Blip Handler UI.
Config.UseESC boolean No false If you want to use the v1.0.1 feature where the UI opens when you are in the pause map enable this.
Config.ESCWait numeric No 1000 Only change it up not down, this is to avoid issues with the UI not opening up correct.

UseKeyMapping and UseESC can not both be active you have to select one of the options, since ESC requires abit of a different approch, command will not be avalible if using ESC approche.

config.lua

Config = {}

Config.EnableDebug = true -- Set to false when you are done integrating to avoid users getting console spam.

Config.UIPosition = 'left' -- Can be 'left' or 'right'

Config.BlipHandlerCommand = 'blipsettings' -- Change the command to open Blip Handler UI default is /blipsettings.

Config.UseKeyMapping = true -- You can select if you want to use key mapping for opening Blip Handler UI, or just command (if you just want command make sure to disable Config.UseESC)
Config.DefaultBlipHandlerKey = 'U' -- Default key to open Blip Handler UI.

-- Rewritten the ESC integration, now supports P to, it adds an alternative Key mapping to FiveM, and a alternative command, CPU usage for listening for the ESC key is gone, only uses CPU when pause menu is active.
-- Users can map there keys like they want to, if they mapped it to something else then ESC ex. U only U will open the UI, and it wont open when in pause menu, freedome to the user!
Config.UseESC = false
Config.ESCWait = 1000 -- Waiting after button press to check if pause menu is active, this is needed for it to open up correct, since there is a delay from pressing esc, until the native checking for pause screen is changed.

client/register_groups.lua

RegisterBlipGroup('general', 'General', 0.6, 'yes')
RegisterBlipGroup('atm-bank', 'ATM\'s', 0.6, 'yes')
RegisterBlipGroup('gasstations', 'Gas Stations', 0.6, 'yes')