Kivo Character Suite Installation
This page installs all three scripts together. If you only use one of them, follow its own installation page instead: Multichar, Identity Creator, Spawn.
The defaults work out of the box on QBX, QBCore and ESX. You do not need to edit any config file to get started.
Before you start
Section titled “Before you start”- Your framework (QBX, QBCore or ESX) is installed and working.
oxmysqlandox_libare installed.- You have a database backup.
1. Copy the resources
Section titled “1. Copy the resources”Place the three folders on your server. You can rename them; the scripts find each other by themselves.
resources/ [kivo]/ kivo-multi-char/ kivo-identity-creator/ kivo-spawn/The database table Multichar uses for per player slot counts is created automatically on the first start. The SQL file shipped with Multichar is only there if you want to create or inspect it by hand.
2. Add them to server.cfg
Section titled “2. Add them to server.cfg”Put the Kivo resources after your framework, and remove your old multicharacter resource (qb-multicharacter, esx_multicharacter or any other).
ensure oxmysqlensure ox_libensure qbx_coreensure kivo-multi-charensure kivo-identity-creatorensure kivo-spawnQBCore
Section titled “QBCore”ensure oxmysqlensure ox_libensure qb-coreensure kivo-multi-charensure kivo-identity-creatorensure kivo-spawnensure mapmanagerensure spawnmanagerensure oxmysqlensure ox_libensure es_extendedensure kivo-multi-charensure kivo-identity-creatorensure kivo-spawnOn ESX, also remove esx_identity. Two identity steps on one character conflict.
If you do not use one of the three resources, leave its line out. Multichar notices and falls back on its own (see the overview).
3. Start the server and read the console
Section titled “3. Start the server and read the console”When Kivo Multichar starts, it prints the framework it detected and then either setup OK or a red CONFLICT line for anything that would fight it:
| Conflict | Meaning |
|---|---|
| Another multicharacter resource is running | Two character selectors cannot run at once. |
QBX: useExternalCharacters = false |
qbx_core would open its own character menu on top of Multichar’s. |
Older ESX builds: Config.Multichar = false |
ESX would not hand character loading to Multichar. |
To fix them, type this in the server console (the txAdmin live console works too):
kivosetupIt stops the conflicting resources for the current session and corrects the framework setting. It keeps a .kivo-backup copy of any file it changes. Then:
- Remove the old multicharacter’s
ensureline fromserver.cfg, so it stays off. - Restart the server once, so the framework reloads its config.
Nothing is changed unless you run kivosetup. If you prefer to do it by hand, set useExternalCharacters = true in qbx_core/config/client.lua (QBX) or Config.Multichar = true in your es_extended config (older ESX).
Optional configuration
Section titled “Optional configuration”Everything in the config files is optional tuning. The values most servers look at:
Kivo Multichar (kivo-multi-char/config.lua)
Config.spawnSelector = 'kivo-spawn' -- 'kivo-spawn' | 'default' | 'custom'Config.useIdentityCreator = true -- false = built-in dialog insteadConfig.defaultScene = 'scene_2'Config.defaultSlots = 5Config.maxChars = 5Kivo Spawn (kivo-spawn/config.lua): your hub camera and spawn locations. The shipped file contains three example locations to use as a template.
Config.spawnbehavior.hub = { coords = vector3(-269.0, -955.0, 750.0), rot = vector3(-90.0, 0.0, 0.0),}
Config.spawnlocations = { { id = '1', coords = vector4(-1411.5907, -1241.6539, 4.4002, 12.2884), img = '', name = 'Vespucci Beach', description = 'Relax by the shore.', temperature = '32C', wind = 'Light', weather = 'sunny', spawnfunction = 'default', },}Kivo Identity Creator (kivo-identity-creator/config.lua): which form fields are shown per framework (Config.fields).
Full option lists: Multichar configuration, Identity Creator configuration, Spawn configuration.
- Connect with a player that has no character. Create one and check the identity form, the creation and the appearance editor.
- Disconnect, reconnect, pick the character and check the Kivo Spawn location picker.
- Test Back on the identity form and Delete on the selection screen.
Checklist
Section titled “Checklist”- Kivo resources start after the framework
- Old multicharacter removed from
server.cfg(andesx_identityon ESX) - Console shows
setup OK(otherwise runkivosetupand restart once) - Spawn locations and hub camera configured
- Tested with a new character and a returning character
-
Config.debug = falsein Multichar on a live server
