Config reference¶
Every option in config.json, generated from the loading screen's source code for the current release.
You rarely need this page: the Config Builder and Build with AI write config.json for you and show a live preview. Use it when you edit the file by hand.
config.json lives at html/config.json inside the 4zam_loading resource. Restart the resource after editing it. Images, videos and audio can be full URLs or paths inside the resource such as ./assets/bg.webm. Values are shown the way you write them in JSON.
Fields at a glance¶
| Field | Type | Builder | What it does |
|---|---|---|---|
language |
string | Settings menu | Language of the loading-screen text. |
mirrorLayout |
boolean | config.json only | Mirror the whole layout right to left (panels and watermark swap sides). |
selectedColor |
string | Brand & Color | Accent color used across the screen (title highlight, buttons, cards). |
backgroundImage |
string | Background | Background image: a URL or a path inside the resource such as ./assets/bg.png. |
backgroundVideo |
string or (string or object)[] or null | Background | Background video. |
videoUrl |
string | config.json only | Legacy single-video field from early versions, read only when backgroundVideo is absent. |
videoAsAudio |
boolean | Background | Whether the background video is the audio source. |
watermark |
object | Brand & Color | The server name, subheading and logo shown in the corner of the screen. |
socialHeaders |
object[] | Social Links | Social and link cards in the header (Discord, store and so on). |
rules |
string[] | Rules | Server rules shown in the Rules panel, one string per rule. |
teamMembers |
object[] | Team | Staff cards shown in the Team panel. |
customPanels |
object[] | Custom Panels | Extra tabs with your own list content (updates, guides, jobs and so on). |
gallery |
object[] | Gallery | Images in the Gallery panel. |
keyboardShortcuts |
object | Keyboard | Keybind hints shown on the on-screen keyboard. |
music |
object[] | Music | Music playlist (.mp3). |
defaultVolume |
number | Music | Starting player volume in percent. |
language¶
Language of the loading-screen text. Arabic (ar) and Urdu (ur) render right to left. Missing or unknown values fall back to English.
Type: string, optional.
Allowed values: 12 allowed values.
Default: "en".
Set for you: the builder writes the language you pick in its settings menu.
language allowed values¶
| Value | What it does |
|---|---|
"en" |
English |
"en-GB" |
English (UK) |
"es" |
Español |
"de" |
Deutsch |
"fr" |
Français |
"it" |
Italiano |
"nl" |
Nederlands |
"pl" |
Polski |
"pt" |
Português |
"hi" |
हिन्दी |
"ar" |
العربية, right to left |
"ur" |
اردو, right to left |
mirrorLayout¶
Mirror the whole layout right to left (panels and watermark swap sides). Independent of language, which only changes text direction.
Type: boolean, optional.
Default: false.
Not in the builder: set it in config.json by hand.
selectedColor¶
Accent color used across the screen (title highlight, buttons, cards). Hex (#7C3AED) or rgb()/rgba()/hsl()/hsla(). Anything else falls back to the default.
Type: string.
Default: "#FF8A4D".
Edit it in the Config Builder under Brand & Color.
backgroundImage¶
Background image: a URL or a path inside the resource such as ./assets/bg.png. Shown when there is no video, or when every video fails.
Type: string.
Default: "".
Edit it in the Config Builder under Background.
backgroundVideo¶
Background video. Either one URL (a local .webm/.mp4 path or a YouTube link) or a list of videos the player can skip between. A video takes priority over backgroundImage.
Type: string or (string or object)[] or null, optional.
Edit it in the Config Builder under Background.
| Key | Type | Allowed values | Default | Description |
|---|---|---|---|---|
backgroundVideo[].url |
string | Video URL: a local .webm/.mp4 path or a YouTube link. |
||
backgroundVideo[].title |
string, optional | Name shown in the player for this video. Falls back to the watermark title. | ||
backgroundVideo[].subtitle |
string, optional | Line shown under the title. Falls back to the watermark subheading. |
videoUrl¶
Legacy single-video field from early versions, read only when backgroundVideo is absent. Use backgroundVideo instead.
Type: string, optional.
Not in the builder: set it in config.json by hand.
videoAsAudio¶
Whether the background video is the audio source. true: the player controls the video (play, pause, scrub, volume). false: the video loops muted and the player drives the music playlist. When omitted, the video is the audio source only if there is no music playlist.
Type: boolean, optional.
Edit it in the Config Builder under Background.
watermark¶
The server name, subheading and logo shown in the corner of the screen.
Type: object.
Edit it in the Config Builder under Brand & Color.
| Key | Type | Allowed values | Default | Description |
|---|---|---|---|---|
watermark.label |
object | The title line. | ||
watermark.label.text |
string | The main title text, usually your server name. | ||
watermark.label.colorWordCount |
number | 1 |
How many words of text, counted from the start, get the accent color. |
|
watermark.label.animation |
string, optional | 9 allowed values | "wave" |
Title animation preset. Missing or unknown values use wave. The sheen (below) layers on top of any preset. |
watermark.label.sheen |
boolean, optional | true |
Sweeping light sheen across the title. Set false to turn it off. |
|
watermark.subHeading |
string | Smaller line shown under the title. | ||
watermark.logo |
string | Logo image: a URL or a path inside the resource. |
watermark.label.animation allowed values¶
| Value | What it does |
|---|---|
"none" |
No motion: the title fades in and stays still. |
"wave" |
Each letter gently bobs up and down in sequence. The default. |
"wave-reverse" |
The same bob, staggered right to left. |
"bounce" |
A snappier, springier hop on each letter. |
"ripple" |
Letters scale-pop in sequence, like a travelling ripple. |
"sway" |
The whole title rocks gently left and right. |
"reveal" |
The title wipes in left to right, holds, then wipes out, on a loop. |
"slam" |
The title punches in with a sharp impact, repeating now and then. |
"pulse" |
The title thumps to a beat, with a synced underline glow. |
socialHeaders¶
Social and link cards in the header (Discord, store and so on). Cards with enabled: false are hidden.
Type: object[].
Edit it in the Config Builder under Social Links.
| Key | Type | Allowed values | Default | Description |
|---|---|---|---|---|
socialHeaders[].type |
string | "discord", "instagram", "telegram", "youtube", "tiktok", "custom" |
Platform icon to show, lowercase and spelled exactly. Use custom to supply your own icon image. |
|
socialHeaders[].imagePath |
string, optional | Custom icon image (URL or resource path). Used with type: "custom". |
||
socialHeaders[].imageWidth |
string, optional | Custom icon width, any CSS size such as 3vw or 32px. |
||
socialHeaders[].imageHeight |
string, optional | Custom icon height, any CSS size such as 3vh or 32px. |
||
socialHeaders[].cardLabel |
string | Card title. | ||
socialHeaders[].cardInfo |
string | Short description under the card title. | ||
socialHeaders[].link |
string | URL opened by the card button. | ||
socialHeaders[].buttonLabel |
string | Button text. When empty, a localized default such as "Join" is used. | ||
socialHeaders[].enabled |
boolean | true |
Show this card on the screen. |
rules¶
Server rules shown in the Rules panel, one string per rule. Use \n for a line break. Five or six short rules read best.
Type: string[], optional.
Edit it in the Config Builder under Rules.
teamMembers¶
Staff cards shown in the Team panel.
Type: object[], optional.
Edit it in the Config Builder under Team.
| Key | Type | Allowed values | Default | Description |
|---|---|---|---|---|
teamMembers[].name |
string | Display name. | ||
teamMembers[].role |
string | Role or position shown under the name. | ||
teamMembers[].discord |
string | Discord username, or any short label. | ||
teamMembers[].image |
string | Avatar image (URL or resource path); square images look best. |
customPanels¶
Extra tabs with your own list content (updates, guides, jobs and so on).
Type: object[], optional.
Edit it in the Config Builder under Custom Panels.
| Key | Type | Allowed values | Default | Description |
|---|---|---|---|---|
customPanels[].panelPosition |
number | Where the tab sits in the tab row; lower numbers come first. Defaults to the panel's position in the list. | ||
customPanels[].uniqueId |
string | Unique id for the panel, such as updates. Must differ between panels. Defaults to panel-<n>. |
||
customPanels[].buttonLabel |
string | Tab button text. | ||
customPanels[].icon |
string | 41 preset names | Tab icon: a preset icon name (an fa- prefix and capitals are ignored) or an image. An image is any value ending in .png, .jpg, .jpeg, .gif, .webp or .svg, or starting with http://, https://, ./, ../ or /. Anything else shows the default megaphone icon. Inline SVG code is not supported. |
|
customPanels[].cardHeaderLabel |
string | Heading at the top of the panel. | ||
customPanels[].singularLabel |
string | Label for one entry, such as Update or Tip. |
||
customPanels[].entries |
string[] | The list items, one string each. |
customPanels[].icon preset names¶
Any of these names works, besides the other forms described above.
Preset names: "circle", "bullhorn", "users", "image", "star", "shield", "shield-halved", "gavel", "briefcase", "wrench", "screwdriver-wrench", "tools", "car", "house", "home", "store", "shop", "gift", "crown", "music", "newspaper", "globe", "handshake", "trophy", "flag", "bolt", "heart", "bell", "map", "book", "scroll", "list", "gear", "cog", "hammer", "info", "circle-info", "clipboard", "comments", "phone", "wallet".
gallery¶
Images in the Gallery panel. Players can open one and browse with the arrow keys.
Type: object[], optional.
Edit it in the Config Builder under Gallery.
| Key | Type | Allowed values | Default | Description |
|---|---|---|---|---|
gallery[].path |
string | Image URL or resource path; landscape images look best. |
keyboardShortcuts¶
Keybind hints shown on the on-screen keyboard.
Type: object.
Edit it in the Config Builder under Keyboard.
| Key | Type | Allowed values | Default | Description |
|---|---|---|---|---|
keyboardShortcuts.layout |
string, optional | "ansi", "iso", "jis" |
"ansi" |
Physical keyboard layout to draw. |
keyboardShortcuts.locale |
string, optional | Locale for the key labels, such as de-DE. It translates special keys (Shift, Enter) and sets the letter layout: German shows QWERTZ, French AZERTY and everything else QWERTY. When omitted, follows language. |
||
keyboardShortcuts.keys |
object[] | The highlighted keys. | ||
keyboardShortcuts.keys[].key |
string | 72 allowed values | The key to highlight. Case does not matter (Left Arrow matches LEFT ARROW); letters and numbers are written as themselves. A key your layout does not draw is never highlighted. |
|
keyboardShortcuts.keys[].onFoot |
string or null | Hint shown while on foot, or null for none. |
||
keyboardShortcuts.keys[].inCar |
string or null | Hint shown while in a vehicle, or null for none. |
keyboardShortcuts.keys[].key allowed values¶
Allowed values: "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "`", "-", "=" (ANSI and ISO layout only), "BACKSPACE", "TAB", "Q", "W", "E", "R", "T", "Y", "U", "I", "O", "P", "[", "]", "\\", "CAPS LOCK", "A", "S", "D", "F", "G", "H", "J", "K", "L", ";", "'" (ANSI and ISO layout only), "ENTER", "LSHIFT", "Z", "X", "C", "V", "B", "N", "M", ",", ".", "/", "UP ARROW", "RSHIFT", "LCTRL", "WIN", "LALT", "SPACE", "RALT", "RCTRL", "LEFT ARROW", "DOWN ARROW", "RIGHT ARROW", "#" (ISO layout only), "ISO_EXTRA" (ISO layout only), "^" (JIS layout only), "@" (JIS layout only), ":" (JIS layout only), "JIS_EXTRA" (JIS layout only), "~" (same key as `), "\\|" (same key as ISO_EXTRA, ISO layout only), "\\_" (same key as JIS_EXTRA, JIS layout only).
music¶
Music playlist (.mp3). Tracks play in order. With no tracks and no video audio, the player is hidden.
Type: object[], optional.
Edit it in the Config Builder under Music.
| Key | Type | Allowed values | Default | Description |
|---|---|---|---|---|
music[].path |
string | Audio file URL or resource path (.mp3). |
||
music[].title |
string | Track title. | ||
music[].artist |
string | Artist name. | ||
music[].image |
string or null | Cover art (URL or resource path), or null for none. |
defaultVolume¶
Starting player volume in percent. Values outside the range are clamped.
Type: number.
Range: 0 to 100.
Default: 100.
Edit it in the Config Builder under Music.
Full example¶
The stock config.json that ships with this release (the one behind the live preview).
Stock config.json
{
"language": "en",
"selectedColor": "#7C3AED",
"backgroundImage": "https://dl.4zam.dev/images/png/supra16x9.png",
"backgroundVideo": "https://dl.4zam.dev/videos/mp4/fivem_intro.mp4",
"videoAsAudio": false,
"watermark": {
"label": {
"text": "The Vibe RP",
"colorWordCount": 2,
"animation": "wave",
"sheen": true
},
"subHeading": "Loading Screen",
"logo": "https://dl.4zam.dev/images/png/vibe-logo.png"
},
"socialHeaders": [
{
"type": "discord",
"cardLabel": "Discord Server",
"cardInfo": "Join the discord to keep up with the latest on the FiveM server!",
"link": "https://discord.gg/BetjMuDbC2",
"enabled": true
},
{
"type": "instagram",
"cardLabel": "Instagram Page",
"cardInfo": "Follow the instagram page for more content!",
"link": "https://instagram.com/FakalMate",
"enabled": true
},
{
"type": "telegram",
"cardLabel": "Telegram Channel",
"cardInfo": "Join the telegram channel for more news and updates!",
"link": "https://telegram.com",
"enabled": false
},
{
"type": "youtube",
"cardLabel": "Youtube Channel",
"cardInfo": "Subscribe to the youtube channel for more updates!",
"link": "https://youtube.com/FakalMate",
"enabled": true
},
{
"type": "tiktok",
"cardLabel": "Tik Tok Channel",
"cardInfo": "Follow us on tik tok for more content!",
"link": "https://www.tiktok.com/@fakal.mate",
"enabled": true
},
{
"type": "custom",
"cardLabel": "Tebex Store",
"cardInfo": "Purchase perks and content through our Tebex store!",
"link": "https://the-vibe-store.tebex.io/",
"buttonLabel": "Shop Now",
"enabled": true,
"imagePath": "./assets/jpg/tebex.jpg",
"imageWidth": "3vw",
"imageHeight": "3vh"
}
],
"customPanels": [
{
"panelPosition": 3,
"uniqueId": "updates",
"buttonLabel": "Updates",
"icon": "gavel",
"cardHeaderLabel": "Latest City Updates",
"singularLabel": "Update",
"entries": [
"Daily job based quests with reward system",
"Loot boxes with provable fairness and security",
"New 200+ lore friendly vehicles added with more on the way",
"Vehicle rarity system with discord webhook integrations"
]
}
],
"rules": [
"No griefing or trolling other players.",
"Respect all admins and staff decisions.",
"No hacking, exploiting, or modding\nin unfair ways.",
"Keep your behavior mature\nand respectful at all times.",
"Do not spam the chat\nor use slurs or hate speech."
],
"teamMembers": [
{
"name": "GucciFlipFlops",
"role": "Head Developer",
"discord": "fakal.mate",
"image": "https://dl.4zam.dev/images/png/fakalheadshot.png"
},
{
"name": "HerGTR",
"role": "Founding Member",
"discord": "dwboutit",
"image": "https://dl.4zam.dev/images/png/gatorheadshot.png"
},
{
"name": "Mitch",
"role": "Founding Member",
"discord": "builtlikemitch",
"image": "https://dl.4zam.dev/images/png/mitchheadshot.png"
},
{
"name": "GucciFlipFlops",
"role": "Marketing Manager",
"discord": "fakal.mate",
"image": "https://dl.4zam.dev/images/png/fakalheadshot.png"
},
{
"name": "GucciFlipFlops",
"role": "Sales Director",
"discord": "fakal.mate",
"image": "https://dl.4zam.dev/images/png/fakalheadshot.png"
},
{
"name": "GucciFlipFlops",
"role": "Community Manager",
"discord": "fakal.mate",
"image": "https://dl.4zam.dev/images/png/fakalheadshot.png"
}
],
"gallery": [
{
"path": "https://dl.4zam.dev/images/jpg/fivemsupranrcisist.jpg"
},
{
"path": "https://dl.4zam.dev/images/jpg/sunsetsupraitsugsik.jpg"
},
{
"path": "https://dl.4zam.dev/images/jpg/midiguess.jpg"
},
{
"path": "https://dl.4zam.dev/images/jpg/hellcatdurangoitsugsik.jpg"
},
{
"path": "https://dl.4zam.dev/images/jpg/IMG_2135.jpeg"
},
{
"path": "https://dl.4zam.dev/images/png/oldies2.png"
},
{
"path": "https://dl.4zam.dev/images/png/oldies1.png"
},
{
"path": "https://dl.4zam.dev/images/png/supra6.png"
},
{
"path": "https://dl.4zam.dev/images/png/supra5.png"
},
{
"path": "https://dl.4zam.dev/images/jpg/mitch-donk1.jpg"
},
{
"path": "https://dl.4zam.dev/images/jpg/mitch-donk2.jpg"
},
{
"path": "https://dl.4zam.dev/images/jpg/mitch-donk3.jpg"
},
{
"path": "https://dl.4zam.dev/images/png/supra3.png"
},
{
"path": "https://dl.4zam.dev/images/png/supra4.png"
},
{
"path": "https://dl.4zam.dev/images/png/bluebmw.png"
},
{
"path": "https://dl.4zam.dev/images/png/headshot.png"
},
{
"path": "https://dl.4zam.dev/images/png/supra2.png"
},
{
"path": "https://dl.4zam.dev/images/jpg/rarri_lol.jpg"
}
],
"keyboardShortcuts": {
"layout": "ansi",
"keys": [
{
"key": "`",
"onFoot": "Point",
"inCar": "Put on seatbelt"
},
{
"key": "Left Arrow",
"onFoot": null,
"inCar": "Left Indicator"
},
{
"key": "Right Arrow",
"onFoot": null,
"inCar": "Right Indicator"
},
{
"key": "Up Arrow",
"onFoot": null,
"inCar": "Hazard Lights"
},
{
"key": "M",
"onFoot": "Pull out phone",
"inCar": null
},
{
"key": "L",
"onFoot": "Lock vehicle",
"inCar": null
},
{
"key": "G",
"onFoot": null,
"inCar": "Toggle vehicle engine on/off"
},
{
"key": "J",
"onFoot": "Park vehicle",
"inCar": null
},
{
"key": "Z",
"onFoot": "Open radial menu",
"inCar": null
},
{
"key": "X",
"onFoot": "Hands up",
"inCar": null
},
{
"key": "0",
"onFoot": null,
"inCar": "Vehicle controller"
},
{
"key": "LALT",
"onFoot": "Third eye view",
"inCar": null
}
]
},
"music": [
{
"path": "https://dl.4zam.dev/images/mp3/1008gs.mp3",
"title": "1008 Grams",
"artist": "OT7 Quanny",
"image": null
},
{
"path": "https://dl.4zam.dev/images/mp3/free_g.mp3",
"title": "Free G",
"artist": "SDot Go",
"image": null
},
{
"path": "https://dl.4zam.dev/images/mp3/gta.mp3",
"title": "GTA",
"artist": "Future, Metro Boomin",
"image": null
},
{
"path": "https://dl.4zam.dev/images/mp3/like_that.mp3",
"title": "Like That",
"artist": "Future, Metro Boomin",
"image": null
},
{
"path": "https://dl.4zam.dev/images/mp3/stop_me.mp3",
"title": "Stop Me When I'm Lyin'",
"artist": "RX Papi",
"image": null
},
{
"path": "https://dl.4zam.dev/images/mp3/type_shi.mp3",
"title": "Type Shit",
"artist": "Future, Metro Boomin",
"image": null
}
],
"defaultVolume": 1
}