Set up the HUD

The HUD is part of the Mechanics module. It puts a speedometer in the corner of the screen while players drive, and a location panel next to the minimap: the compass, the street and cross street, the area, the nearest postal, your AOP and a Peacetime box while peacetime is on, with the date, time and the player's health underneath.

Before you start#

• The HUD is in beta, so it's only switched on for some communities for now. If you'd like to try it, ask us in support.
• The Mechanics module needs to be installed.
• Your game server needs the LonexOne FiveM resource, version 0.10.0 or newer. See Install the LonexOne FiveM resource.
• To change it, you need the Set up the in-game HUD: its design, what it shows and what players can change permission.
• If your server already runs a HUD or a seatbelt resource, stop it or pick the settings below that work with it, so players don't see two.

Pick a design#

1. Click HUD under Mechanics in the sidebar.
2. Click the Design tab. Under Designs, click the one you want. The big preview shows it over a street scene, and its gauges move so you can see them work. Click On foot under the preview to see what players see out of a vehicle.
3. Click Save.

The designs are:

Every design has the same row under the speed: fuel, the trip distance and the warning lights for the seatbelt, the engine, the headlights, the indicators and the handbrake.

In the Street design, the AOP sits in its own box, with a red Peacetime box next to it while peacetime is on. Under them is one panel with the compass point on the left, then the road and cross street with the postal at the end, like Las Lagunas Blvd / Hawick Ave, 7080, and the area underneath. If the road names are too long to fit, the cross street is shortened so the postal always shows.

In the other designs, the AOP and the Peacetime box sit with the area and the postal, under the road.

AOP and peacetime#

The page opens on the Live tab, which shows your AOP and whether peacetime is on. Type a new AOP and click Save, or click one of the Quick AOPs. Click Turn on or Turn off to switch peacetime. Players see the change within a few seconds, and everyone on the server is told in chat.

• AOP: the area of patrol, like State wide or Sandy Shores. With the CAD, it's the same AOP as the top of the CAD and in your CAD settings, so changing it in one place changes it everywhere.
• Peacetime: while it's on, players can't shoot, fight or draw a weapon, and the HUD shows a Peacetime box. A notice shows in the middle of the screen for a few seconds when it starts.
• Officers on duty in the CAD can still use weapons: on to start with. Police signed on in the CAD keep their weapons during peacetime. Untick it to hold everyone to it.

Staff can also change both in game with /aop and /peacetime. See Change the AOP and peacetime.

Turn it on#

On the Game tab, under In game:

1. Tick Use the HUD.
2. Click Save.

Players see it within a few seconds. You don't need to restart anything. Next to the page title, On in game or Off in game shows whether it's on.

The other settings under In game:

• Show it on foot: keeps the location panel on screen when players aren't in a vehicle. Untick it and the HUD only shows in vehicles.
• Players can pick their own design: players choose any design for themselves with /hud.
• Players can hide parts: players can switch off parts they don't want. They can't show a part you've switched off.
• Minimap: Always, or Only in vehicles to hide the game's minimap while players are on foot. While the HUD shows health and armour, the game's own health and armour bars under the minimap are hidden.

Make it look like your community#

On the Look and position tab, with the preview next to it:

• Colour: the HUD uses the accent colour from your website's branding. Tick Use a different colour from my site to pick another.
• Text, Panels and Warnings: the colour of the writing, the dark boxes behind it, and things that need attention, like low fuel or a missing seatbelt.
• Size: from 50 to 150 percent. It also grows and shrinks with each player's screen.
• Opacity: from 40 to 100 percent.

Move it#

Further down the Look and position tab, the Speedometer and the Location panel each have:

• The edge or corner of the screen they sit in, like Bottom right.
• Across and Up or down: how far in from that edge, in pixels on a 1080p screen.

The location panel starts at the bottom left, just to the right of the minimap. The Street design keeps its speed at the top of the location panel, so it only uses the location panel's position.

Units and time#

On the Game tab, under Units and time:

• Speed: mph or km/h. The trip distance follows it, in miles or kilometres.
• Electric vehicles: Show it as charge swaps the fuel pump for a lightning bolt. Hide fuel hides it on electric cars.
• Time: Real time in your community's time zone, or The game clock. Your community's time zone is set under Events, in Community timezone.
• Clock: 24-hour or 12-hour. Tick Show seconds to add them.
• Date: how the date reads, like Tue 10 Nov 2026 or 2026-11-10.

Choose what it shows#

On the Design tab, What it shows under the preview has a box for every part, in three groups. The preview changes as you tick them:

• In a vehicle: speed, gear, revs, fuel or charge, trip distance, seatbelt, engine warning, headlights, indicators and handbrake.
• Location: compass, street and cross street, area, nearest postal, AOP and peacetime. Peacetime only shows while it's on.
• Player, date and time: time, date, health, armour, voice and your callsign and status while on duty.

Some parts hide themselves when there's nothing to show. Armour only shows when the player has some, the callsign only on duty, and the postal only once your community has postals. See Choose a map and postal set.

Trip distance counts how far the player has driven in that vehicle since they joined the server. It starts again when they rejoin.

Voice shows the range players talk at, and lights up while they talk. It works with pma-voice and SaltyChat.

Seatbelts#

On the Game tab, under Seatbelt:

• The HUD's own seatbelt: players buckle up with /seatbelt or a key. The seatbelt light flashes when they drive off without one.
• Another resource handles seatbelts: /seatbelt and the key are left free for your seatbelt resource. The light on the HUD follows it if it uses our export, below, or is the qb-smallresources seatbelt.
• Seatbelt key: B to start with. Players can change it in the game's key settings, under FiveM. A new key takes effect after the resource restarts.
• Through the windscreen: without a seatbelt, a hard crash throws the player out of the front of the car.
• Warning chime: a driver without a seatbelt hears a chime once the car is moving faster than walking pace, until they buckle up.

Bikes, boats and aircraft don't have a seatbelt, so the light doesn't show in them.

Postal map#

The Map tab swaps the game's minimap and pause map for a postal map, so players can read postal numbers as they drive. It works with Use the HUD off too. It needs the LonexOne FiveM resource 0.11.0 or newer.

1. Under Postal map, pick one:
   • The game's own map: no postal map. This is where you start.
   • BigDaddy postal map: a dark map with BigDaddy's postals, Cayo Perico included.
   • GTA V postal atlas: the bright atlas style with New Postals.
   • WildFyr satellite postal map: satellite imagery with New Postals.
   • Oulsen satellite map: satellite imagery with Oulsen's own postals and road names.
   • Another postal map resource I run myself: LonexOne leaves your map alone.
2. Click Save.
3. Copy the [lonexone_postalmaps] folder from the resource download into your server's resources folder, next to lonexone. It holds every map, so you only do this once.
4. Restart the server once, so it sees the new folder.

Don't add [lonexone_postalmaps] or the maps inside it to server.cfg. LonexOne starts the map you picked and stops the others, so you change maps from the website. Players only download the map you picked.

Players who are already connected see the new map after they reconnect. A game server can't swap map files while players are on it.

Postals and the live map follow the map#

When you pick one of the maps, LonexOne sets your postals to the set printed on it, so the HUD's postal, /gps and the CAD all agree with what players see. It also points the CAD's live map at the same map. The message at the top of the page says what changed.

• Your postals are replaced with the map's set. Any postals you added yourself go.
• If you uploaded your own map image for the live map, it stays.
• The game's own map and Another postal map resource I run myself leave your postals and live map as they are. With your own map resource, set the matching postals under CAD settings. See Choose a map and postal set.

Minimap zoom#

On foot and In a vehicle set how far the minimap is zoomed, from 0 to 1,400. Leave them empty and a postal map uses 1100, the zoom it was drawn for. With the game's own map, empty keeps the game's normal zoom.

The BigDaddy map sets its own zoom, 1200 on foot and 1100 in a vehicle, so these don't take effect with it.

Who made the maps#

• The BigDaddy postal map is by Big Daddy Scripts, included with their permission. Its licence doesn't allow changing it or passing it on, so use it only on your own server. For their other scripts and support, see bigdaddyscripts.com.
• The WildFyr satellite postal map is by WildFyr.
• The Oulsen satellite map is by Oulsen, under the MIT licence. See github.com/Oulsen/oulsen_satmap.

What players can do#

Players type /hud to open the HUD menu. Depending on your settings they can pick a design, and switch parts off and on again. Their choice is saved on their own computer, so it stays when they rejoin.

• /hud off hides the HUD for them, and /hud on brings it back.
• The HUD hides itself while the pause menu is open, when the game hides its own HUD (for example in a cutscene), and while the loading screen or the spawn selector is showing.

You can rename /hud and /seatbelt on the Game resource tab of Status & servers. See Every in-game command.

Fuel#

The HUD reads fuel from LegacyFuel, ox_fuel, cdn-fuel, ps-fuel or lj-fuel, whichever your server runs. Without one of those, it shows the game's own fuel level, which doesn't go down unless a resource uses it.

For developers#

From another client script:

• exports.lonexone:setSeatbelt(true) or false sets the seatbelt light, for seatbelt resources.
• exports.lonexone:isSeatbeltOn() says whether the player is wearing one.
• exports.lonexone:hideHud(true) hides the HUD, for example while your own menu is open. false shows it again.
• The client event lonexone:seatbelt fires with true or false when the player buckles or unbuckles with the HUD's own seatbelt.

Something not working?#

Nothing shows in game. Check Use the HUD is ticked on the Game tab and your server runs the resource 0.10.0 or newer. Type /hud on in case it was hidden.

Players see two HUDs. Your server runs another HUD. Stop it in your server.cfg, or untick the parts it already shows.

/seatbelt does nothing. Seatbelts is set to Another resource handles seatbelts, or the command was renamed on the Game resource tab.

The postal doesn't show. Your community has no postals yet. Set them up under CAD settings, on the Postals & streets tab.

Fuel always shows the same. Your server doesn't run one of the fuel resources above. Fuel goes down only when a fuel resource uses it.

The time is wrong. Check Community timezone under Events, or pick The game clock under Time.

Players still see the game's own map. They need to reconnect after you change the map. If it still doesn't show, look in the server console. It says if the [lonexone_postalmaps] folder is missing: copy it next to lonexone and restart the server.

The console says "Could not start the postal map". Your server didn't let LonexOne start it. Add ensure lonexone_postalmap_bigdaddy (or the folder of the map you picked) to server.cfg, after ensure lonexone. Take the line out again if you change maps.

The minimap zoom doesn't change. With the BigDaddy map, its own zoom wins. With the others, check the numbers are between 0 and 1,400.