> For the complete documentation index, see [llms.txt](https://docs.ak4y.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ak4y.com/scripts/ak4y-hudv1/setup-script.md).

# Setup Script

## Let's download the requirements

Download xsound from the link below and put it in the section where your server's scripts are located.

{% embed url="<https://github.com/Xogy/xsound>" %}

## Hunger and thirst needs

You should set edible and drinkable medicines via esx\_status or qb-smallresources scripts. Hud will automatically pull your values.

{% hint style="warning" %}
For the esx framework, you should use the esx\_status script for things like hunger and thirst to work on your server. For the QBCore framework, the qb-smallresources script must be installed on your server. Make sure these scripts are installed
{% endhint %}

***

## Script installation

1. Paste the script you downloaded from Keymaster into the packages folder where your server files are located.
2. Check the default settings of hud via Config
   1. If you are using a custom fuel script, set Config.UseCustomFuel to true and edit the contents of the Config.CustomFuel function just below.
   2. Edit the url of the Config.ServerLogo variable to change your Server Logo.
   3. Edit the Config.Inventory variable for interactions with your inventory
   4. If you want the photo of the weapon you have on the watermark to appear without errors; edit the contents of the Config.InventoryImagePath function. ( nui:// inv script name / image folder / )
   5. Select your default notify structure via the Config.NotifyEvent variable according to the infrastructure you are using
3. If you wish, you can integrate your custom notify script via Config.Notify function
4. After all checks, ensure xsound and ak4y-hudv1 scripts via server.cfg

{% hint style="danger" %}
Remember! The script will not work correctly if it is restarted in-game. You must exit and enter the game after the script is restarted.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ak4y.com/scripts/ak4y-hudv1/setup-script.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.