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

# Installation

> Get Awoken Loading Screen running on your server.

## Asset download

<Info>
  To find the asset, you must have made the purchase using your own keymaster account. Otherwise, you can use the transfer system to move the asset to a different keymaster account.
</Info>

Once the purchase is made on our official website, you will receive your asset directly in your [cfx portal](https://portal.cfx.re/). Download it from your panel and install it following the steps below.

## Requirements

No dependencies. Awoken Loading Screen runs entirely on its own.

## Installation

<Steps>
  <Step title="Remove old loading screen">
    Delete any other loading screen you have.
  </Step>

  <Step title="Add the resource">
    Place the `awoken_loadingscreen` folder into your server's `resources` directory.
  </Step>

  <Step title="Configure server.cfg">
    Add the following to your `server.cfg`:

    ```cfg theme={"dark"}
    # Optional - shared accent colour across all awoken resources.
    # Replaces theme.accent in config.lua when set.
    setr awoken:primaryColor "#00E5FF"

    ensure awoken_loadingscreen
    ```

    `awoken_loadingscreen` reads its convar override once at resource start, so changes to `awoken:primaryColor` need an `ensure awoken_loadingscreen` to take effect.

    The `awoken:primaryColor` convar themes any Awoken resource that reads it. If unset, the loading screen falls back to `theme.accent` in `config.lua`.
  </Step>

  <Step title="Edit config.lua">
    Open [config.lua](/resources/awoken-loadingscreen/configuration) at the root of the resource.

    Restart the resource after any change with `ensure awoken_loadingscreen` (or `restart awoken_loadingscreen` from your console if it's already running) for the changes to apply.
  </Step>
</Steps>

## Resource layout

```
awoken_loadingscreen/
├── fxmanifest.lua
├── config.lua        <-- edit this
├── server/main.lua     reads config.lua on connect, injects via handover
└── web/build/          the loading screen NUI
    └── media/          drop your custom logos / videos / audio here
```

## Custom media

Drop any image, video, audio, or icon file into `web/build/media/` and reference it from `config.lua` as `./media/<filename>`.

```
web/build/media/
├── logo.png
├── bg.mp4
├── ambient.mp3
└── kick-icon.svg
```

External URLs (`https://...`) also work for CDN-hosted assets.

Supported formats:

| Asset | Formats             |
| ----- | ------------------- |
| Image | JPG, PNG, WebP, SVG |
| Video | MP4, WebM           |
| Audio | MP3, OGG, WAV, M4A  |

## Updating

Re-download the resource from your cfx portal, replace the folder, and restart with `ensure awoken_loadingscreen`. Your `config.lua` is yours to keep - back it up before overwriting if you want to preserve your settings.