Back to Docs
Documentation
Complete guide for setting up Multy LoadingScreen on your FiveM server
Installation
Download
Download the loading screen from the CFX portal: Cfx Portal
Server Config
Add the following to your server.cfg
:
ensure multy-loadscreen-local
Configuration
Edit js/config.js
:
Server Settings
"server": {
// Server name
"name": "Your Server Name",
// Split name for visual effect
"nameLine1": "Your",
"nameLine2": "Server",
// Server description
"description": "Your server description here",
// Logo path
"logo": "../assets/images/logo.png",
// CFX.re link for player data
"cfxLink": "https://cfx.re/join/xxxxx",
// Social links (empty "" to hide)
"socials": {
"discord": "https://discord.gg/your-discord",
"instagram": "",
"youtube": "",
"twitter": ""
}
}
Theme
// Available: "blue", "green", "purple", "orange", "red", "cyan"
"theme": "orange"
Debug Mode
// Set false for production
"debug": false
Background Video
"video": {
// Background video URL (MP4)
"url": "https://your-video-url.mp4"
}
Music Player
"music": {
"enabled": true,
"volume": 30,
"tracks": [
{
"name": "Song Name - Artist",
"file": "../assets/music/song1.mp3"
},
{
"name": "Song 2 - Artist 2",
"file": "../assets/music/song2.mp3"
}
]
}
Staff Members
"staff": [
{
"name": "Staff Name",
"role": "Owner",
"avatar": "../assets/images/staff/avatar.png"
}
]
Loading Messages
"loadingStages": [
{
"message": "Initializing connection...",
"detail": "Establishing secure connection to server"
},
{
"message": "Loading game assets...",
"detail": "Downloading required resources"
}
]
Assets
Logo
- Replace
assets/images/logo.png
- Recommended: 200x200px PNG
Staff Avatars
- Add to
assets/images/staff/
- Recommended: 100x100px
Music Files
- Add MP3 files to
assets/music/
- Update tracks in config
Final Step
Restart server after changes.