Configuration

Page dedicated to how to configure our Loading Screen

Configuration Guide (config/config.lua)

The configuration file is structured to be self-explanatory, but below are the critical sections explained in depth.

UI Branding & Colors The loadscreen utilizes modern HSL (Hue, Saturation, Lightness) values for primary colors. This allows for dynamic theming across the UI components.

Config.Locale = "en-US"
-- HSL format (Hue Saturation% Lightness%) - Do NOT use HEX or RGB here.
Config.PrimaryColor = "223 99% 59%" 
Config.LogoUrl = "https://yourwebsite.com/logo.svg"

Tip: Asset Hosting To significantly reduce client downloading times when they connect to your server, host all your media (Logos, Backgrounds, Audio) on an external Content Delivery Network (CDN) or Discord/Imgur, rather than streaming them directly from the FiveM server.

Media & Backgrounds You can define an array of background images that the loadscreen will cycle through.

Config.Background = {
    type = "images",
    images = {
        "https://link-to-your-image-1.jpg",
        "https://link-to-your-image-2.jpg"
    },
}

Audio Engine The built-in audio player supports multiple tracks.

Config.Songs = {
    {
        id = 1,
        title = "Los Santos Vibes",
        authors = { "Artist Name" },
        coverUrl = "https://link-to-album-art.jpg",
        audioUrl = "https://link-to-audio-track.mp3", -- Must be a direct raw audio file (.mp3, .ogg)
    },
}