HZ Scripts

Configuration

All settings are found in config.lua. This guide explains each section in detail.


General

Config.Locale = 'en'
Config.Debug = false
ParameterTypeDefaultDescription
Localestring'en'Language file from locales/. Supported: en, fr, es, de, pt, it, nl, pl, tr, ru, zh, ja, ko, ar
DebugbooleanfalseEnable detailed logs in console (server + client)

Config.Menu = {
    Command     = 'carmenu',
    Keybind     = 'H',
    Description = 'Open vehicle control panel',
    Align       = 'bottom-center',
    Scale       = 1.0,
}
ParameterTypeDefaultDescription
Commandstring'carmenu'Chat command to toggle the menu
Keybindstring'H'Default key binding (FiveM key mapper — players can rebind)
Descriptionstring'Open vehicle...'Description shown in FiveM key-binding settings
Alignstring'bottom-center'Screen position: top-left, top-center, top-right, bottom-left, bottom-center, bottom-right
Scalefloat1.0UI scale multiplier (0.8 – 1.2)

Feature Toggles

Enable or disable each feature individually. Disabled features are hidden from the menu.

Config.Features = {
    Windows       = true,
    Doors         = true,
    Seats         = true,
    Engine        = true,
    Lights        = true,
    InteriorLight = true,
    Indicators    = true,
    Alarm         = true,
    Convertible   = true,
    Neons         = true,
    CruiseControl = true,
    SpeedLimiter  = true,
    DoorLock      = true,
    Radio         = true,
}
FeatureDescription
WindowsWindow up/down controls
DoorsDoor open/close (driver only)
SeatsChange seat
EngineEngine on/off (driver only)
LightsHeadlights cycle (off → low → high)
InteriorLightInterior light toggle
IndicatorsLeft/right turn signals
AlarmHazard lights
ConvertibleConvertible roof toggle
NeonsNeon lights toggle
CruiseControlCruise control
SpeedLimiterSpeed limiter
DoorLockLock/unlock doors from inside
RadioGTA V radio control (station switch, off)

Neon Lights

Config.Neons = {
    AllowColorChange = true,
    SaveColor = true,
    Presets = {
        { r = 255, g = 0,   b = 0,   label = 'Red' },
        { r = 0,   g = 0,   b = 255, label = 'Blue' },
        { r = 0,   g = 255, b = 0,   label = 'Green' },
        { r = 255, g = 255, b = 255, label = 'White' },
        { r = 128, g = 0,   b = 255, label = 'Purple' },
        { r = 255, g = 255, b = 0,   label = 'Yellow' },
        { r = 0,   g = 255, b = 255, label = 'Cyan' },
        { r = 255, g = 128, b = 0,   label = 'Orange' },
        { r = 255, g = 0,   b = 128, label = 'Pink' },
    },
}
ParameterTypeDefaultDescription
AllowColorChangebooleantrueLet players choose the neon RGB color from the menu
SaveColorbooleantrueSave the chosen color per vehicle plate (requires oxmysql)
Presetstable9 colorsPreset color swatches shown in the picker
Players can also use a custom color picker (HTML input) in addition to the preset swatches.

Radio

Config.Radio = {
    DisableWheel = true,
}
ParameterTypeDefaultDescription
DisableWheelbooleantrueDisable the native GTA V radio wheel so players use the CarControl radio panel instead

Cruise Control

Config.CruiseControl = {
    Enabled            = true,
    Keybind            = 'K',
    MinSpeed           = 20,
    SpeedStep          = 5,
    DisableOnBrake     = true,
    DisableOnCollision = true,
    ShowHUD            = true,
}
ParameterTypeDefaultDescription
EnabledbooleantrueEnable cruise control feature
Keybindstring'K'Direct keybind (without opening the menu)
MinSpeedinteger20Minimum speed required to activate (km/h)
SpeedStepinteger5Speed adjustment step when pressing +/- (km/h)
DisableOnBrakebooleantrueAutomatically disengage when the player brakes
DisableOnCollisionbooleantrueAutomatically disengage on collision
ShowHUDbooleantrueShow the cruise speed indicator in the NUI header
The cruise control keybind can be changed by players in the FiveM key-binding settings.

Speed Limiter

Config.SpeedLimiter = {
    Enabled = true,
    Presets = { 30, 50, 80, 110, 130 },
}
ParameterTypeDefaultDescription
EnabledbooleantrueEnable speed limiter feature
Presetstable{ 30, 50, 80, 110, 130 }Preset speeds to cycle through (km/h). The limiter cycles: preset1 → preset2 → … → off

Door Lock

Config.DoorLock = {
    Enabled       = true,
    Keybind       = 'U',
    KeysResource  = 'auto',
    SyncToPlayers = true,
}
ParameterTypeDefaultDescription
EnabledbooleantrueEnable door lock feature
Keybindstring'U'Direct keybind (without opening the menu)
KeysResourcestring'auto'Vehicle keys resource: 'auto' (detect), 'qbx_vehiclekeys', 'qb-vehiclekeys', 'native'
SyncToPlayersbooleantrueSync lock state to nearby players via StateBag (only used with 'native' mode)
When set to 'auto', the script will detect qbx_vehiclekeys or qb-vehiclekeys automatically. If neither is found, it falls back to GTA native lock.

Keybinds

Direct keybinds that work without opening the menu. Set a key to '' (empty string) to disable.

Config.Keybinds = {
    IndicatorLeft  = 'LEFT',
    IndicatorRight = 'RIGHT',
    HazardLights   = '',
}
ParameterTypeDefaultDescription
IndicatorLeftstring'LEFT'Left turn signal
IndicatorRightstring'RIGHT'Right turn signal
HazardLightsstring''Hazard lights (disabled by default)

Auto-Close

Config.AutoClose = true

Close the menu automatically when the player exits the vehicle.


Sounds

Config.Sounds = {
    Enabled         = true,
    UseCustomSounds = true,
    Volume          = 0.5,
}
ParameterTypeDefaultDescription
EnabledbooleantrueMaster toggle for all sounds
UseCustomSoundsbooleantrueUse custom .ogg files in html/sounds/ instead of native GTA sounds
Volumefloat0.5Volume for custom sounds (0.0 – 1.0)

Notifications

Config.Notifications = {
    Enabled = true,
    Type    = 'framework',
}
ParameterTypeDefaultDescription
EnabledbooleantrueMaster toggle for all notifications
Typestring'framework'Notification system: 'framework' (QBCore/ESX), 'chat' (FiveM chat), 'native' (GTA V)

Permissions

Config.Permissions = {
    Enabled       = false,
    AcePermission = '',
}
ParameterTypeDefaultDescription
EnabledbooleanfalseEnable server-side permission checks
AcePermissionstring''Ace permission required to use the menu. Leave empty to allow everyone when Enabled = true
When Enabled = false (default), all players can use the menu. Enable this only if you want to restrict access via FiveM ace permissions.

After modifying config.lua, restart the script with ensure HZ-CarControl or restart the server.