Skip to content

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.

  • Your framework (QBX, QBCore or ESX) is installed and working.
  • oxmysql and ox_lib are installed.
  • You have a database backup.

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.

Put the Kivo resources after your framework, and remove your old multicharacter resource (qb-multicharacter, esx_multicharacter or any other).

ensure oxmysql
ensure ox_lib
ensure qbx_core
ensure kivo-multi-char
ensure kivo-identity-creator
ensure kivo-spawn
ensure oxmysql
ensure ox_lib
ensure qb-core
ensure kivo-multi-char
ensure kivo-identity-creator
ensure kivo-spawn
ensure mapmanager
ensure spawnmanager
ensure oxmysql
ensure ox_lib
ensure es_extended
ensure kivo-multi-char
ensure kivo-identity-creator
ensure kivo-spawn

On 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).

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):

kivosetup

It 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:

  1. Remove the old multicharacter’s ensure line from server.cfg, so it stays off.
  2. 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).

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 instead
Config.defaultScene = 'scene_2'
Config.defaultSlots = 5
Config.maxChars = 5

Kivo 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.

  1. Connect with a player that has no character. Create one and check the identity form, the creation and the appearance editor.
  2. Disconnect, reconnect, pick the character and check the Kivo Spawn location picker.
  3. Test Back on the identity form and Delete on the selection screen.
  • Kivo resources start after the framework
  • Old multicharacter removed from server.cfg (and esx_identity on ESX)
  • Console shows setup OK (otherwise run kivosetup and restart once)
  • Spawn locations and hub camera configured
  • Tested with a new character and a returning character
  • Config.debug = false in Multichar on a live server