Skip to content

Installation

Installing Kivo Loading Screen takes a few minutes. You do not need a database, SQL, items or any other resource.

  1. Copy the folder. Put the resource folder into your server’s resources directory. You can name the folder anything. The examples on this site use kivo-loading-screen. The name in your server.cfg must match the folder name exactly.

  2. Stop any other loading screen. Only one loading screen can be active. Remove the ensure or start line of every other loading screen resource, including a default one.

  3. Add the resource to server.cfg. The resource needs no other resource, so it can go anywhere in your list.

    ensure kivo-loading-screen
  4. Add your images and music (see the next section). This step is optional for a first test. The resource ships with a sample background video, a sample song and sample images.

  5. Edit config.js in the root of the resource folder. See Configuration.

  6. Restart the server, or run refresh and restart kivo-loading-screen in the server console.

  7. Reconnect to test. The loading screen only appears while a player is connecting. Disconnect from the server and join again to see your changes.

Only the following parts of the resource are meant to be edited. Leave every other file and folder as it is.

Path Purpose
config.js All settings. This is the only file you need to edit
images/ Your background, overlay, logo, music covers and staff photos
images/staff/ Staff photos for the Team panel
images/events/ Holds a sample image. The events option is reserved, see Configuration
music/ Your local audio files
fxmanifest.lua Only needed for the optional settings described on this page
File Used by
images/background.mp4 The default background video (background.video)
images/backdrop.png The default overlay (background.overlay)
images/logo-mark.png The image logo, used only if you set logo.type to "image"
images/music-cover.png Cover art for the sample song
images/staff/Kivo.png, images/staff/roro.png Photos of the first two sample staff cards
images/events/example.png Sample image for the reserved events option
music/Questions-First.mp3 The sample song
  1. Copy your image file into the images/ folder, or into images/staff/ for staff photos.

  2. In config.js, write the path from the resource root, without a leading slash:

    background: {
    type: "image",
    image: "images/my-background.png",
    },
  3. Restart the resource and reconnect.

Rules for paths:

  • Write the path exactly as the file is named, including capital letters. On a Linux server Kivo.png and kivo.png are different files.
  • Do not start a path with ./ or /. Start with the folder name, for example images/logo.png.
  • Avoid spaces and special characters in file names. Use letters, numbers and hyphens, for example my-logo.png.
  • A full https:// link also works wherever an image path is expected.

You can use a local file or a link to a file on another host. Both are set per track in music.tracks.

Local file

  1. Copy the .mp3 into the music/ folder.

  2. Add a track to config.js:

    music: {
    tracks: [
    {
    title: "My Song",
    artist: "My Artist",
    cover: "images/music-cover.png",
    url: "music/my-song.mp3",
    },
    ],
    },

Direct link

Use the full https:// address of an audio file or stream as the url:

url: "https://example.com/audio/my-song.mp3",

A YouTube page cannot be played. Use a real audio file. For the differences between local and hosted audio, file size advice and autoplay limits, see Examples and troubleshooting.

The resource serves everything inside images/ and music/ to the player. If you want to keep files in another folder, for example videos/, add the folder to the files list in fxmanifest.lua:

files {
-- keep every line that is already in this list, then add:
'videos/**/*', -- your new folder
}

Only add your line. Do not remove or change the existing ones. Then run refresh, restart the resource and reconnect. Files placed in images/ or music/ need no change to the manifest.

Optional: keep the screen open for a spawn or multicharacter script

Section titled “Optional: keep the screen open for a spawn or multicharacter script”

By default FiveM closes the loading screen by itself once the player’s session starts. This works on any server and is what you should use unless you see a problem.

If your multicharacter or spawn script needs the loading screen to stay up until it is ready, you can turn on a manual shutdown. You will see the problem as the loading screen vanishing and the player seeing the game world before your character selection or spawn screen appears.

  1. Open fxmanifest.lua.

  2. Find this line and remove the two dashes at the start so it is active:

    -- loadscreen_manual_shutdown 'yes'

    After the change it reads:

    loadscreen_manual_shutdown 'yes'
  3. Run refresh, restart the resource and reconnect.

With this setting on, the loading screen stays open until another script closes it using the standard FiveM client function ShutdownLoadingScreenNui(). Most multicharacter and spawn scripts do this when they are ready to show their own screen. The loading bar reaching 100 percent does not close it.

If you write your own spawn logic, call the function from client code once the player is ready:

-- Client side, in your own spawn or character script
ShutdownLoadingScreenNui()
  1. Keep a copy of your config.js, and your own files in images/ and music/.
  2. Replace the resource folder with the new version.
  3. Copy your config.js and your files back.
  4. Run refresh, restart the resource and reconnect.