Configuration Guide

Configure HUD modules, system parameters, and themes in config.lua and presets.lua.

Global Toggles

Enable or disable specific HUD modules inside config.lua:

Config.UseChat = true
Config.UsePartyFrame = true
Config.UseCrosshair = true
Config.UseSeatBelt = false -- Set to false to use an external seatbelt script
Config.UsePoliceRadar = true
Config.UseCustomizer = true -- Enables player /hud menu access
Config.CommunityName = 'Server Name' -- Displays in /hud header

• Native GTA ammo, vehicle, and street displays toggle under GTA default UI settings.

Stress System

Configure stress multipliers and exempt classes under Config.Stress:

-- Job stress multipliers (0.0 = none, 2.0 = double)
Config.Stress.JobStressMultiplier = {
    police = 0.3,
    ambulance = 0.0,
}

-- Vehicle classes exempt from stress
Config.Stress.NoStressVehicleClass = {
    [14] = true, -- Boats
    [15] = true, -- Helicopters
    [16] = true, -- Planes
}

Seatbelt System

Configure minimum ejection speeds and vehicle exemptions:

• Config.MinSpeedToEjectUnbuckled: Minimum speed required for crash ejection.
• Config.BlacklistedClasses: Vehicle classes exempt from seatbelt mechanics (bicycles, aircraft, boats).

Config.BlacklistedClasses = {8, 13, 14, 15, 16, 21}

Chat Configuration

• Config.ChatSubChannels: Defines channel tabs, colors, and permissions (OOC, Me, Do, 911).
• Config.ChatTemplates: Defines HTML and CSS structure for chat message rendering.

Customizer Permissions

Restrict settings accessible to players in /hud via Config.CustomizerAccess:

• Config.CustomizerAccess.Bulk: Toggles entire categories in the customization menu.
• Config.CustomizerAccess.Single: Restricts specific attributes like shape, width, and height.

Forced UI Overwrites

Enforce server-wide visual styles by uncommenting entries in Config.SettingOverwrite:

statusHud = {
    displayStyle = "icon",
    radius = 4,
    fillStyle = "water",
},

• Uncommenting a setting locks it server-wide over player preferences.
• Commented lines allow individual player customization.

Server Presets

Define custom selectable UI themes in presets.lua:

table.insert(Config.ServerPresets, {
    id = "cyberpunk_theme",
    name = "Cyberpunk Neon",
    hudItems = {
        minimap = {
            minimapShape = "squaremap"
        },
        minimapRing = {
            color1 = "#ff00ff"
        },
        health = {
            color1 = "#ff00ff",
            color2 = "#200020",
            fillStyle = "water"
        },
        armor = {
            color1 = "#00ffff",
            color2 = "#002020",
            fillStyle = "water"
        },
        vehicleDigital = {
            speedUnit = "KMH",
            color1 = "#ff00ff"
        }
    }
})

• Presets appear in the /hud theme selector for players.
• Any property from Config.SettingOverwrite can be used in presets.