Installation

Requirements

• A working FiveM server (FXServer)
• Access to your server's resources/ folder
• (Optional) A Discord bot if you want automatic patchnotes — see Discord patchnotes

Steps

1. Place the resource

Copy the script folder into your server's resources/, for example:

resources/[loading]/loading_screen_script/

WARNING

The folder name must not contain spaces or special characters.

2. Start the resource

Add the following line to your server.cfg:

ensure loading_screen_script

Replace loading_screen_script with your folder's exact name.

3. Allow HTTP requests (for Discord)

If you use Discord patchnotes, the server needs to make outbound requests. This is enabled by default on FXServer, but make sure nothing blocks it (firewall, proxy). See Discord patchnotes.

4. Configure the content

Open config/config.js and customize:

• the server logo
• the theme color
• the music tracks
• the sections (rules, gallery, team, news)
• the social links

See General configuration.

5. Add your media

Drop your files into the dedicated folders:

Type	Folder	Formats
Server logo	config/server_logo/	.png .jpg .jpeg
Music	config/song/	.mp3
Gallery images	config/gallery_image/	.jpg .jpeg .png
Team photos	config/team_logos/	.png .jpg .jpeg
Background video	config/background_video/	.mp4
News videos	config/news_video/	.mp4

IMPORTANT

As long as you use the folders and formats listed above, there's nothing else to do — they're already handled. Only an unusual format (e.g. .webp) would need adding to the files {} block of fxmanifest.lua.

6. Restart

Restart your server (or restart loading_screen_script) and connect to see the result.

Verify everything works

• The loading screen appears on connection.
• Music starts (click if autoplay is blocked by the browser).
• Sections appear in the left navigation bar.
• If Discord is configured, the UPDATE section shows the patchnotes.

TIP

If something goes wrong, enable debug mode (debug: true in config.js and Debug = true in discord.lua) then check the console: F8 in-game for the NUI, the FXServer console for the server.