Configuration

All configuration is in config.lua.

Color Theme


Config.ColorConfigs = {
    mainColor = '#D40000',
    SecondaryColor = '#FF0004',
    progressGradient = 'linear-gradient(90deg, #A90000 0%, #FF0004 100%)'
}

Setting	Description
`mainColor`	Primary accent color (hex)
`SecondaryColor`	Secondary accent color (hex)
`progressGradient`	CSS gradient for the loading progress bar

Background Media


Config.Background = './backgrounds/bmw.jpg'

Supports multiple media types:

YouTube Videos: Full URL (e.g. 'https://www.youtube.com/watch?v=...')
Streamable Videos: Full URL (e.g. 'https://streamable.com/abc123')
Direct Video Files: Path to .mp4, .webm, .ogg files
Images: Path to image files (.jpg, .png, .webp)
Empty string ('') for default background

Visual Effects


Config.EnableShades = true         -- Gradient overlay shades
Config.EnableCornerShades = true   -- Corner accent decorations

Server Logo


Config.Logo = {
    url = './loadingassets/logo.webp',
    width = 230,
    height = nil    -- nil for auto-height
}

Supports .png, .jpg, .webp, .svg formats.

Server Description


Config.Description = 'Your server description here.'

Brief text shown below the logo.

Tab Visibility


Config.Tabs = {
    rules = true,
    gallery = true,
    team = true,
    updates = true,
}

Show or hide individual content tabs.

Keybindings Display


Config.Keybinds = {
    { keybind = 'F1', action = 'Open Help Menu' },
    { keybind = 'F2', action = 'Open Settings' },
    { keybind = 'F3', action = 'Toggle Voice Chat' },
}

Displays keybindings in a visual keyboard UI. Players can click the keyboard button to see highlighted keys.

Music Player


Config.Musics = {
    {
        title = "Song Name",
        artist = "Artist Name",
        url = "./loadingassets/song.mp3",
        thumbnail = "./loadingassets/albumart.jpg"
    },
}

Players can skip between tracks using the built-in music player controls. Use direct MP3 files for best compatibility.

Server Rules


Config.Rules = {
    "Follow all server rules at all times",
    "Respect all players and staff members",
    "No cheating, hacking, or exploiting bugs",
}

Image Gallery


Config.Gallery = {
    "https://example.com/image1.jpg",
    "/backgrounds/screenshot.jpg",
}

Supports external URLs and local file paths. Players can click images to view them fullscreen.

Server Updates


Config.Updates = {
    {
        title = "Update V1.1",
        description = "Description of the update."
    },
}


Config.LinkButtons = {
    {
        icon = [[<svg>...</svg>]],
        ButtonId = "discord",
        url = "https://discord.gg/yourserver"
    },
}

Clickable social media buttons in the top-right corner. Icons use SVG format.

Team Showcase


Config.Team = {
    {
        role = 'Owner',
        name = 'Player Name',
        avatar = 'https://example.com/avatar.png'
    },
}

Translations


Config.Translations = {
    rules = 'Rules',
    gallery = 'Gallery',
    team = 'Team',
    updates = 'Updates',
    keyboard = 'Keyboard',
    keybindings = 'KEYBINDINGS',
    playersOnline = 'Players Online',
    loadingTitle = 'THE CITY IS LOADING',
    loadingSubtitle = 'LOADING ASSETS...',
    noRules = 'No rules configured yet',
    noGallery = 'No images in gallery yet',
    noTeam = 'No team members added yet',
    noUpdates = 'No updates available yet',
}

All UI text is fully customizable for multi-language support.

Online Players

The online player count is automatically updated by server.lua — no configuration needed. Config.OnlinePlayers is just a fallback value.