FiveM
FiveM
19 ArticlesHow to Add an MLO to your FiveM Server
MLOs (Map Location Objects) allow you to add custom interiors or modify existing GTA V interiors on your FiveM server. This guide walks you through safely installing an MLO resource so it loads correctly for all players. ::ProseNote{title="Important" description="Please ensure that you have followed the Getting Started with your FiveM Server guide before proceeding with the following steps." appearance="danger"} :: --- Download & Inspect the MLO Package Verify the Source For security and stability, always download MLOs from reputable sources: - Vendors that provide SHA-256 checksums or public Git repositories - Avoid re-packed or modified archives from unknown sources - Check the Folder Structure A valid MLO resource should follow a structure similar to the example below: my-mlo/ โโ stream/ โ โโ .ydr (models) โ โโ .ytyp (interior/item definitions) โ โโ .ybn (collisions, if included) โ โโ .ytd (textures) โโ fxmanifest.lua โโ README.md (optional) If this structure is present, youโre ready to proceed. --- Creating the Assets Directory Once you have setup your server via txAdmin with a framework, you will be able to add resources to your server. We will be using QBCore in the following example. 1. Go to your Shockbyte Control Panel. 2. Navigate to the Files tab, and locate the following directory: . 3. Create a folder in this directory. For this example we will call it: . --- Creating Assets & fxmanifest.lua 1. Navigate to the directory. 2. Create a file by selecting the New File button and create a new file called: . 3. Open the . Enter the following text inside of the file: fxversion 'cerulean' games { 'gta5' } author 'YourName' description 'My Custom MLO' version '1.0.0' thisisamap 'yes' files { 'stream//.ydr', 'stream//.ytyp', 'stream//.ytd', 'stream//.ybn' } datafile 'DLCITYPREQUEST' 'stream//.ytyp' ::ProseNote{title="Note" description="This manifest follows the official FiveM resource manifest standards. Do not remove thisisamap 'yes', as it is required for MLOs to load correctly." appearance="default"} :: 4. Save the file. --- Upload the MLO Resource 1. Navigate to the and create a directory by selecting the New Folder button. 2. Upload the entire MLO folder inside the directory (e.g. my-mlo) without modifying its contents using the Upload File(s) button. --- Activating the Map & Assets in txAdmin For a resource to start automatically, it must be added to the file using the command. You can manage this file easily through the CFG Editor in the txAdmin panel. 1. Go to your Shockbyte Control Panel. 2. Launch txAdmin. 3. Navigate to the CFG Editor area and add the line: and . 4. Click the Save File button at the bottom. --- To learn more about FiveM server hosting, you can browse our library of Knowledgebase articles here.
How to Clear the Cache on your FiveM Client
Clearing your FiveM cache can resolve many common client-side issues such as FPS drops, long loading screens, missing textures, and random crashes. Cache corruption is one of the most frequent causes of FiveM performance problems, and safely clearing it often restores normal behavior without requiring a reinstall. --- What Is the FiveM Cache? The FiveM cache stores temporary client-side data to speed up loading and gameplay. Over time, these files can become outdated or corrupted. FiveM stores several types of cache data, including: - Browser Cache: Temporary Chromium/CEF files used for UI elements - Server Cache: Downloaded resources specific to each server you join - Subprocess Cache: Script compilation and runtime artifacts Corrupted cache files may cause: - FPS drops or micro-stuttering - Infinite or stuck loading screens - Missing textures or invisible objects - Random client crashes - Excessive disk space usage --- Before You Begin ::ProseNote{title="Important" description="Check all of the following steps before clearing your cache to prevent corruption or data loss." appearance="error"} :: 1. Completely close FiveM. 2. Ensure all FiveM.exe and CitizenFX processes are closed via Task Manager. 3. Back up custom files if applicable: - Custom keybinds (client.lua) - Saved server favorites - Any custom UI modifications 4. Note your current FiveM version (useful if troubleshooting is needed later). --- Clearing Cache Safely After following the prior steps, you are safe to clear your cache without causing data loss. 1. Navigate to your FiveM data folder: - Method 1: Press Windows + R to open the "Run" program. When open, paste , and then navigate to: - Method 2: Right-click your FiveM desktop shortcut โ Open file location โ Navigate to the data folder 2. Locate your Cache Folders. Inside the data folder, you will see multiple folders. Only specific folders should be removed. Folders to delete: - - - - - - Delete all folders inside except for . (if present) Folders to keep (do NOT delete): - - This contains core GTA V assets (4โ8 GB) - Deleting these protected folders may cause FiveM to fail to launch or require a full re-download. 3. Restart FiveM. - Launch FiveM normally. The first startup after clearing cache may take 2โ3 minutes while the cache rebuilds automatically. This is expected. --- After Clearing Cache Once FiveM finishes loading: - Rejoin your server and allow resources to re-download - Verify performance and visual issues are resolved - Reapply any custom settings if needed If problems persist after clearing cache, the issue may be server-side or related to outdated drivers or mods. --- To learn more about FiveM server hosting, you can browse our library of Knowledgebase articles here.
How to Install the Emergency Lighting System (ELS) on your FiveM Server
The Emergency Lighting System (ELS) allows you to add advanced and realistic emergency vehicle lighting to your FiveM server. This guide walks you through installing ELS-FiveM and configuring ELS-enabled vehicle mods. ::ProseNote{title="Important" description="Please ensure that you have followed the Getting Started with your FiveM Server guide before proceeding with the following steps." appearance="danger"} :: --- Downloading ELS Begin by downloading the latest version of ELS-FiveM from the Assets section. Once the download is complete, extract the archive and open the ELS-FiveM folder. Step 1: Download ELS-FiveM 1. Download the latest ELS-FiveM version from the official source (under Assets). 2. Once downloaded, extract the archive. 3. Open the extracted ELS-FiveM folder. --- Step 2: Configure ELS-FiveM 1. Inside the ELS-FiveM folder, locate the file: 2. Make a copy of this file and rename the copy to: ::ProseNote{title="Note" description="Do not delete . It should remain in place as a reference file." appearance="default"} :: Optional: Additional settings can be modified in , but for most servers the default configuration works perfectly. --- Upload the Resource 1. Go to your Shockbyte Control Panel. 2. Navigate to the Files tab, and locate the following directory: . Upload the entire folder to this directory by selecting Upload File(s). --- Configure ELS Vehicle Mods (Carmods) To enable ELS on custom vehicles, youโll need the vehicleโs ELS configuration file. 1. Upload the ELS Configuration 2. Download an ELS-enabled vehicle mod. 3. Locate its ELS configuration file (commonly named something like): (In this example, the file is called scpdvic.xml.) 4. Upload this file to the following directory: --- Register the Vehicle in vcf.lua 1. Open the file inside the ELS-FiveM folder. 2. Add a new entry for the uploaded .xml file. ::ProseNote{title="Note" description="Ensure that every line before the last ends with a comma, or ELS will fail to load correctly." appearance="default"} :: 3. Save the file. --- Activating the Resource in txAdmin 1. Go to your Shockbyte Control Panel. 2. Launch txAdmin. 3. Navigate to the CFG Editor area and add the line: ensure ELS-FiveM 4. Save the file. --- To learn more about FiveM server hosting, you can browse our library of Knowledgebase articles here.
How to Ban a Player from your FiveM Server
txAdmin provides several tools for banning players from your FiveM server, whether they are currently online or offline. This guide covers the different ways to issue bans, manage existing bans, and configure ban settings to help prevent ban evasion. --- Prerequisites The following requirements must be met in order to ban a player: - txAdmin is installed and configured on your server. - You have Administrator or Moderator permissions in txAdmin. - You have at least one player identifier, such as: their Steam ID, Discord ID, FiveM license, In-game player ID. --- Banning via Live Console ::ProseNote{title="Online players" description="This method is recommended when the player is currently connected to the server." appearance="default"} :: 1. Open your Shockbyte Control Panel. 2. Launch txAdmin. 3. In txAdmin, navigate to Live Console on the left sidebar. 4. Locate the player in the connected players list and click their name. 5. Select Ban Player and complete the ban form: - Duration: Permanent or temporary (hours or days) - Reason: Clear explanation for the ban - Note: Internal staff notes (optional) 6. Click Confirm Ban. --- Banning via Players Page This method allows you to search for players using stored identifiers. 1. Open your Shockbyte Control Panel. 2. Launch txAdmin. 3. In txAdmin, navigate to Players on the left sidebar. 4. Search for the player using: - Username - Steam, Discord, or License ID - IP address (if enabled) 5. Click the playerโs entry to open their profile. 6. Select Ban Player and complete the ban form: - Duration: Permanent or temporary (hours or days) - Reason: Clear explanation for the ban - Note: Internal staff notes (optional) 7. Click Confirm Ban. --- Ban Configuration Options Global Ban Settings You can customize how bans behave across your server: 1. Go to Settings Bans Ban Templates. 2. Configure: - Default ban duration - Predefined ban reasons - Ban message templates - Hardware ID banning (recommended) 3. Select Save Bans Settings. --- Identifier Priority txAdmin applies bans across multiple identifiers by default: - Hardware IDs (most effective) - Steam ID - FiveM license - Xbox Live ID - Discord ID - IP address (optional, not recommended) --- Verifying and Managing Bans View Active Bans 1. Navigate to Players More Ban Identifiers. 2. Review: - Player identifiers - Ban reason - Admin who issued the ban - Expiration date and time --- Revoke a Ban 1. Go to Players Bans. 2. Locate the banned player. 3. Click Revoke Ban. 4. Enter a reason for the revocation. 5. Confirm the action. --- To learn more about FiveM server hosting, you can browse our library of Knowledgebase articles here.
How to Install Carmods on your FiveM Server
Car mods allow you to add custom vehicles to your FiveM server, expanding gameplay and giving players access to new cars. This guide explains how to correctly install car mods using a basic streaming resource. ::ProseNote{title="Important" description="Please ensure that you have followed the Getting Started with your FiveM Server guide before proceeding with the following steps." appearance="danger"} :: --- Creating the Assets Directory Once you have setup your server via txAdmin with a framework, you will be able to add vehicle resources to your server. We will be using QBCore in the following example. 1. Go to your Shockbyte Control Panel. 2. Navigate to the Files tab, and locate the following directory: . 3. Create a folder in this directory. For this example we will call it: . --- Creating fxmanifest.lua & stream 1. Navigate to the directory. 2. Create a file by selecting the New File button and create a new file called: . 3. Open the . Enter the following text inside of the file: fxversion 'cerulean' games { 'gta5' } 4. Save the file. 5. Navigate back to the directory and select New Folder. Create a new folder titled: . --- Uploading the Carmods Now that we have setup the assets folders and the fxmanifest.lua, we can upload the vehicle mods. ::ProseNote{title="Important" description="Make sure you are only uploading valid vehicle files. Incorrect or missing files may cause the vehicle not to load." appearance="default"} :: 1. Navigate to the newly created directory. 2. Upload your vehicle files ( and ) into this folder. --- Activating the Resource in txAdmin For a resource to start automatically, it must be added to the file using the command. You can manage this file easily through the CFG Editor in the txAdmin panel. 1. Go to your Shockbyte Control Panel. 2. Launch txAdmin. 3. Navigate to the CFG Editor area and add the line: . 4. Click the Save File button at the bottom. --- To learn more about FiveM server hosting, you can browse our library of Knowledgebase articles here.
How to Add Resources to your FiveM Server
Resources allow you to extend your FiveM server with additional features and functionality. They are essential for larger projects, such as roleplay servers, where core gameplay systems rely heavily on added resources. ::ProseNote{title="Important" description="Please ensure that you have followed the Getting Started with your FiveM Server guide before proceeding with the following steps." appearance="danger"} :: --- Installing the Resource Once you have setup your server via txAdmin with a framework, you will be able to add resources to your server. We will be using QBCore in the following example. 1. Go to your Shockbyte Control Panel. 2. Navigate to the Files tab and locate the following directory: . The "XXXXX" represents the ID of your template. 3. Select the Upload File(s) button and upload your uncompressed resource file. Ensure this file is compatible with your selected framework. This can also be done using FileZilla for FTP File Management. --- Activating the Resource For a resource to start automatically, it must be added to the file using the command. You can manage this file easily through the CFG Editor in the txAdmin panel. 1. Go to your Shockbyte Control Panel. 2. Launch txAdmin. 3. Navigate to the CFG Editor area and add the line: . 4. Click Save File at the bottom of the page. --- To learn more about FiveM server hosting, you can browse our library of Knowledgebase articles here.
How to Add a Custom Loading Screen to your FiveM Server
A custom loading screen allows you to personalize your FiveM server and create a better first impression for players as they join. This guide walks you through downloading, installing, and enabling a custom loading screen resource on your server. ::ProseNote{title="Important" description="Please ensure that you have followed the Getting Started with your FiveM Server guide before proceeding with the following steps." appearance="danger"} :: --- Find a Loading Screen Resource To get started, youโll need a loading screen resource. A large selection of community-created loading screens can be found on the official Cfx.re Releases forum. Once youโve chosen a loading screen: 1. Download the resource 2. Unzip the files on your computer --- Uploading your Loading Screen to the Server Once you have setup your server via txAdmin with a framework, you will be able to add resources to your server. We will be using QBCore in the following example: 1. Go to your Shockbyte Control Panel. 2. Navigate to the Files tab and locate the following directory: . The "XXXXX" represents the ID of your template. 3. Select the Upload File(s) button and upload your uncompressed loading screen resource file. Ensure this file is compatible with your selected framework. This can also be done using FileZilla for FTP File Management. --- Activating the Resource For a resource to start automatically, it must be added to the file using the command. You can manage this file easily through the CFG Editor in the txAdmin panel. 1. Go to your Shockbyte Control Panel. 2. Launch txAdmin. 3. Navigate to the CFG Editor area and add the line: . Replace the with the actual name of your resource. 4. Click Save File at the bottom of the page. --- To learn more about FiveM server hosting, you can browse our library of Knowledgebase articles here.