Installation
📋 Requirements
| Resource | |
|---|---|
| oxmysql | Required |
RSG: rsg-core and rsg-inventory | Optional |
VORP: vorp_core and vorp_inventory | Optional |
The framework is detected automatically (Config.Framework = 'auto'). You can force it with 'rsg', 'vorp' or 'standalone'.
🚀 Installing
- Drop the
kartik-hudfolder into your resources. - Start it after oxmysql, your framework and your inventory in
server.cfg:
ensure oxmysql
ensure rsg-core # or vorp_core
ensure rsg-inventory # or vorp_inventory
ensure kartik-hud- Restart your server.
Stop your old HUD and metabolism scripts (rsg-hud, vorp_metabolism, or another paid HUD). Two HUDs fighting over the same cores will flicker and drain needs twice.
💾 Database
Nothing to import. The kartik_hud table is created on the first start. It holds each character's needs and HUD settings, plus the server default layout.
🍖 Needs on RSG
On RSG, hunger and thirst stay in the framework's player metadata by default (Config.Needs.source = 'auto'), so other RSG scripts that feed players keep working. Food and drinks from kartik-hud update the same values.
If you want kartik-hud to own every need instead, set Config.Needs.source = 'hud' and turn off the hunger and thirst drain in your rsg-core config.
🎒 Items
Every item in shared/consumables.lua that exists in your items list becomes usable on start. Items you don't have are skipped, so nothing breaks. Add the ones you want to your framework's items list, or rename the entries to match the items you already use.
With Config.Debug = true the console lists the consumables that aren't in your items list.