> For the complete documentation index, see [llms.txt](https://izaap-studios.gitbook.io/izaap-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://izaap-studios.gitbook.io/izaap-scripts/multicharacter/installation-and-configuration.md).

# Installation & Configuration

## Installation & Configuration

### Requirements

Before installing the resource, make sure your server already has:

* `oxmysql`
* One supported framework:
  * `qb-core`
  * `qbx_core`
  * `is_extended`
* The database structure required by your framework
* A FiveM artifact/server build compatible with Lua 5.4

Optional systems such as clothing, spawn selector, housing, inventory, and Discord webhooks can be configured later.

***

### 1. Download The Resource 

Download the resource and place it inside your server resources folder.

```shellscript
Example:
resources/[izaap]/izaap_multicharacter
```

Do not rename the resource unless you also update the name used in your `server.cfg`.

***

### 2. Install Dependencies

`oxmysql` is required and must be started before `izaap_multicharacter`.

Make sure your framework is also installed and working before starting this resource.

***

### Downloading Dependencies

{% stepper %}
{% step %}

### **Oxmysql**

{% embed url="<https://github.com/overextended/oxmysql>" %}
{% endstep %}
{% endstepper %}

***

### 3. Database Setup

Make sure your framework database has already been imported.

`izaap_multicharacter` uses your framework database to load and save character information.

The resource also creates its own required tables automatically when needed, such as:

* Custom character slots
* Partner/friend relations

If your package includes an additional SQL file, import it before starting the resource.

***

### 4. Ensure The Resource

Add the resource to your `server.cfg`.

Example:

```shellscript
ensure oxmysql

# Framework
ensure qb-core
# or
ensure qbx_core
# or
ensure es_extended

# iZaap
ensure izaap_multicharacter
```

If you use optional integrations such as clothing, spawn, housing, or inventory resources, make sure they are started before `izaap_multicharacter`.

***

### 5. First Start

After adding the resource:

1. Restart the server or run `refresh`.
2. Start the resource.
3. Check the console for errors.
4. Join the server and verify that the character selector opens correctly.

If the resource does not load, check that:

* `oxmysql` is running
* Your framework is running
* Your framework database exists
* The resource name matches your `ensure` line

***