RX HUD V1 Configuration

RX HUD V1 keeps its behaviour in config.lua. Every element has its own toggle, so start from the defaults and switch off only the parts your server already draws elsewhere.

Restart the resource after changing the configuration so every connected client receives the same values.

Display elements

Each element can be shown or hidden independently. Disabling one does not affect the layout of the others.

Config.ShowHealth = true
Config.ShowArmor = true
Config.ShowMic = true
Config.ShowHunger = true
Config.ShowThirst = true
Config.ShowSpeedometer = true
Config.ShowTime = true
Config.ShowDate = true

Turn off ShowHunger and ShowThirst on servers that do not use needs, otherwise the bars sit at a fixed value and take up space without informing the player. Disable ShowMic if your voice resource already draws its own indicator.

Update interval

UpdateInterval decides how often the HUD reads player and vehicle state.

Config.UpdateInterval = 1000

The default of one second is tuned for low CPU cost. Lower it if the speedometer feels sluggish on your server, but keep in mind that every element updates on this same interval.

Colours

Config.Colors sets the colour of each bar and the microphone indicator. Values are hex strings.

Config.Colors = {
    health = '#ff0000',
    armor = '#0066ff',
    hunger = '#ff9900',
    thirst = '#00ccff',
    mic = '#ffffff'
}

Keep the bars visually distinct from each other. Colours that sit close together are hard to separate at a glance, which defeats the purpose of a compact HUD.

Status warnings

Warnings draw attention to a value once it drops below its threshold. Each threshold is a percentage.

Config.LowHealthThreshold = 20
Config.LowHungerThreshold = 20
Config.LowThirstThreshold = 20

Set the needs thresholds against how quickly your framework drains hunger and thirst. A warning at 20 is only useful if it leaves the player enough time to reach food or water.

Speedometer

Config.SpeedometerUnit = 'mph'
Config.MaxSpeed = 200

MaxSpeed is a visual limit for the gauge, not a speed restriction on the vehicle. Set it slightly above the top speed of your fastest common vehicle so the gauge rarely pins.

Fuel

FuelScript tells the HUD where to read the fuel level from. Pick the option that matches the fuel resource already running on your server.

Config.FuelScript = 'default'
Config.CustomFuelFunction = nil

The named fuel resource must start before RX HUD V1. When using 'custom', set CustomFuelFunction to the name of a global function that returns the fuel level:

Config.FuelScript = 'custom'
Config.CustomFuelFunction = 'GetMyFuelLevel'

Leave CustomFuelFunction as nil for every option other than 'custom'.

Minimap

Config.MinimapSettings controls whether the minimap is drawn, which shape it uses, and where it sits.

Config.MinimapSettings = {
    enabled = true,
    inVehicleOnly = true,
    style = 'circle',
    bigmap = false,
    zoom = 0.3
}

inVehicleOnly is the usual choice for roleplay servers because it keeps the map out of the way on foot. Turn it off if players navigate on foot regularly.

Size

Width and height apply only when style is "default". The circle and square styles use their own fixed proportions.

Config.MinimapSettings.width = 0.22
Config.MinimapSettings.height = 0.28

Position

Alignment applies only to the "default" style, while the offsets apply to every style.

Config.MinimapSettings.position = {
    alignRight = false,
    alignBottom = true,
    offsetX = 0.00,
    offsetY = 0.00
}

Use small offset steps. These values are screen-relative, so even 0.02 moves the minimap noticeably. Check the result at more than one resolution before publishing it.

Cinematic mode

CinematicHeight sets the height of the black bars drawn in cinematic mode.

CinematicHeight = 0.2

CinematicHeight is a plain global variable, not a key on Config. Keep it at the bottom of config.lua and do not rename it to Config.CinematicHeight, or cinematic mode will fall back to its internal default.

The value is a screen-height fraction, so 0.2 gives bars covering the top and bottom fifth of the screen.

Debug mode

Config.DebugMode = false

Keep debug disabled in production. Enable it temporarily while diagnosing a fuel integration, a status value that never updates, or a minimap that does not appear, then turn it off again to keep console output useful.