Player HUD
Step-by-step installation guide, common issues & solutions, code snippets, error codes, config previews, locales previews, SQL previews, and changelogs; all in 1 easily accessible place.
Last updated
Was this helpful?
Step-by-step installation guide, common issues & solutions, code snippets, error codes, config previews, locales previews, SQL previews, and changelogs; all in 1 easily accessible place.
Last updated
Was this helpful?
This resource can be purchased as part of a bundle for a discount .
1. Download your resource from .
2. Unzip the cd_playerhud.zip folder and place this folder in your server's resource folder.
3. Add the resource to your server start config (server.cfg): ensure cd_playerhud. If you are using a framework, it must be placed anywhere below your framework resource e.g., es_extended, not above.
Where can I configure my key binds?
Why do I need to do this?
Note: In version 3.1.0+ esx_basicneeds and esx_status are not compatible. You must remove these resources as everything you need is built into cd_playerhud.
No? Then set the Config.BasicNeeds.ENABLE in the config.lua to false.
Yes? Then set the Config.BasicNeeds.ENABLE in the config.lua to true and configure the Config.BasicNeeds config options. You must also add your usable food & drink items to the Config.BasicNeeds.Items config table.
No? Then set the Config.BasicNeeds.save_in_database in the config.lua to false.
No? Then set the Config.Stress.ENABLE in the config.lua to false.
Yes? Then set the Config.Stress.ENABLE in the config.lua to true and configure the Config.Stress config options.
No? Then set the Config.Stress.save_in_database in the config.lua to false.
Tips for creating Your own app screens
The position in the screens.list array determines the order of displaying the screens. Do not change screens.current unless you want a different screen to display first (screens.current goes from 0 to screens.list.length-1)
Currently, the screens.list.name value has no use; however, it is reserved for future use, such as setting options for certain apps. // The screens.list.id is the id of the element containing the app screen. It will be displayed once it is cycled.
To make your app functional you would either need to create another JavaScript file and include it through the HTML or add inline JavaScript to the index.html file itself.
To place the screen in the correct position, use the .app-screen class on your HTML element.
The existing apps are not editable; however, you can change their order if you wish.
Key
Description
I
Toggle the watch UI.
K
Toggle move mode.
Right Click
Disable move mode.
Left / Right Arrows
Cycle through the screens.
The exact usage for each command will be displayed in the chat suggestions when using the commands in-game.
Command
Description
/watchhud
Toggle the watch UI.
/resetstatus
(Staff Only) Reset a player's hunger, thirst, stress, and oxygen stats.
These events are completely optional; you can use them if needed.Here is some information about this event.
Event Name
Description
Event Type
TriggerEvent('cd_playerhud:status:add', Status_Type, Amount)
Add a status to a player.
client
What does Status_Type and Amount mean?
Status_Type (string)
Amount (number)
'hunger'
0 - 100 (0 is empty and 100 is full)
'thirst'
0 - 100 (0 is empty and 100 is full)
'stress
0 - 100 (0 is empty and 100 is full)
'oxygen'
0 - ∞ (You can add any amount, this is to support the use of diving gear, etc. But be sure to set a player's oxygen back to the maximum default value of 30 when the diving gear has been removed)
Do you need an example?
The example below will add 20 'hunger' to a player when being triggered from the client-side to the client-side.
The example below will add 20 'hunger' to a player when being triggered from the server-side to the client-side.
These exports are completely optional; you can use them if needed.
Get Status
🔔 Folder Name Make sure the name of the folder is cd_playerhud.
🔔 Encrypted Files Do not edit the encrypted files in any way.
Money/Hunger etc is not being updated on the UI?
eg., if certain things like your hunger/thirst/stress/money are not being updated, that most likely means your framework has renamed the events.
N/A
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_playerhud folder, download and add in the latest version, reconfigure the configs folder and restart your server.
All Files Except config.lua - This means you should do all of the above (in the All Files section) but additionally make a backup of the config.lua file and replace the new config.lua file with the one you made a backup of.
Specific Files - This means you can 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 it's 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.
Skipping Updates
If you are attempting to update to the latest version but have skipped previous updates, you should update all files just to be safe. For example., let's say you are currently on v4.0.1, you did not update when v4.0.2 was released, and now v4.0.3 is released, and you want to update; you should always use the “All Files” update method.
v3.0.0 - v3.1.1
Files Changed:
Update Type:
Changelog:
Add
Added config options for framework version.
Added the ability to rename all esx events such as the setjob and playerloaded events.
Added drag-and-drop compatibility for QBCore.
Added 2 new files (stress and underwater_oxygen) to make them open-source and editable.
Added a new config option to save the hunger/thirst/stress to the database without needing to use esx_status. This is more optimized than how esx_status saves to the database as now this data is only saved when a player exits the server or switches character.
Added a new config option so you can choose the effect when a player's hunger/thirst is empty. By default, you can choose between slowly losing health or blurring the screen.
Added a new system where if the usable food/drink items are spammed, they will get added to a queue and the animations will execute one at a time
Added a staff command to reset a players status.
Added the ability to set the under water oxygen from other scripts to support diving gear etc.
Added support for cd_multicharacter when switching characters in game to reset the cached client side status data and re cache the new characters status data since you are able to save a characters data in the database now.
Added the ability for customers to make their own apps.
Fix
Fixed having to re-configure the hunger/thirst alert every time you relog.
Fixed random server error on server start.
Minor bug fixes.
Fixed the scale locale 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.
Fixed a typo which caused removing a status to only remove 1.
Depending on your framework and dependencies, you may need to make some changes inside the [cd_playerhud/fxmanifest.lua]. We have made this easier by on the lines you possibly need to change.
You MUST read all configurable options inside the [cd_playerhud/configs/config.lua] file and configure them to suit your server's needs. Please read the at the end of each line so you can understand what each config option does.
The most important sections are the options under the and sections at the top of the config.lua. Everything else is optional.
You MUST import the SQL file to your database. This SQL file is located inside theREAD_ME_AFTER_PURCHASING folder; the file is named SQL_main.sql. Watch this video if you are unsure how to do this / .
Before starting this resource on your main/live server, we highly advise configuring your key binds because this resource uses .
You can configure key binds in the section near the bottom of the [cd_playerhud/configs/config.lua].
Well long story short;- once a player has joined your server with this resource running you can no longer force change their key binds for this resource through the config.lua, only they can change it in the in-game . Although it will change for the players who join after you have changed it.
The benefit of this system is that it's much more optimised and players can easily change their key binds on keyboards or controllers. You can also check out the for this resource.
Yes? Then set the Config.BasicNeeds.save_in_database in the config.lua to true and import the SQL file which is located inside theREAD_ME_AFTER_PURCHASING folder, the file is named SQL_main.sql. Watch this video if you are unsure how to do this / .
Yes? Then set the Config.Stress.save_in_database in the config.lua to true and import the SQL file which is located inside theREAD_ME_AFTER_PURCHASING folder, the file is named SQL_main.sql. Watch this video if you are unsure how to do this / .
These keys can be modified and/or disabled in the section of the [configs/config.lua].
Please make sure you understand how works.
These chat commands can be renamed and/or disabled in the section of the [configs/config.lua].
Please check out our before contacting our support.
If you see an error code not listed below, please open a script support ticket in the .
8846 - You are sending the wrong data in the cd_playerhud:status:set event. The first argument should be the status and the 2nd argument should be a number, refer to this for how this event should be formatted .
