> ## 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 Loading Screen on your FiveM server.

## Requirements

None. The resource is standalone — no framework, no `ox_lib`, no SQL.

## Steps

1. Drop the `nex_loadingscreen` folder into your `resources/` directory. Any subfolder is fine, e.g. `resources/[nex]/nex_loadingscreen/`.

2. Add it to your `server.cfg`:

   ```
   ensure nex_loadingscreen
   ```

3. Restart the server.

The loading screen appears the next time a player connects.

<Info>
  Only **one** loading screen can be active at a time. If you previously used another loading-screen resource (`loadingscreen-`, `default_loading_screen`, etc.) make sure to remove or disable it in `server.cfg` first.
</Info>

## Checking it worked

Connect to the server. You should see the NEX loading screen with the animated background and music player.

From F8 (after spawning in):

```
lua print(GetResourceState('nex_loadingscreen'))
```

Should print `started`. If it prints `missing` or `stopped`, fix `server.cfg` and restart.

## Updating

`lua/config.lua` is listed under `escrow_ignore`, so your settings, songs, links, tips and theme survive updates.

1. Replace the resource files with the new version (keep your edited `lua/config.lua`, and the `html/assets/audio/`, `html/assets/images/`, and `html/assets/logo.png` files you've added).
2. Restart the resource:

   ```
   restart nex_loadingscreen
   ```

   Players already connected won't see the new screen until next join.