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

# Installation

## Installation

1. Unzip the `jg-hud-bundle` and open the `jg-hud-bundle` folder.
2. Drag the script folder within (`jg-hud`) into a new folder called `[jg]` within your server's `resources` folder.
3. Make sure you have the latest version of [ox\_lib ](https://github.com/overextended/ox_lib/releases/latest)installed on your server. This script does not use a database, so oxmysql is *not* required.
4. Inside of your `server.cfg`, add a new line **after** all your other resources have started:

```
ensure [jg]
```

## Configuration

There are some basic options to adjust in `config/config.lua` - mainly integrations, guard rails and essential options to get things up and running for your server.

If you're looking to change some of our built in datasets, such as speed limits, GTA V HUD component hiding, train stations and more, you'll find these in `config/config.data.lua`

Nearest postal data can be found in `data/nearest-postal`. Full credits to BlockBa5her/DevBlocky for the integration - the original repo can be found here: <https://github.com/DevBlocky/nearest-postal>

### Editing the HUD

Most configuration will be done in-game, via the HUD settings. This is accessible, by default, via the `/settings` command. You can change this command in the config, via `Config.OpenSettingsCommand`

The settings panel should be fairly intuitive. Click on the different options on the left to adjust different parts of the HUD. The necessary parts of the HUD will show if hidden to allow for easy editing.

You can change the layout by clicking the button that's always in the top right of the settings panel.

By default, players can change the HUD for just their eyes. If you want to enforce a custom HUD layout & setup for all your players, see [Default Settings](/hud/default-settings.md)


---

# 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.jgscripts.com/hud/installation.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.