📂Installation

Setup Instructions for Script Installation

---

Step 1: Download the Script

• Visit the Tebex platform and purchase/download the script package.

Step 2: Transfer Script to Server

• Locate the downloaded script file on your local machine.

• Transfer the script folder to your FiveM server's resources folder.

Step 3: Configure Server CFG

• Open your server.cfg file located in your server's main directory.

• Add a new line with ensure [script-name] to ensure the script is loaded on server startup.

  • Replace [script-name] with the name of the script folder you transferred.

Step 4: Configure config.lua

• Navigate to the shared folder within the script.

• Open the config.lua file.

• Configure the multiCharTrigger function according to your framework:

  • If using QBcore:

    multiCharTrigger = function()
        TriggerEvent('qb-multicharacter:client:chooseChar')
    end

  • If using ESX:

    multiCharTrigger = function()
        TriggerEvent("esx_multicharacter:SetupCharacters")
    end

• Configure the customFramework section according to your needs:

  • Set enabled to true if you are using a custom framework, otherwise leave it as false.

  • Set identifier to the type of identifier you want to use (e.g., 'license:', 'steam:', 'ip', etc.).

  • Set export to the appropriate export function if needed.

Step 5: Modify Multicharacter Script

• If Using QBcore:

  • Navigate to the qb-multicharacter script folder within your server's resources.

  • Open the client.lua file.

  • Comment out or delete the following code block:

    CreateThread(function()
        while true do
            Wait(0)
            if NetworkIsSessionStarted() then
                TriggerEvent('qb-multicharacter:client:chooseChar')
                return
            end
        end
    end)

• If Using ESX:

  • Navigate to the esx_multicharacter script folder within your server's resources.

  • Open the client/main.lua file.

  • Comment out or delete the following code block:

    CreateThread(function()
        while not ESX.PlayerLoaded do
            Wait(100)
    
            if NetworkIsPlayerActive(PlayerId()) then
                exports.spawnmanager:setAutoSpawn(false)
                DoScreenFadeOut(0)
                while GetResourceState("esx_context") ~= "started" do
                    Wait(100)
                end
                TriggerEvent("esx_multicharacter:SetupCharacters")
                break
            end
        end
    end)

Step 6: Configure svconfig.lua (If Using Custom Framework)

• Navigate to the server's main directory.

• Open the svconfig.lua file located in the server's main directory.

• Configure the getCharactersFunction according to your custom framework's requirements.

Step 7: Configure config.js

This file is located in the main of html folder.

1. loadingPage: Defines settings for the loading page, such as the title, description, and loading text.

2. rulesUrl: Specifies the URL of the PDF file containing the server's general rules.

3. helpinfo: Contains help information, including title and instructions for navigating rules, as well as icons for opening and closing the help information.

4. socialsConfig: Configures links to the server's social media accounts, including name, link, and icon for each.

5. commandsAndKeys: Defines server commands and associated keys, with names and descriptions for each.

6. buttonConfig: Configures buttons on the loading page, including ID, title, description, icon, and in some cases specific information for certain buttons, such as character information for the player info button.

---