> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nexdev.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> How to install NEX UI Pack on your FiveM server.

## Requirements

* FiveM server
* Our forked `ox_lib` from [github.com/nexdevelopmentx/ox\_lib](https://github.com/nexdevelopmentx/ox_lib) — **not** upstream `ox_lib`

<Danger>
  This pack will not work with upstream `ox_lib`. The redesigned UI only activates with our fork.
</Danger>

## Steps

1. **Remove or rename your existing `ox_lib`.** Don't run two copies of `ox_lib` at the same time.

2. **Install the forked `ox_lib`.** Either download the latest release ZIP, or clone it:

   ```
   git clone https://github.com/nexdevelopmentx/ox_lib
   ```

   Make sure the folder is named exactly **`ox_lib`** — not `ox_lib-main` or `ox_lib-master`.

3. **Drop `nex_uipack`** into your resources, e.g. `resources/[nex]/nex_uipack/`.

4. **Add to `server.cfg`** — `ox_lib` must start **before** `nex_uipack`:

   ```
   ensure ox_lib
   ensure nex_uipack
   ```

5. **Restart your server.**

## Checking it worked

Trigger any `ox_lib` UI in-game (a notification, menu, anything). It should show up in the redesigned NEX style.

If you want to be sure, type this into F8:

```
lua print(GetResourceState('nex_uipack'))
```

It should print `started`. If it prints `missing` or `stopped`, the pack isn't running.

## Updating

1. Replace `nex_uipack` with the new version.
2. Update our forked `ox_lib` at the same time — keep them in sync.
3. Restart the server.

There's no config file to preserve.
