> For the complete documentation index, see [llms.txt](https://zynoxdev.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zynoxdev.gitbook.io/docs/zynox-resources/zx_loading_screen/installation.md).

# Installation

Zynox Studio Documents > ZYNOX RESOURCES > 🎬 ZX - Loading Screen

## 📥 Installation

Dependencies, drag and drop setup, server.cfg order, and connecting.

***

### 1️⃣ Check dependencies

Make sure your server environment meets the basic prerequisites:

* **Artifacts**: FXServer Recommended Build **5848** or higher.
* **Framework**: **100% Standalone** (Compatible with Qbox, QBCore, ESX Legacy, vRP, or custom frameworks).
* **Dependencies**: None! (0 external libraries required).

***

### 2️⃣ Add the resource

1. Download the resource from your [Cfx.re Keymaster Grants](https://keymaster.fivem.net/asset-grants) or store archive.
2. Extract the downloaded `.zip` file.
3. **Drag and drop** the resource folder directly into your server's `resources` directory:

   ```
   resources/
   └── zx_loading_screen/
   ```

> \[!IMPORTANT] Keep the folder name as `zx_loading_screen` (or your preferred name without spaces). Make sure there are no other active loading screen resources running simultaneously in your server.

***

### 3️⃣ Update server.cfg

Open your server's `server.cfg` file and add the startup command:

```cfg
ensure zx_loading_screen
```

> \[!TIP] Place `ensure zx_loading_screen` near your other standalone/asset resources.

***

### 4️⃣ Automatic Player Greeting Setup

ZX Loading Screen includes built-in connection handover support (`server.lua` + `deferrals.handover`).

* **No configuration needed!** The script automatically greets incoming players by their official Steam or FiveM display name when connecting.
* If a player connects without an identifier or during local offline testing, it gracefully defaults to `SURVIVOR`.

***

### 5️⃣ Test in-game

1. Restart your server, or run the following in your server console:

   ```shell
   refresh
   ensure zx_loading_screen
   ```
2. Connect to your FiveM server (`connect localhost` or via server list).
3. The modern AAA HUD loading screen will immediately appear with music, particles, clock, and loading progress!

***

-# © 2026 Zynox Development • [Official Store](https://zynoxdev.tebex.store/) • [Discord](https://discord.gg/2yuPTmsqjX)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://zynoxdev.gitbook.io/docs/zynox-resources/zx_loading_screen/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.