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

# INSTALLATION

Everything you need to successfully deploy OBS Loading Screen to your FiveM server.

***

### 📥 1. Deployment

1. Securely download the latest build from your Tebex portal.
2. Extract the downloaded package.
3. Move the extracted folder directly into your server's `resources` directory.

{% hint style="danger" %}
**CRITICAL ARCHITECTURE WARNING DO NOT RENAME THE FOLDER.** The resource must remain strictly named `obs_loadingscreen`. Modifying this namespace will shatter the internal JavaScript NUI callbacks, resulting in a catastrophic UI failure.
{% endhint %}

***

### ⚙️ 2. Initialization

1. Open your server's core configuration file (`server.cfg`).
2. Add the following boot flag to your startup sequence:

```lua
ensure obs_loadingscreen
```

3. Execute the deployment by either restarting your server completely, or by running the following commands in your server console:

```lua
refresh
start obs_loadingscreen
```

{% hint style="success" %}
**Installation Complete! 🎉** Your loading screen is now live. You can move on to the Configuration section to begin customizing your colors, backgrounds, and features.
{% endhint %}


---

# 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://theobsidianstudio-1.gitbook.io/theobsidianstudio-docs/assets/obs_loadingscreen/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.