Config

Everything in config.lua you can change to make the loading screen your own.

The whole config sits in a single config.lua file at the root of the resource. It’s escrow-ignored, so you can edit it freely without breaking anything.

General settings

These control the overall feel of the screen. Theme color, background, music volume, and the body text.

config.lua


Config.ColorTheme       = '#3767E5'
Config.DiscordServer    = 'https://discord.gg/2e4NGxp2fm'
Config.EnableDecorLines = true
Config.Background       = 'https://r2.fivemanage.com/.../background.mp4'
Config.InitialVolume    = 20
Config.Description      = 'An event in which all the bands in our state participate...'

Key	Type	Default	What it does
`ColorTheme`	string	`'#3767E5'`	Primary accent color. Any CSS hex value.
`DiscordServer`	string	invite URL	Discord invite link. The screen pulls the server name and live member count from this invite and uses it as the join button.
`EnableDecorLines`	boolean	`true`	Toggles the decorative line accents in the UI.
`Background`	string	URL or path	Background media. Either a CDN URL or a direct path to a local file inside the resource. Accepts `.mp4`, `.webm`, `.png`, `.jpg`.
`InitialVolume`	number	`20`	Starting music volume. Range `0` to `100`.
`Description`	string	sample text	Body text shown next to the logo. Keep it short.

Choosing a background

You can use a hosted file or a local one:

Hosted. Fivemanage, Catbox, Cloudflare R2, or any CDN that gives you a direct .mp4 / .webm / .png / .jpg URL.
Local. Drop the file into web/build/backgrounds/ inside the resource, then reference it as './backgrounds/your-file.mp4'.

Videos look best at 1080p or higher. Try to keep them under 30 MB so players on slower connections aren’t stuck waiting.

Logo

The logo shown on the main panel.

config.lua


Config.Logo = {
    url    = './images/nexus.png',
    width  = 82,
    height = nil,
}

Key	Type	What it does
`url`	string	Local path (place file in `web/build/images/`) or a direct URL.
`width`	number	Width in pixels.
`height`	number or `nil`	Height in pixels. Leave `nil` to auto-scale based on width.

Music

Each entry plays in order. Players can skip or pause from the UI.

config.lua


Config.Musics = {
    {
        title  = 'FE!N FE!N',
        artist = 'Travis Scott',
        url    = 'https://r2.fivemanage.com/.../fein.webm',
        cover  = 'https://r2.fivemanage.com/.../fein_thump.jpg',
    },
    {
        title  = 'Big dawgs',
        artist = 'Hanumankind',
        url    = 'https://r2.fivemanage.com/.../big_dawgs.webm',
        cover  = 'https://r2.fivemanage.com/.../big_dawgs.jpg',
    },
}

Key	Type	What it does
`title`	string	Track title shown in the player.
`artist`	string	Artist name shown under the title.
`url`	string	Direct audio file URL.
`cover`	string (optional)	Cover image URL.

Supported audio formats: .mp3, .wav, .ogg, .m4a, .aac, .flac, .opus.

You can also drop audio files into web/public/music/ and reference them with a local path.

Link buttons

Buttons shown on the screen for socials, your website, or anywhere else you want to send players.

config.lua


Config.LinkButtons = {
    {
        name  = 'Instagram',
        url   = 'https://www.instagram.com/nexusstudios/',
        logo  = './images/icons/insta.svg',
        IsBig = false,
    },
    {
        name  = 'WEBSITE',
        url   = 'https://nexusstudios.net/',
        logo  = './images/nexus.png',
        IsBig = true,
    },
}

Key	Type	What it does
`name`	string	Label shown on the button.
`url`	string	Where the button takes the player.
`logo`	string	Icon path. Local file or URL. SVG and PNG both work.
`IsBig`	boolean	`true` to render a larger button. Good for your main website.

Team

The team showcase block. Add as many members as you like.

config.lua


Config.Team = {
    {
        name       = 'H Y D R A',
        logo       = 'https://.../avatar.webp',
        role       = 'DIRECTOR',
        Identifier = 'discord:945516946164690954',
    },
    {
        name       = 'Swanky',
        logo       = 'https://.../avatar.webp',
        role       = 'DIRECTOR',
        Identifier = 'discord:696777167685812255',
    },
}

Key	Type	What it does
`name`	string	Display name.
`logo`	string	Avatar image URL.
`role`	string	Role label like `DIRECTOR`, `DEV`, `MOD`.
`Identifier`	string	Discord identifier in the format `discord:<id>`.

If you have a long team list, the panel scrolls automatically.

Need help?

Stuck on something or want to request a feature? Hop into our Discord and we’ll help you out.