🎯 FX-HUD

Advanced RedM HUD system with metabolism, XP/Level system, consumables, temperature effects, armour system, and full framework compatibility.

---

📦 INSTALLATION

ensure fx-hud

• Place the script inside resources/fx-hud • Add ensure fx-hud to your server.cfg • Restart your server • Make sure oxmysql is started before this script

---

⚙️ DEPENDENCIES

oxmysql (Required)

• Used for database communication • Script will not work without it • You can use tools like HeidiSQL or phpMyAdmin to manage your database

---

🗄️ SQL INSTALLATION

CREATE TABLE IF NOT EXISTS `fx_hud` (
  `charid` varchar(50),
  `health` int DEFAULT 1,
  `stamina` int DEFAULT 1,
  `corehealth` int DEFAULT 1,
  `corestamina` int DEFAULT 1,
  `hunger` int DEFAULT 1,
  `thirst` int DEFAULT 1,
  `stress` int DEFAULT 1,
  `armour` int DEFAULT 0,
  `xp` int DEFAULT 1,
  `level` int DEFAULT 1,
  `settings` longtext DEFAULT '{}'
);

• Stores all player HUD data • Uses charid as unique identifier • Required for XP, level, and status system

---

⚙️ BASIC CONFIG

Config.Language = "en"

• Defines system language • Used for all UI and notifications

---

🎨 HUD COLOR SYSTEM

Config.currentHudColorData = {
    ["#health-core"] = "#ffffff",
    ["#stamina-core"] = "#ffffff",
}

• Controls HUD colors • Core and progress bars are independent • Uses SVG filter system

---

👁️ HUD VISIBILITY SYSTEM

Config.HideHuds = {
    cash = false,
    gold = false,
    logo = false,
    hour = false,
    id = false,
    locations = false,

    level = false,
    dirty = false,
    stress = false,
    pvp = false,
    armour = false,
    alcohol = false,
    temp = false,
    onesync = false,
}

• Allows you to hide specific HUD elements • Set value to true → element will be hidden • Set value to false → element will be visible

• STATS → cash, gold, logo, hour, id, locations • HUD → level, dirty, stress, pvp, armour, alcohol, temp, onesync

• Works instantly without restarting HUD system • Useful for minimal UI setups or server-specific customization

---

📐 HUD POSITION SYSTEM

Config.currentHudPositionData = {
    ["1920x1080"] = generateHudLayout(...)
}

• Resolution-based layout system • Fully draggable HUD elements • Saved per player

---

🛡️ ARMOUR SYSTEM

Config.ArmourSettings = {
    maxArmour = 600,
    useArmourClothing = true,
}

• Adds armour support to HUD • Integrates with clothing system • Automatically updates HUD

---

🔊 VOICE SYSTEM

Config.VoiceChat = "pma-voice"

• Supports pma-voice / saltychat • Displays voice range in HUD • Automatically syncs speaking state

---

📊 LEVEL & XP SYSTEM

Config.Levels = {
    [1] = 1000,
    [2] = 2000,
}

• Defines XP required per level • Unlock system can be based on level • Works with server exports

---

🌡️ TEMPERATURE SYSTEM

Config.Temperature = {
    cold = -15,
    hot = 45,
}

• Dynamic temperature system • Applies effects based on environment • Can affect player stats

---

🍗 METABOLISM SYSTEM

Config.HudSettings = {
    Hunger = {
        decreaseValue = 0.8
    }
}

• Controls hunger, thirst, and stress • Affected by movement and temperature • Can reduce player health over time

---

🍺 CONSUMABLE SYSTEM

Config.Consumables = {
    ["bread"] = {
        hunger = 25,
        animation = "sandwich"
    }
}

• Item-based stat system • Supports usage limits and metadata • Includes animation + prop system

---

🎬 ANIMATION SYSTEM

Config.Animations = {
    ["bandage"] = function(...)
    end
}

• Custom animation per item • Uses native animations and props • Fully synchronized system

---

🔔 NOTIFY SYSTEM

TriggerEvent("fx-hud:client:showNotify", text, time, type)

• Displays custom notifications • type → success / error / warning / info • Fully customizable

---

📡 EXPORTS (CLIENT)

exports['fx-hud']:setStatus("hunger",100)

• Modify player status • Supports hunger, thirst, stress, alcohol • Includes hideHud / showHud functions

---

local xp = exports['fx-hud']:getXP()
local level = exports['fx-hud']:getLevel()

• Returns player XP and level • Used for custom systems

---

📡 EXPORTS (SERVER)

exports['fx-hud']:addXP(source,100)

• Adds XP to player • Works with level system

---

exports['fx-hud']:getLevel(source,function(level)
    print(level)
end)

• Async level fetch • Useful for progression systems

---

⚠️ IMPORTANT NOTES

• oxmysql must be running • Database table must exist • Core values range: 0–600 • Hunger / Thirst range: 0–100 • Armour max: 600

---

🚨 COMMON MISTAKES

• HUD not visible → default UI not disabled • Hunger not updating → missing framework integration • Animations not working → wrong consumable config • Voice not showing → incorrect voice system setting

---

🏁 SUMMARY

FX-HUD provides:

• Full metabolism system • Advanced HUD customization • XP / Level system • Consumable system • Temperature system • Armour integration • Framework compatibility

---

© Fixitfy Development