Additional Informations

Page dedicated to Additional Informations about our Loading Screen

Core Features

• Component Modularity: Toggle every single UI element on or off via Config.Components (Logo, Hotkeys, Audio Player, Staff Showcase, FAQ, etc.).

• Dynamic Announcements: Inform players about updates, sales, or events directly on the loading screen using the rich announcement cards.

• Interactive UI: Players can browse images, read FAQs, and control the music volume while waiting for the game engine to initialize.

Developer API (Natives & Loading Control)

While loading screens operate primarily in a NUI (browser) context separate from the main game loop, there are times when custom server frameworks need to manually control when the loadscreen disappears.

Manual Shutdown: If your fxmanifest.lua has loadscreen_manual_shutdown 'yes' enabled, the loadscreen will stay open indefinitely until you explicitly close it. This is useful for keeping the loading screen active while custom character selectors or login scripts load assets.

To terminate the loading screen from another client resource (such as your spawning, login, or multicharacter script), you should call the standard FiveM client natives:

-- CLIENT-SIDE
-- Call this once the player character is fully loaded, spawned, and ready to play.
RegisterNetEvent('myFramework:playerFullyLoaded', function()
    -- Perform custom camera movements, ped spawning, etc.
    DoScreenFadeOut(0)
    
    -- Terminate the loading screen UI and native game overlay
    ShutdownLoadingScreen()
    ShutdownLoadingScreenNui()
    
    -- Fade the game back in smoothly
    Wait(1000)
    DoScreenFadeIn(1000)
end)

Frequently Asked Questions (Q&A)

Q: How do I change the icons used in the menu? A: The script utilizes the Iconify framework. You can search for thousands of free icons at Iconify Design. Simply copy the icon identifier (e.g., lucide:home) and paste it into your Config.Icons.

Q: Why isn't the music playing automatically when I join? A: Modern web browsers (including the Chromium Embedded Framework used by FiveM) enforce strict autoplay policies to prevent unwanted audio. Audio will only begin playing once the user interacts with the screen (e.g., clicking anywhere, pressing a hotkey).

Q: How do I use local files instead of web URLs? A: Place your media files inside the web/dist folder (we recommend creating an assets subfolder). You can then reference them using relative paths in your config: "assets/background1.jpg".