Benite UI Config

Config = {} -- Do not touch this line, duh🤦‍♂️

--
-- GENERAL CONFIG
-- Miscellaneous top-level options
-- 🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪

  ---The FiveM framework to use. Options are: 'esx', 'qbcore', 'custom'.
  ---NOTE: If you choose 'custom', you will need to implement your own framework implementations. See '/client/custom.lua'.
    ---Default: 'esx'
    ---@type SupportedFramework
  Config.framework = 'esx'

  ---Supported languages for the UI.
  ---These must respectively match the name of a JSON file in the 'languages' folder.
    ---Default: { ['da'] = true, ['de'] = true, ['en'] = true, ['es'] = true, ['fr'] = true }
    ---@enum (key) SupportedLanguage
  Config.supportedLanguages = {
    ['da'] = true,
    ['de'] = true,
    ['en'] = true,
    ['es'] = true,
    ['fr'] = true,
  }

  ---The language to use for the UI. Default options are: 'en', 'da'.
  ---This can easily be extended by adding more JSON files to the 'languages' folder.
  ---Remember to add the language to the 'supportedLanguages' array above.
    ---Default: 'en'
    ---@type SupportedLanguage
  Config.language = 'en'



--
-- PERSONALISATION CONFIG
-- Options related to the personalisation of the UI (colour etc.)
-- 🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦

  ---Primary UI colour.
    ---Default: { 8, 244, 192 }
    ---@type RGBColor
  Config.primaryColor = { 8, 244, 192 }

  ---Secondary UI colour.
    ---Default: { 24, 34, 40 }
    ---@type RGBColor
  Config.secondaryColor = { 24, 34, 40 }

  ---Minimap vertical alignment. Options are: 'top', 'bottom'.
    ---Default: 'top'
    ---@type MinimapVerticalAlignment
  Config.minimapVerticalAlignment = 'top'

  ---Allow user customisation of certain UI elements.
    ---Default: true
    ---@type boolean
  Config.allowCustomisation = true

  ---Disallowed customisation options
  ---Valid options are: 'language', 'primaryColor', 'secondaryColor', 'unitSystem', 'minimapVerticalAlignment', 'showFuel', 'showIndicators', 'speedoRumble'
    ---Default: { 'primaryColor', 'secondaryColor' }
    ---@type PersonalUIConfigOption[]
  Config.disallowedCustomisationOptions = {
    'primaryColor',
    'secondaryColor',
  }



--
-- SPEEDOMETER CONFIG
-- Options related to the speedometer
-- 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩

  ---The unit system to use. Options are: 'metric', 'imperial'.
    ---Default: 'metric'
    ---@type SupportedUnitSystem
  Config.unitSystem = 'metric'

  ---Show fuel level on the speedometer.
    ---Default: true
    ---@type boolean
  Config.showFuel = true

  ---Show turn signals on the speedometer.
    ---Default: true
    ---@type boolean
  Config.showIndicators = true

  ---The speed at which the player is considered to be speeding.
  ---This affects things such as when the speedometer will start rumbling.
  ---Set this value to -1 (or any negative number) to disable speeding checks -
  ---this will disable rumbling effects etc.
  ---NOTE: This value is in metres/second regardless of above unit system.
    ---Default: 54
    ---@type number
  Config.speedingLimit = 54



--
-- ESX CONFIG
-- Settings related to the ESX framework - Ignore if not using the ESX framework
-- 🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨

  ---The name of the ESX hunger stat.
    ---Default: 'hunger'
    ---@type string
  Config.hungerStatName = 'hunger'

  ---The name of the ESX thirst stat.
    ---Default: 'thirst'
    ---@type string
  Config.thirstStatName = 'thirst'



--
-- STATUS CONFIG
-- Options related to the status display on the bottom left of the screen
-- 🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧

  ---Display hunger/thirst UI elements.
    ---Default: true
    ---@type boolean
  Config.enableNeeds = true



--
-- ADVANCED CONFIG
-- Do not change unless you know what you are doing!
-- 🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥

  ---The refresh rate of certain tick-dependent UI elements (e.g. stamina, heading, speedometer) in milliseconds.
  ---The lower the value, the more accurate the UI will be, but the more resources it will consume.
    ---Default: 150ms
    ---@type number
  Config.refreshRate = 150

  ---The minimum number of degrees of heading change to trigger a heading update.
  ---The lower the value, the more accurate the UI will be, but the more resources it will consume.
    ---Default: 5.0
    ---@type number
  Config.headingThreshold = 5.0

  ---The minimum distance the player must move to trigger a location update.
  ---The lower the value, the more accurate the UI will be, but the more resources it will consume.
    ---Default: 5.0
    ---@type number
  Config.locationThreshold = 5.0

  ---The minimum change in stamina to trigger a stamina update.
  ---The lower the value, the more accurate the UI will be, but the more resources it will consume.
    ---Default: 0.005
    ---@type number
  Config.staminaThreshold = 0.005