RKL UI

This item is free.

RKL UI RKL UI RKL UI
  • RKL UI
  • RKL UI
  • RKL UI

Description

⚔️ RKL VITALS HUD – Fantasy Health & Mana Orbs ⚔️

A fully animated, fantasy-style vitals HUD for your RPG server. Two hand-crafted orbs in gilded frames hold living liquid that moves, reacts and glows: health on the left, mana on the right. Players can even choose what their mana looks like.

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

✨ FEATURES

🔴 Health Orb
• Crimson orb with a dragon-wing frame and a jewelled crown
• Moving liquid with waves, bubbles and a slow inner swirl
• Damage trail: a pale shadow drains slowly after each hit
• Flash and shake when you get hit, rising glow when you heal
• Low-health heartbeat pulse
• Turns grey when you die

🔵 Mana Orb – 8 Mana Essences (players pick their own!)
• Arcane – sapphire mana with a turning magic sigil
• Frost – glacial mana with falling snow
• Ember – molten mana with rising sparks
• Verdant – forest sap with drifting leaves
• Shadow – void mana with curling smoke
• Radiant – holy light with turning sun rays
• Storm – charged mana with lightning strikes
• Tide – deep-sea mana with dancing light
• Feather-wing frame with a crescent moon and star gem
• Rune ring that slowly turns around the orb
• Spark burst when mana is spent, glow when it regenerates
• Rune flicker when mana runs low
• "Not enough mana" warning your spell scripts can trigger

🛡️ 5 Frame Metals
Gilded Gold • Silver • Obsidian • Bronze • Elven Jade

⚡ More on screen
• Stamina rail joining the two orbs (turns into a breath bar underwater)
• Hunger & thirst gems (esx_status) that pulse when low
• Player ID plaque
• Smooth counting numbers: value, percent, both, or hidden
• Hides automatically in the pause menu

📜 In-game Settings Panel (/hudsettings)
Every player can customise their own HUD in a fantasy grimoire menu:
• Choose mana essence and frame metal
• Size, distance from centre and height sliders
• Number style
• Show/hide hunger & thirst, stamina rail and player ID
• Full or Lite effects (Lite = for low-end PCs)
• Changes preview live and are saved per player

🛠️ For Server Owners
• Everything is set in config.lua: colours, layout, texts, options
• Add your own mana essences with your own colours
• Lock any option so players can't change it
• Force a mana type per class/job through exports
• The orbs never overlap your skill bar (set the free space in config)
• Scales to any resolution
• Lightweight: only changed values are sent to the UI
• Own UI, no ox_lib / ESX menus
• English + Tagalog included, easy to add more languages
• Use armour as mana (default) or feed your own mana system

🧘 Extras
• /rest – sit down and slowly regenerate HP and mana
• Health and mana are saved on logout and restored on join
• Skill-tree regen support (health + mana regen events)

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

⌨️ COMMANDS

/hudsettings – open the HUD settings panel
/healthhud   – show / hide the HUD
/rest        – sit and regenerate HP / mana (use again to stand)

All command names can be changed in config.lua.
Optional default key for the settings panel: Config.Settings.Key

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

🔌 EXPORTS (client)

exports.rklui:SetManaType('frost')         -- change the player's mana essence
exports.rklui:SetManaType('frost', true)   -- force + lock it (e.g. per class)
exports.rklui:SetManaType(nil)             -- release a locked essence
exports.rklui:GetManaType()                -- returns the current essence id
exports.rklui:ManaFail()                   -- "Not enough mana" warning + shake
exports.rklui:ManaSpent()                  -- mana spend flash
exports.rklui:SetMana(current, max)        -- for custom mana systems (Config.Mana.Source = 'custom')
exports.rklui:SetHudVisible(false)         -- hide / show the HUD (cutscenes, menus)
exports.rklui:OpenSettings()               -- open the settings panel
exports.rklui:isSitting()                  -- true while the player is resting

📡 EVENTS (client)

TriggerEvent('rklui:setManaType', 'storm', true)
TriggerEvent('rklui:setMana', current, max)
TriggerEvent('rklui:manaFail')
TriggerEvent('rklui:gethealth', amount)      -- health regen per tick
TriggerEvent('rklui:getmanaregen', amount)   -- mana regen per tick

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

📦 REQUIREMENTS
• ESX (es_extended)
• ox_lib
• esx_status (for hunger & thirst)

📥 INSTALLATION
1. Drop rklui into your resources folder
2. Add "ensure rklui" to your server.cfg (after es_extended and ox_lib)
3. Adjust config.lua to your liking
4. Restart your server – done!