How To Use • Development Setup • Contributing • Credits • Support • License
The original repository has now been archived. This fork will continue to be maintained for the FiveM community.
- Download the latest release, add to your resources, ensure in your
server.cfg. - Don't forget to set a framework in
config/shared.luaand any custom logic intoconfig/functions.lua. - If using the built-in seatbelt logic, add
setr game_enableFlyThroughWindscreen trueto yourserver.cfg.
Commands:
/togglehud -- toggle the HUD visibility on or off.Exports:
-- state: true to show, false to hide.
exports['minimal-hud']:toggleHud(state) -- toggle HUD visiblity.
exports['minimal-hud']:toggleMap(state) -- toggle minimap visibility.If you want to make changes to the HUD's UI, you can follow these steps to clone and run the project locally.
To clone and run this application, you'll need Git and Bun along with NodeJS installed on your computer. From your command line:
# Clone this repository
git clone https://github.com/ThatMadCap/minimal-hud.git
# Go into the repository
cd minimal-hud
# Navigate to the web folder
cd web
# Install dependencies using Bun
bun install
# Run the app
bun run devI welcome contributions to improve minimal-hud, it would not be possible to maintain without the community. If you'd like to help enhance the resource, feel free to use discussions, open issues, or submit pull requests.
When contributing, please keep the following in mind:
- Maintain the same style and theme as the existing HUD for a consistent user experience.
- Follow the project's coding conventions.
- Ensure any new features include appropriate tests where applicable.
I appreciate your support in keeping this resource free and accessible for the FiveM community!
This software uses the following open source packages:
If you enjoy this project and want to show your support, consider buying me a coffee:
Alternatively, if you'd like to support the original author of this HUD, vipexv, you can do so here:
