> For the complete documentation index, see [llms.txt](https://leviascripts.gitbook.io/levia-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://leviascripts.gitbook.io/levia-scripts/loading-screen/installation.md).

# Installation

***

### Requirements

Before installation, make sure your server meets the following requirements:

* Updated FiveM artifact (recommended latest version)
* Basic understanding of server resources
* Access to your `resources` and `server.cfg` files

***

### Step 1 — Add the resource

Drag and drop the loading screen folder into your server `resources` directory.

Example structure:

{% hint style="warning" %}
DO NOT RENAME THE SCRIPT FOLDER OR FILES.

If you rename the resource or modify its structure, the loading screen may **stop working completely** or fail to load correctly in-game.
{% endhint %}

```
resources/levia-loadingscreen
```

***

### Step 2 — Verify folder structure

Make sure the resource contains the following structure:

* `fxmanifest.lua`
* `client.lua`
* `ui/index.html`
* `ui/config.js`
* `ui/css/`
* `ui/js/`
* `ui/img/`
* `ui/audio/`
* `ui/video/`

> The loading screen will not work if the UI folder structure is incomplete.

***

### Step 3 — Ensure the resource

Add the following line to your `server.cfg`:

```
ensure levia-loadingscreen
```

Make sure it is placed **after essential dependencies if required**.

***

### Step 4 — Configure the loading screen (optional)

Edit the main configuration file:

```
ui/config.js
```

Here you can customize:

* Server name
* Logo
* Music playlist
* Social links
* Rules
* News
* Theme colors
* Discord integration

***

### Step 5 — Enable Discord widget (optional)

If you want to display online members, enable the Discord widget:

1. Go to your Discord server settings
2. Enable **Server Widget**
3. Copy your **Guild ID** into the config:

```
Config.Discord = {    guildId: 'YOUR_GUILD_ID',}
```

***

### Step 6 — Restart your server

Restart your server or run:

```
restart levia-loadingscreen
```

The loading screen will now replace the default FiveM loading screen.

***


---

# 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://leviascripts.gitbook.io/levia-scripts/loading-screen/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.