Skip to content

Configuration

All settings for Kivo Loading Screen are in config.js, in the root of the resource folder. Change the values, save the file, restart the resource and reconnect to the server to see the result.

The defaults in the tables below are the values that ship in config.js.

config.js is plain JavaScript. Everything sits inside one block:

window.KivoConfig = {
theme: { /* ... */ },
background: { /* ... */ },
// ... more sections
}

Keep the first line (window.KivoConfig = {) and the closing } at the end.

  • Every field is optional. If you delete a field or a section, the loading screen uses a built-in value instead of failing. The built-in values can differ from the shipped ones, so keep every field you care about in the file.
  • Lists replace, they do not merge. If you write staff: [] the Team panel is empty and hidden. If you write your own staff list, only your entries are used.
  • Sections can be removed. Empty a list or set enabled: false and the matching button or panel disappears. Nothing else is affected.
  • Syntax matters. Put a comma after every field and every list entry. Use straight quotes "like this". A syntax error stops the whole file from loading. See Troubleshooting.
  • Comments start with // and are ignored.

Anywhere an image, video or audio file is asked for you can use one of two forms:

Form Example Notes
Path inside the resource "images/logo.png", "music/song.mp3" Start with the folder name. No leading slash. Case sensitive on Linux
Full web address "https://example.com/logo.png" Must start with https://

The folders images/ and music/ are ready to use. See Installation for how to add files and how to use another folder.

Section What it controls How to hide it
theme Main and secondary accent colors Cannot be hidden
background Image, video or color behind everything, overlay, blur Set type: "color" for a plain color
logo Text or image logo, top left enabled: false
progress Loading bar, title, status text, percentage enabled: false
music Music player and playlist enabled: false or tracks: []
nav Which panel buttons show at the top Set each button to false
links Social buttons, top right links: []
server Player count and location pill See server
staff Team panel staff: []
rules Rules panel rules: []
updates Updates (changelog) panel updates: []
events Reserved for future use Leave as []
keybinds On-screen keyboard panel enabled: false or binds: []

The two accent colors used across the screen: buttons, highlights, the loading bar and the music player. Text on top of the main color is chosen automatically so it stays readable.

Option Default Valid values Description
mainColor "#FF619B" Hex color string Primary accent
secondaryColor "#5FEABE" Hex color string Secondary accent
theme: {
mainColor: "#FF619B",
secondaryColor: "#5FEABE",
},
Option Default Valid values Description
type "video" "image", "video", "color" What fills the screen
image "images/background.png" Asset path Shown when type is "image". This file is not shipped, you must add it
overlay "images/backdrop.png" Asset path of a PNG, or "" Drawn on top of the background, for example a vignette or gradient. Use "" to turn it off
video "images/background.mp4" Asset path of an .mp4 or .webm Looping video used when type is "video"
videoMuted true true, false Keep this true. The music player handles audio
color "#0B0B0B" Hex color string Solid color. Shown when type is "color", and used as the fallback when a file cannot be loaded
blur 0 Number of pixels, 0 for off Blurs the image or video. The overlay is not blurred

Behavior:

  • type: "image" shows image. If that file is missing or fails to load, the screen falls back to video (if one is set), then to color.
  • type: "video" plays video in a loop. If the video cannot play, the screen falls back to the color.
  • type: "color" shows only color. The image and video are not shown.
  • The overlay is hidden on its own if its file is missing.
background: {
type: "image",
image: "images/background.png",
overlay: "images/backdrop.png",
video: "images/background.mp4",
videoMuted: true,
color: "#0B0B0B",
blur: 0,
},

The logo sits in the top left corner.

Option Default Valid values Description
enabled true true, false false hides the logo
type "text" "text", "image" Text wordmark or an image
title "KIVO" Text Large text of the wordmark
subtitle "Roleplay" Text Smaller text in the main color under the right end of the title
image "images/logo-mark.png" Asset path Image used when type is "image"
  • With type: "text", image is not used.
  • With type: "image", title and subtitle are not shown. The image is scaled down to a small height, so use a wide image with a transparent background.
  • If the logo image fails to load, the text logo is shown instead.

The loading bar at the bottom of the screen. The percentage and the width of the bar follow the real loading progress of the game. They cannot be set by hand.

Option Default Valid values Description
enabled true true, false false hides the whole bar, including the percentage
title "Now Loading" Text Text above the status line
subtitle "Downloading assets, the city is waking up..." Text Fixed text under the title
showLiveStatus true true, false When true, the line under the title shows live status text from the game as it loads. Until the first status arrives, the fixed subtitle is shown. When false, the fixed subtitle is always shown

The music player sits at the bottom center, above the loading bar. It plays only while the loading screen is open.

Option Default Valid values Description
enabled true true, false false hides the player and plays nothing
autoplay true true, false Try to start playing automatically. See autoplay
volume 0.4 0.0 to 1.0 Starting volume. Players can change it with the volume slider or mute button for the current loading screen
loop true true, false Repeats a single-track playlist. See below for playlists
shuffle false true, false Plays the tracks in a random order, chosen once each time the screen opens
tracks One sample song List of tracks The playlist. An empty list [] hides the player
  • With one track, loop: true repeats it. With loop: false it stops at the end.
  • With two or more tracks, the next track starts when one ends, and the playlist returns to the first track after the last one.
  • Players can use the previous and next buttons and the seek bar at any time. Seeking does not work on live streams.
Option Example Description
title "Questions First" Song title shown in the player
artist "Robson UK" Artist name shown under the title
cover "images/music-cover.png" Cover art, an asset path. If it is missing or fails to load, a speaker icon is shown
url "music/Questions-First.mp3" Required. A local file in music/ or a direct https:// link to an audio file or stream
music: {
enabled: true,
autoplay: true,
volume: 0.4,
loop: true,
shuffle: false,
tracks: [
{
title: "Questions First",
artist: "Robson UK",
cover: "images/music-cover.png",
url: "music/Questions-First.mp3",
},
// { title: "Second Song", artist: "Someone", cover: "images/music-cover.png", url: "music/song2.mp3" },
],
},

A YouTube watch page cannot be played. Use an audio file. See Examples and troubleshooting for local versus hosted audio.

The panel buttons in the top center. A button also hides on its own when its panel has nothing to show.

Option Default Description
updates true Updates button. Hidden if updates is empty
team true Team button. Hidden if staff is empty
rules true Rules button. Hidden if rules is empty
keybinds true Keybinds button. Hidden if keybinds.enabled is false or keybinds.binds is empty

If all four buttons are hidden, the whole button bar disappears.

nav: {
updates: true,
team: true,
rules: true,
keybinds: true,
},

Round social buttons in the top right. Each is clicked to open the address in the player’s normal web browser.

Field Valid values Description
type "Discord", "Web Site", "TikTok", "Instagram", "Twitter" Chooses the icon. Use this exact spelling, including the capitals and the space in Web Site
link Address starting with http:// or https:// Where the button leads
  • Remove an entry to remove its button. links: [] hides the whole group.
  • A type that is not in the list above gives a button without an icon.
  • An address that does not start with http:// or https:// does nothing when clicked.

The shipped list contains sample links. Replace all of them with your own.

links: [
{ type: "Discord", link: "https://discord.gg/your-invite" },
{ type: "Web Site", link: "https://your-server.example" },
{ type: "TikTok", link: "https://www.tiktok.com/@your-server" },
],

A small pill under the logo. It shows the player count and a location.

Option Default Valid values Description
name "Kivo Roleplay" Text Server name stored in the config. The current screen does not display it, so changing it has no visible effect. The name in the top left is set by the logo
location "Los Santos" Text, or "" Text shown next to the player count. "" hides it
current 0 Whole number Fallback player count, used only when live data has not arrived
total 128 Whole number Fallback slot count, used only when live data has not arrived

Behavior:

  • The screen asks your server for the live player count and the server’s slot limit and shows them as current / total. The numbers are refreshed every few seconds while the screen is open.
  • If no live data arrives, current and total are shown instead. Set total to your real slot count so the fallback looks right.
  • The live slot limit is the one set by sv_maxclients in your server.cfg.
  • The player count part is hidden when the slot count is 0. In practice this only happens when no live data arrives and total is 0. If location is also "", the whole pill disappears.
  • No framework resource is needed for the live count. It works the same on standalone, ESX, QBCore and Qbox.

The Team panel is a row of cards. Players click the arrows to move between cards.

Field Example Description
type "Founder" Role badge: "Founder", "Management" or "Developer". Any other text shows no badge
name "Kivo" Name shown on the card
image "images/staff/Kivo.png" Photo, an asset path. Photos are cropped to fill the card, so a square or slightly tall image works best. A missing photo shows the first letter of the name
desc "Founder of the project." Short description
links [{ type: "Discord", link: "https://..." }] Social buttons on the card. Same type and link rules as links. Only the first three are shown

Set staff: [] to hide the Team button and panel.

staff: [
{
type: "Founder",
name: "Alex",
image: "images/staff/alex.png",
desc: "Owner of the server.",
links: [{ type: "Discord", link: "https://discord.gg/your-invite" }],
},
{
type: "Developer",
name: "Sam",
image: "images/staff/sam.png",
desc: "Scripts and maps.",
links: [
{ type: "Web Site", link: "https://your-server.example" },
{ type: "TikTok", link: "https://www.tiktok.com/@sam" },
],
},
],

The Rules panel lists categories on the left and the rules of the selected category on the right. A search box above the list filters the categories by their title.

Each category has these fields:

Field Description
title Category name, shown in the list and used by the search box
desc Short line under the category name on the right
content List of rules

Each rule inside content has:

Field Description
title Rule name
content Rule text

The category list also shows how many rules each category has. Set rules: [] to hide the Rules button and panel.

rules: [
{
title: "General Rules",
desc: "The core rules every player must follow.",
content: [
{
title: "Respect everyone",
content: "Treat every player and staff member with respect.",
},
{
title: "Stay in character",
content: "Keep your character in role while you are in the city.",
},
],
},
],

The Updates panel is a changelog. Entries are shown in the order you list them, and the first one is selected when the panel opens.

Field Example Description
title "Patch Note #1" Entry name in the list, and the heading on the right
date new Date("2026-01-01").getTime() Date as a number of milliseconds. Use the new Date(...) form shown here. The date is shown in the player’s own local date format
version "v1.0.0" Version badge
subtitle "Launch" Heading of the text block
content "Welcome to the server!" Main text
desc "The very first release." Short line under the heading

Set updates: [] to hide the Updates button and panel.

updates: [
{
title: "Patch Note #2",
date: new Date("2026-03-15").getTime(),
version: "v1.1.0",
subtitle: "New jobs",
content: "Two new jobs are available. The garage has been moved.",
desc: "March update",
},
{
title: "Patch Note #1",
date: new Date("2026-01-01").getTime(),
version: "v1.0.0",
subtitle: "Launch",
content: "Welcome to the server!",
desc: "The very first release.",
},
],

Reserved for future use. The current screen does not show events. Leave it as an empty list.

Option Default Description
events [] Planned format of an entry: { name, hour, image }

The Keybinds panel shows a full on-screen keyboard. The keys you list light up in the main color, and hovering a key shows its label.

Option Default Description
enabled true false hides the Keybinds button and panel
binds Eight sample binds List of { key, label } entries. An empty list hides the panel

Each entry in binds:

Field Description
key One physical key. Not case sensitive
label Text shown when the player hovers the key, for example "Open inventory"

Valid keys:

  • Letters a to z and digits 0 to 9
  • F1 to F12
  • Esc, Tab, Caps Lock, Shift, Ctrl, Alt, Enter, Backspace, Space
  • Arrows: Up, Down, Left, Right

Common spellings such as up, space, control and escape are also understood.

Rules for entries:

  • Use one key per entry. Combinations such as "Ctrl+E" are not supported, so pick the main key only.
  • Use one entry per key. If two entries use the same key, only one of them is shown.
  • Keep labels short, about 24 characters or fewer.
keybinds: {
enabled: true,
binds: [
{ key: "F1", label: "Open phone" },
{ key: "F2", label: "Open inventory" },
{ key: "e", label: "Interact" },
{ key: "g", label: "Toggle engine" },
{ key: "Space", label: "Handbrake" },
],
},

Mapping every key by hand is slow. config.js includes a prompt you can give to any AI assistant (for example ChatGPT or Claude). Give it your own list of keybinds and paste the array it returns into binds. A shortened version of the prompt:

You generate the `binds` array for the Kivo FiveM loading screen on-screen keyboard.
Output ONLY a JavaScript array of objects, nothing else. Each object is:
{ key: "<physical key>", label: "<short action name>" }
Rules:
- `key` must be a single physical key from this set (case-insensitive):
a-z, 0-9, F1-F12, Esc, Tab, Caps Lock, Shift, Ctrl, Alt, Enter,
Backspace, Space, Up, Down, Left, Right.
- Do not use key combinations (no "Ctrl+E"). Pick the primary key only.
- `label` is a short action in Title Case, at most about 24 characters.
- One entry per key. If two actions share a key, keep the most important.
- Return valid JavaScript with double-quoted strings.
Here are my keybinds (key = action):
F1 = phone, F2 = inventory, E = interact, G = engine, X = hands up, B = seatbelt

Check the result before you paste it. Every entry needs a comma after it.