Set up your loading screen

The loading screen is what players look at while FiveM loads your server. With the Mechanics module you design it in your control panel instead of editing HTML in a resource. It can show your logo, a slideshow or a YouTube video, music, your rules, your staff, your latest news and a live player count, and it greets each player by name.

Changes go live without restarting anything. You edit a draft, check it in the preview, and publish when it's ready. Players see the published version the next time they join.

Before you start#

• You need to be the owner, or have a role with the Edit and publish the loading screen permission.
• Your game server needs a server key. If you already use the LonexOne FiveM resource, you have one. If not, see Connect your game server.

Install the module#

1. Open your control panel and click Install modules in the sidebar.
2. Find Mechanics and click Install.

Loading screen and Spawn selector links appear under Mechanics in the sidebar.

Design the screen#

1. Click Loading screen in the sidebar.
2. Work down the sections on the left: Look, Background, Music, What it shows and Text.
3. Watch the preview on the right. It updates as you go and plays a pretend loading bar, so you can see the whole screen in motion.

Every change saves to your draft by itself, a moment after you stop typing. The box above the preview says where you are:

For what each section does, see Choose a layout, style and background and Add music, rules and links to your loading screen.

Publish it#

1. Check the preview one last time.
2. Click Publish, next to the preview.

You'll see "Published. Players see it the next time they join." Players already in the server aren't affected.

Add the resource to your game server#

The screen reaches the game through a small resource called lonexone_loadscreen. It sits alongside the main lonexone resource and uses the same server key.

1. Download lonexone_loadscreen from Keymaster, the same place you got the lonexone resource. See Install the LonexOne FiveM resource.

2. Put the lonexone_loadscreen folder in your server's resources folder.

3. Remove any other loading screen resource. A server can only use one.

4. Make sure your server.cfg sets your server key:

   set lonexone_key "lx_..."
   

5. Add this line to server.cfg:

   ensure lonexone_loadscreen
   

6. Restart your server.

You only do this once. From now on, publishing in the control panel is enough.

What players see#

As each player connects, the server asks LonexOne for your loading screen, and the game shows it with a loading bar that follows the real progress.

If the Welcome block is on, the screen greets the player. When their Discord is linked in FiveM and they've signed in to your community site with the same Discord account, it says "Welcome back" with their roleplay name, and their departments and ranks. Otherwise it uses their FiveM name, or says "Welcome to" your community.

Music starts by itself. Players can press Space to pause it.

Something not working?#

Players see a plain screen with "Loading…" and a green bar. That's the fallback. It shows when the resource couldn't get your screen. Check that:

• you've clicked Publish at least once
• the Mechanics module is installed
• lonexone_key is set in server.cfg, and is the key from your community
• LonexOne answered within 4 seconds. If it was slow, the next player gets your screen as normal.

The server console says "lonexone_key is not set in server.cfg, so players get the plain loading screen." Add set lonexone_key "lx_..." to server.cfg, above the ensure lines, and restart the server.

Players still see my old loading screen. Another loading screen resource is still running. Remove it from resources and from server.cfg.

My changes don't show in game. They're probably still a draft. If the box says "You have changes players can't see yet.", click Publish.

The welcome doesn't show a player's name and ranks. The player needs Discord linked in FiveM (Settings, then Connections), and to have signed in to your community site with that same Discord account.

Opening /loading-screen on my site says page not found. Nothing has been published yet, or the module isn't installed.