Britannia_HUD

Overview

Britannia_HUD is a complete HUD and needs system in one script.

• Gold rings or gold bars, the player's choice: health and stamina cores (they glow gold with tonics, as in the story), hunger, thirst, temperature, stress, alcohol, the horse's cores while riding, cash, gold, the game clock, a player level, voice range and a round compass.
• /hud, each player's own HUD: drag every element anywhere on the screen, click one to give it its own colours (presets or any colour), pick rings or bars, a colour for the whole HUD, opacity and size, choose what shows, and the map on foot and on horseback (small, medium, large, compass or off). The menu itself moves too. Saved per character.
• Needs: hunger and thirst drain over time, faster when running and (thirst) when hot; the inner cores fill when fed and empty when starving; body temperature from the weather and what the player wears; stress from gunfire and fist fights; alcohol wears off, with a drunk walk and screen effect. Hunger or thirst at zero hurts.
• Stamina and health speeds: how fast the player's and the horse's stamina drains and comes back, and how fast health comes back, set in the config.
• Food and drink: every item in shared/consumables.lua becomes usable, with the game's own eating and drinking animations, gold cores, drunk and screen effects, items given back (bottles, cans, broken glass), items with several uses, items that need another (matches to smoke) and horse feed, brushes and injections.
• Player level: XP for time played (20 XP every 5 minutes by default), a new level every 1000 XP, shown as a ring; staff and other scripts can give XP.
• Voice range: the range bars light up for the range you're on and turn green while you talk (pma-voice).
• Turn anything off for the whole server in the config (it then leaves the /hud menu too); players hide the rest for themselves.
• Staff tools in the free Land Office (/britannia): every setting and the whole food and drink list, edited in game.
• English, Spanish and French.

The Lua is encrypted by Cfx.re; the settings, the food and drink list and the text stay editable.

Requirements

• poggy_core (free), version 0.14.0 or newer.
• oxmysql.
• One of VORP, RSG Core or QBCore RedM (poggy_core connects the script to it).
• pma-voice, only for the voice range readout.
• Optional: Land Office (settings in game) and Notifications.

Install

1. Put the Britannia_HUD folder in your resources.
2. Add ensure Britannia_HUD to server.cfg, after ensure oxmysql and ensure poggy_core.
3. Turn off any other HUD or needs script: two would fight over the same needs and the screen.
4. Add the items (below), then restart the server. The table britannia_hud is created on the first start.

Items

SQL.sql (VORP) and installation/items_rsg_qbcore.txt (RSG Core / QBCore RedM) add the starter food, drink and medicine items in shared/consumables.lua and what they give back. To use your own items, add them to shared/consumables.lua (the fields are explained at the top of the file); an item must exist in your inventory's items list to be used.

Configuration

Everything is in shared/config.lua, with a comment on each option, and in the Land Office.

Commands and permissions

Staff = the britannia_hud.admin ace or a poggy_core admin.

Exports for other scripts. Client: exports.Britannia_HUD:AddStatus(name, amount), SetStatus(name, value), GetStatus(name), Hide(), Show(), Heal(), GetXP(), GetLevel() (name = hunger, thirst, stress or alcohol). Server: Heal(source), AddXP(source, amount), GetXP(source), GetLevel(source).

How it works

The HUD draws five times a second from the player's own game. Needs are worked out on the player's game and saved to the server every minute and when they leave; settings are saved when the player presses Save in /hud. Using a food item asks the server first: the item is taken there before the player gets anything from it. XP and levels are kept by the server.

Troubleshooting

Food and drink do nothing. The item must be in shared/consumables.lua and in your items list as usable. Check nothing else registers the same item.

Two HUDs on screen. Turn off your old HUD or needs script.

The map won't change size. Another script sets the map: set Config.MapControl = false to leave it to that script, or turn that script's map setting off.

Voice bars don't move. Check Config.Voice.Ranges matches your pma-voice ranges, and that pma-voice is running.

The level ring doesn't show. Check Config.Elements.level = true, and that the player hasn't hidden it in /hud.

Version history

• 1.0.0: first release.