โš™๏ธFull Configuration Breakdown

๐Ÿ”น Server-Side & Client-Side (Lua) โ€” config.lua

๐Ÿ”ง Core Settings

Config.debugMode = false              -- Enables debug messages in console
Config.PrintPlayerConnecting = false -- Log player connection even if debug is off

โฑ Fade Timings

Config.fadeOut = 500     -- Time (ms) to fade out screen after loading
Config.waitTime = 2500   -- Time (ms) before fade-in starts
Config.fadeIn = 2500     -- Time (ms) for screen to fade in

๐ŸŽฅ Sky-to-Ground Transition

Config.transition = {
    enabled = true,
    startHeight = 500.0,
    randomDistance = 750.0,
    startDistance = 100.0,
    randomDirection = true,
    cameraPosition = nil,
    useCustomStartPosition = false,
    cameraHeading = nil,
    useCustomHeading = false,
    smoothHeading = true,
    fov = 120.0,
    transitionTime = 5000,
    fadeInTime = 1000,
    fadeOutTime = 500
}

๐Ÿ’ฌ Hooks (Optional Function Calls)

Config.OnPlayerSpawn = function(source)
    -- Trigger custom server code here, e.g.:
    -- TriggerClientEvent('chat:addMessage', source, { args = { '^1Server', 'Welcome!' } })
end

Config.OnClientStart = function()
    -- Trigger client-side logic, e.g.:
    -- TriggerEvent('esx:showNotification', 'Welcome to the server!')
end

๐Ÿ”ธ Front-End / UI Config (JS) โ€” config.js

๐Ÿงฉ Server Name

serverName: {
    text: "Your Server Name",
    fontSize: "4rem",
    fontWeight: "700",
    textTransform: "uppercase",
    letterSpacing: "2px",
    textShadow: true,
    position: "center"
}

๐Ÿ–ฑ Cursor

cursor: {
    useCustomCursor: true,
    cursorType: "custom",
    customCursorPath: "assets/images/cursor.png"
}

๐ŸŽต Music Options

music: {
    useLocalMusic: true,
    useStream: false,
    localMusicPath: "assets/music/background.mp3",
    streamURL: "https://soundcloud.com/yourstream",
    volume: 50,
    showControls: true
}

๐ŸŽฌ Background Media

Type: "youtube", // or "image" / "local_video"

youtubeVideoID: "dQw4w9WgXcQ",
youtubeVolume: 25,
youtubeStartTime: 30,

images: [
    "assets/images/bg1.jpg",
    "assets/images/bg2.jpg"
],
imageChangeInterval: 7000,

localVideo: "assets/videos/background.mp4",
localVideoVolume: 30

๐ŸŽจ UI Colors

colors: {
    primaryColor: "rgb(255, 0, 0)",
    secondaryColor: "rgb(241, 151, 15)",
    backgroundColor: "rgba(0, 0, 0, 0.6)",
    textColor: "rgb(255, 255, 255)",
    secondaryTextColor: "rgb(204, 204, 204)",
    glowColor: "rgba(212, 22, 22, 0.7)",
    tabBackgroundColor: "rgba(0, 0, 0, 0.6)",
    tabBorderColor: "rgba(255, 255, 255, 0.1)"
}

๐Ÿ“ Layout Settings

layout: {
    sidebarWidth: "300px",
    sidebarPosition: "left",
    sidebarHidden: true,
    serverNamePosition: "center",
    loadingBarPosition: "bottom",
    contentPadding: "20px"
}

๐ŸŒ Social Media Sidebar

Media: {
    enabled: true,
    showLabels: false,
    sidebarHidden: false,
    sidebarWidth: "100px",
    sidebarWidthWithLabels: "300px",
    iconPadding: "20px",
    links: [
        { platform: "discord", icon: "fab fa-discord", url: "https://discord.gg/yourserver", label: "Join our Discord" },
        { platform: "instagram", icon: "fab fa-instagram", url: "https://instagram.com/yourserver", label: "Follow on Instagram" }
    ]
}

๐Ÿงพ Tabs

tabs: {
    rules: {
        enabled: true,
        title: "Rules",
        icon: "fas fa-gavel",
        content: `
            <ol>
                <li>No cheating</li>
                <li>Respect others</li>
                <li>Have fun!</li>
            </ol>
        `
    },
    news: {
        enabled: true,
        title: "News",
        icon: "fas fa-newspaper",
        content: `
            <h3>Server Update 1.1</h3>
            <p>New vehicles and missions added!</p>
        `
    }
}

Need Help? Join FiveWorld Discord for config reviews and optimization! ๐Ÿš—๐Ÿ’จ

Last updated