Car HUD
Step by step installation guide, common issues & solutions, troubleshooting guide, code snippets, common error codes, config previews, locales previews and changelogs; all in 1 easily accessible place
Buy Here
This resource can be purchased as part of a bundle for a discount here.

Translate

START HERE

1. Unzip the cd_carhud.zip folder and place this folder in your server's resource folder.
2. Add the resource to your server start config: ensure cd_carhud. The name of the folder must not be changed or the resource will not function correctly.
3. WARNING do not edit the encrypted files in any way.

INSTALLATION GUIDE

Step 1 - Fxmanifest

You may need to make some changes to the fxmanifest.lua, depending on your framework and dependencies. We have made this easier for you by commenting on the lines which you may need to change.

Step 2 - Configure the resource

You MUST read all of the configurable options inside the config.lua and configure them to suit your server's needs. Please read the ”commented out help text” at the end of each line so you can understand what each config option does.
The most important sections are the options under the Framework and Important sections at the top of the config.lua. Everything else is optional.

Step 3 - Fuel Script

Configure Config.FuelScript in the config.lua.
If you don't use any of the 3 pre-configured fuel scripts, you will need set Config.FuelScript to 'other' and add your code to get a vehicles fuel level from your fuel script into the GetFuel function in configs/client_customise_me.lua.
1
function GetFuel(vehicle)
2
if Config.FuelScript == 'none' then
3
return GetVehicleFuelLevel(vehicle) --Default FiveM native example.
4
5
elseif Config.FuelScript == 'legacyfuel' then
6
return DecorGetFloat(vehicle, '_FUEL_LEVEL') --Legacy Fuel example.
7
8
elseif Config.FuelScript == 'frfuel' then
9
return math.ceil((100 / GetVehicleHandlingFloat(vehicle, "CHandlingData", "fPetrolTankVolume")) * math.ceil(GetVehicleFuelLevel(vehicle))) --FRFuel example.
10
11
elseif Config.FuelScript == 'other' then
12
--Add your own code here to get a vehicles fuel.
13
14
end
15
end
Copied!

INFORMATION

Default Keybinds

Please Read Here for more information regarding key-mapping.
Key
Description
Y
Open the settings UI.
B
Toggle the seatbelt.
=
Toggle cruise control.

Chat Commands

All of these chat commands can be renamed and disabled/enabled in the config/code.
Command
Description
/carhud
Open the settings UI.
/seatbelt
Toggle the seatbelt.
/carhudtoggle
Toggle the carhud UI visibility.

FAQ

Can i change the default UI settings?
Optimization?
Will the settings save after I relog?
How do I use the indicators/turn signals?

SCRIPT NOT WORKING?

Common Issues

🔔 Folder Name Make sure the name of the folder is cd_carhud.

Common Error Codes

Server
Client
N/A
3216855 - The value of the Refresh Timer in the settings UI is nil, enter a number and it will be fixed.
88146545 - Either the Config.Language you have chosen does not have a matching set of locales in the Locales.lua or one of the locales in the Locales.lua is missing/has been renamed. What ever you changed, revert it and try again.
30165847 - The format of the Notif function is wrong, what ever you have changed, revert the change and try again.

Troubleshooting

1. Check if the script has authorized correctly. Check the server console to make sure there are no errors saying You lack the required entitlement? and check for 2 client-sided prints saying Loaded Successfully!.
2. Check for obvious error prints in the server console and the client F8 console. If you don't see any obvious errors make sure to restart the script while the server is live and check again.
3. If none of the above worked, have a second read through the installation guide above, you may have missed something - you are only human.
If all else fails, contact the Codesign Team in the Codesign Discord.

CHANGELOG

Files Changed: Not every update requires you to replace the whole folder. We do this because we understand it's a pain to redo the configs for every update.
  • All Files - This means you should delete your old cd_carhud folder, download and add in the latest version, reconfigure the configs folder and restart your server.
  • Specific Files - This means you can simply copy and paste the SPECIFIC new files over the old ones and restart the server.
Update Type: On rare occasions, you are forced to update to the latest version. Mostly due to authentication updates where the old versions will no longer work.
  • Mandatory - This means you MUST update to this new version or the old versions will no longer work.
  • Optional - This means its completely your choice whether you wish to update to the latest version. But we do not offer support for old versions for obvious reasons; they are old.
v3.0.0
v4.0.0

26/12/2020 - 21/06/2021

v3.0.0 - v3.0.6
Files Changed:
  • All files
  • Specific Files
Update Type:
  • Mandatory
  • Optional
Changelog:
Add
  • Added cruise control.
  • Added a command to toggle the carhud visibility (also an option to hide the minimap visibility within this when the carhud visibility is disabled).
  • Added compass
    • Compass can be moved around / enabled disabled.
    • Compass heading can be hidden / shown.
    • Compass caret can be hidden / shown.
Edit
  • Updated hud gauge to a transparent color.
  • Improved text visibility.
  • Re-enabled indicator checks.
  • Updated the codesign error handlers.
Fix
  • Seatbelt sound fix.
  • Dashboard icons scaling fix.
  • Engine health alert fix.
  • Fixed random server error on server start.
  • Minor bug fixes.
  • Fixed street names erroring when on the cayo perico island.
  • Fixed the compass heading being inverted.
  • Fixed the percentage character on the settings menu.
  • Fixed it so other seatbelt scripts can trigger an event to enable/disable the seatbelt icon on the UI.
  • Temporary fix for the canary issue until the new Tebex FiveM license system is ready to launch, when this is released we will be fully switching over to the new system.

08/11/2021

Files Changed:
  • All files
  • Specific Files
Update Type:
  • Mandatory
  • Optional
Changelog:
Authentication
  • We are now using the official Authentication System provided by FiveM. The old auth system will be taken offline 1 week from now (give or take a few days if needed).