Installation Guide

⚙️ Installation Guide

Step 1: Disable all other identity and multicharacter resources:

If you use QBOX framework locate file: qbx_core/config/client.lua:

And change useExternalCharacters:

useExternalCharacters = true,
triangle-exclamation

Note for ESX Users

If you are using the latest ESX version with SSN, make sure the following option is enabled in:

The value must be set to true.

Do not rely on checking whether the esx_multicharacter resource is started, because this resource must be removed when using this system. If the configuration tries to detect whether esx_multicharacter is running, it will create a logical error and players may not be able to register their character properly.


Step 2: Installing Dependencies

Our script requires the following dependencies:

  • ox_lib (optional, only if you use QBOX or notify system from OX)

  • oxmysql

  • skin system: example - illenium-appearance, skinchanger etc. (If you have other system it's can be connect in client_editable.lua) we also help with integration.

  • Framework: ESX / QBOX / QBCore

  • Our Identity system or any other, our identity is already connect, any other system you can connect in client_editable.lua

Additionally, we recommend using MariaDB as your Database Management System.


Step 3: Configuration

circle-check

Step 5: Import our sql file

Example import for esx:


Optional step 6: Configure your discord settings

Locate pinkFrog_multiCharacter/server/custom/server_editable_discordSettings.lua

circle-info

You don't need to do it (if you don't wanna use /relogDonator and discord roles slots based.

Optional step 7: Configure our config to your needs

Change your main color:

Change main settings:

Change discord roles:

Change cloned ped settings from /relogDonator

Configure which tables will drop after delete character

Configure which model will be use or clear area in prepared by you scene:

Configure places where players can reconnect without quiting:

Translate to your needs:

Make your own cinematic scenes:

Change music to your needs:

Optional Step 8: Configure your own notify system / skinSystem / identity System:

Add common event to start creating your skin locate in pinkFrog_multiCharacter/client/custom/client_editable.lua

circle-check

If you don't wanna use our identity system you can change it here:

Change your notify export/event

Step 9: Start order

It's important to start in logical order to prevent any errors in your server console!

circle-info

It's only EXAMPLE of starting order, should looks similiar but do not copy this.

  1. Save all changes

  2. Restart your server and connect.

Configure your admin permissions and commands:

Locate file: pinkFrog_multiCharacter/server/custom/server_editable_commands.lua


Last updated