# Installation

## Requirements

Install and start these dependencies before KOJA HUD:

* [koja-lib](https://github.com/Koja-Scripts/koja-lib) — required. It detects your framework (ESX, QBCore or Ox) and provides money, job, key bind and callback helpers.
* [oxmysql](https://github.com/overextended/oxmysql) — required. The server script loads it even when the nitro system is off.
* [pma-voice](https://github.com/AvarianKnight/pma-voice) — used for the voice bar by default. See `KOJA.Microphone` in [Configuration](/new/hud/configuration) to change this.
* Node.js — only when you rebuild the web UI from source.

The resource needs `lua54` and the `gta5` game, both already declared in its `fxmanifest.lua`.

:::hint{type="warning"}
Start `koja-lib` and `oxmysql` before `koja_hud`.
:::

## Install

1. Place the `koja_hud` folder in your resources directory.
2. Add it to `server.cfg` after its dependencies:

```cfg
ensure koja-lib
ensure oxmysql
ensure koja_hud
```

3. Open `editable/shared/config.lua` and adjust the options you need.
4. Restart the server.

The web UI is shipped prebuilt in `web/build`. You do not need Node.js unless you change the interface.

## First start

* Nitro adds one `nitro` column to your vehicles table automatically. See [Database](/new/hud/database).
* The resource streams the files in its `stream` folder (`squaremap.ytd`, `minimap.gfx` and `graphics.ytd`) to give the minimap its square shape. Do not run a second script that replaces the minimap.
* Each player's personal settings are saved in their own game client. The first time they join they receive the defaults from `editable/shared/js.json`.
* Players open the settings menu with `/settings`.

## Rebuilding the web UI

Only needed if you edit files in `web/src`.

```bash
cd web
npm install
npm run build
```

`npm run build` writes to `web/build`. Restart the resource after building.

## Related pages

- [Configuration](/new/hud/configuration) — Changing Language, Debug Prints, Settings Command, Hide Minimap, Notifications, Nitro, Engine, Seatbelt and Cruisemode.
- [Guides](/new/hud/guides) — Creating/Editing Locales, Progress Bar, Text UI and Stress.
- [Features](/new/hud/features)
- [Exports & Commands](/new/hud/exports-and-commands)
- [Database](/new/hud/database)
- [HUD](/new/hud) — back to the section overview