> For the complete documentation index, see [llms.txt](https://fb-scripts.gitbook.io/fb-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fb-scripts.gitbook.io/fb-scripts/scripts/fb-loadingscreen/configuration.md). # Configuration All customization is done inside the `CONFIG` object in `ui/config.js`. *** #### 🌐 Language ```js language: "en", ``` Sets the UI language. Supported values:
CodeLanguageCodeLanguage
enEnglishruRussian
trTurkisharArabic
deGermanzhChinese
frFrenchjaJapanese
esSpanishkoKorean
ptPortugueseitItalian
idIndonesianthThai
plPolishnlDutch
*** #### 🏠 Server Info ```js server: { name: "Your Server Name", subtitle: "Roleplay", logo: "images/logo.png", backgroundType: "image", background: "images/background.png", }, ``` | Key | Description | | ---------------- | ----------------------------------------------------------- | | `name` | Server name displayed on the loading screen | | `subtitle` | Short tagline shown below the server name | | `logo` | Path to your server logo (inside `ui/images/`) | | `backgroundType` | `"image"` for a static image, `"video"` for a looping video | | `background` | Path to the background file | **Using a video background:** {% stepper %} {% step %} Place your `.mp4` file inside `ui/video/` {% endstep %} {% step %} Set `backgroundType: "video"` {% endstep %} {% step %} Set `background: "video/yourfile.mp4"` {% endstep %} {% endstepper %} *** #### 🔗 Social Links ```js socials: [ { icon: "fa-brands fa-discord", url: "https://discord.gg/yourserver" }, { icon: "fa-brands fa-youtube", url: "https://youtube.com/@yourchannel" }, { icon: "fa-brands fa-instagram", url: "https://instagram.com/yourpage" }, { icon: "fa-brands fa-tiktok", url: "https://tiktok.com/@yourpage" }, { icon: "fa-brands fa-x-twitter", url: "https://x.com/yourpage" }, ], ``` {% hint style="info" %} Each item uses a **Font Awesome** icon class and a URL. You can add, remove, or reorder entries freely. Browse icons at [Font Awesome](https://fontawesome.com/icons). {% endhint %} *** #### 📰 News ```js // Recommended image size: 280x401 px news: [ { title: "New Cars", description: "Short description of the update...", image: "images/news1.png", }, // Add more entries... ], ``` | Key | Description | | ------------- | --------------------------------------------- | | `title` | News headline | | `description` | Short description text | | `image` | Image path (recommended size: **280×401 px**) | **Auto-slide settings:** ```js newsAutoSlide: { enabled: true, interval: 5000, // milliseconds between slides (5000 = 5 seconds) }, ``` *** #### 👥 Team ```js team: [ { name: "PlayerName", role: "Developer", avatar: "images/avatar.png" }, // Add more members... ], ``` | Key | Description | | -------- | --------------------------------------------------- | | `name` | Team member's name | | `role` | Their role/title (e.g. Developer, Admin, Moderator) | | `avatar` | Path to their profile picture | *** #### 💬 Commands ```js commands: [ { name: "/help", description: "Opens the help menu" }, { name: "/report", description: "Report a player to the admins" }, // Add more commands... ], ``` Lists your server's important commands shown on the loading screen. Add as many as you need. *** #### ⌨️ Keyboard Binds ```js keyboardBinds: [ { key: "F1", name: "Phone", description: "Opens your in-game phone" }, { key: "F2", name: "Inventory", description: "Opens your inventory" }, { key: "Tab", name: "Scoreboard", description: "Shows the player scoreboard" }, { key: "Delete", name: "Delete Vehicle",description: "Deletes your current vehicle" }, // Add more binds... ], ``` | Key | Description | | ------------- | --------------------------------------------- | | `key` | The keybind (e.g. `F1`, `Tab`, `Delete`, `E`) | | `name` | Short name for the action | | `description` | Brief explanation of what it does | *** #### 🎵 Music ```js music: { autoplay: true, defaultVolume: 0.5, // Range: 0.0 (mute) → 1.0 (max) playOrder: "random", // "random" or "linear" playlist: [ { name: "Song Title", artist: "Artist Name", cover: "images/cover1.png", src: "audio/song1.mp3", startAt: 0, // Start playback at this second (0 = from beginning) }, // Add more songs... ], }, ``` | Key | Description | | --------------- | --------------------------------------------------------------- | | `autoplay` | `true` to start playing automatically, `false` to wait for user | | `defaultVolume` | Starting volume from `0.0` to `1.0` | | `playOrder` | `"random"` for shuffle, `"linear"` for sequential playback | | `name` | Song title displayed in the player | | `artist` | Artist name displayed in the player | | `cover` | Album art image path | | `src` | Path to the `.mp3` file (place in `ui/audio/`) | | `startAt` | Start playback at this second (e.g. `30` skips the first 30s) | **Adding a new song:** {% stepper %} {% step %} Copy your `.mp3` file into `ui/audio/` {% endstep %} {% step %} Add a new entry to the `playlist` array in `config.js` {% endstep %} {% step %} No changes needed in `fxmanifest.lua` — all `.mp3` files are loaded automatically ✅ {% endstep %} {% endstepper %} *** #### 📂 Categories (Show / Hide Sections) ```js categories: { news: true, // Show the news section team: true, // Show the team section commands: true, // Show the commands section keyboard: true, // Show the keyboard binds section }, ``` Set any category to `false` to hide it from the loading screen. *** #### 🎨 Theme ```js theme: { progressBarFill: "#ffffff", // Progress bar fill color progressBarBg: "rgba(0,0,0,0.5)", // Progress bar background color progressTextColor:"#ffffff", // Loading percentage text color }, ``` Accepts any valid CSS color value (hex, rgb, rgba, hsl, etc.).