🛠️Installations Advanced Hud

Sure! Here's a professional and concise English version of your installation guide, formatted and ready to be used in GitBook:


✅ Prerequisites

Before installing the script, ensure the following:

  • You have a properly configured FiveM server.

  • Your server uses either the QBCore or ESX framework.

  • You have access to your server files to upload custom resources.


📥 Installation Guide

1️⃣ Download the Script

  • Download the script package.

  • Extract it if it's compressed (e.g., .zip, .rar).


2️⃣ Move the Script to the Server

  • Copy the script folder to:

    resources/[your_category]/
  • If you don’t have a custom category, create one:

    resources/custom_scripts/

3️⃣ Configure the Script

  • Open the config.lua file.

  • Modify the values as needed:

Config.Framework = 'QBCore' -- or 'ESX'

Config.ToggleHudCommand = 'hud' -- Chat command to toggle the HUD

Config.LogoURL = 'https://i.postimg.cc/T1pccQR9/1-1.png' -- Logo image URL

Config.CinematicCommand = 'cinematic' -- Toggles cinematic mode (removes HUD)

Config.ShowStreet = true -- Show or hide street names on screen

You can also tweak food/water depletion rates and other HUD elements here.


4️⃣ Add to server.cfg

  • Open your server.cfg file.

  • Add the following line at the end:

ensure Syntax-Hud

Replace syntax_hud with your actual script folder name.


5️⃣ Restart Your Server

  • Save all changes.

  • Restart your server using:

    restart Syntax-Hud

    or fully restart the server.


🔍 How to Verify

  1. Join your server.

  2. Use /hud in chat to toggle the HUD.

  3. Use /cinematic to enable/disable cinematic mode.

  4. Confirm that hunger/thirst bars work as expected.

  5. Verify street names are visible if ShowStreet is enabled.


🛠 Troubleshooting

Issue

Solution

Script doesn't start

Check if the folder name in server.cfg matches the actual folder name

Framework-related error

Ensure Config.Framework is correctly set and the framework is running

HUD doesn't show

Make sure no other HUD scripts are conflicting

Logo doesn't appear

Use a direct PNG/JPG image URL


Let me know if you’d like a downloadable .md or .pdf version for GitBook!

Last updated