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

# Installation

{% stepper %}
{% step %}

### Drag and drop

Drag and drop the <mark style="color:$primary;">vanitx\_multichar</mark> resource into your server resources
{% endstep %}

{% step %}

### Database setup

With `Config.AutoRunSQL = true` (default) the table is created automatically on first start therefore no manual import. Only use `sql/install.sql` if you set `AutoRunSQL = false`&#x20;

{% hint style="info" %}
If your set `AutoRunSQL = false` and your framework is ESX, run install\_esx.sql in your database as well.
{% endhint %}
{% endstep %}

{% step %}

### Configuration

Open <mark style="color:$primary;">config.lua</mark> and configure the resource according to your preferences
{% endstep %}

{% step %}

### Webhooks

Webhooks are configured in <mark style="color:$primary;">webhooks.lua</mark>
{% endstep %}

{% step %}

### Start the resource

Open your <mark style="color:$primary;">server.cfg</mark> and start the resource after your framework, appearance and spawn selector/housing scripts
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Vantix Multicharacter **replaces** your framework's built-in multicharacter. You must disable the old one (per-framework steps below) so the two don't fight over login.
{% endhint %}

## ESX Setup

1. Remove <mark style="color:$danger;">esx\_multicharacter</mark> or any other multicharacter resources
2. Remove <mark style="color:$danger;">esx\_identity</mark> or any other identity scripts
3. Open <mark style="color:$warning;">es\_extended/shared/config/main.lua</mark>
4. Set `Config.Multichar` and `Config.Identity` to `true`

## QBCore Setup

1. Remove <mark style="color:$danger;">qb-multicharacter</mark> or any other multicharacter resources

## QBox Setup

1. Remove any multicharacter resources
2. Open <mark style="color:$warning;">qbx\_core/config/client.lua</mark>&#x20;
3. Set `useExternalCharacters = true`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://vantixstudios.gitbook.io/documentation/multicharacter/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.