# Installation

## Frameworks

<details>

<summary>ESX</summary>

* Only **ESX version 1.12 or higher are supported**, older versions may work but I won't give you any support.
* Go to **es\_extended/config/main.lua** and set `Config.Multichar = true`
* Delete **esx\_multicharacter**

</details>

<details>

<summary>QBCore</summary>

* Make sure to delete **qb-multicharacter**.

</details>

<details>

<summary>Qbox</summary>

* Only **version 1.22 or higher** are supported.
* Go to **qbx\_core/config/client.lua** set `useExternalCharacters = true`&#x20;
* Go to **av\_multicharacter/fxmanifest.lua** and **uncomment line 13**

</details>

<details>

<summary>Other Frameworks</summary>

* Add your Framework in **config/\_framework.lua** and **import the Core**.
* Go to **server/editable/** and create your own Framework file, check the files from other Framework (qb, qbox, esx) and create the exact same functions but addapted to your own Framework.
* Go to **client/editable/spawn.lua** and add your own spawn code inside **av\_multicharacter:defaultSpawn**.
* Go to client/editable/clothing.lua and add your own clothing export.
* Nothing Framework related is encrypted, you can use the search function in Visual Studio to find everything.

</details>

## Translate

* To translate the UI go to **ui/dist/lang.json**&#x20;
  * *Please be careful, breaking the .json or any other file will make the UI unusable.*
* Don't forget about **config/lang.lua**

## Server Logo

* Replace the server logo in **ui/dist/logo.png**

## Config

* Don't forget to read and modify *(if needed)* all the files in config folder.

{% hint style="warning" %}
This script was fully tested with the latest official versions from every Framework, if you are using an outdated and/or inspired version this script may not work as expected.
{% endhint %}
