Skip to content

Kivo Character Suite

The Kivo Character Suite is three FiveM resources that cover everything a player sees between connecting to your server and standing in the world.

Script What the player sees Default folder Version documented
Kivo Multichar A cinematic character selection screen with animated peds. Players pick, create and delete characters. kivo-multi-char 1.5.0
Kivo Identity Creator A form for first name, last name, date of birth, gender, height and nationality. kivo-identity-creator 1.5.0
Kivo Spawn A spawn location picker with an overhead camera that glides to each location. kivo-spawn 1.5.0

All three detect your framework on their own. Supported frameworks: QBX (qbx_core), QBCore (qb-core) and ESX Legacy (es_extended). The three resources find each other by themselves, so you can rename their folders.

Framework How characters are created and loaded Spawn hand-off with Config.spawnSelector = 'default'
QBX qbx_core Login qbx_spawn, otherwise a direct teleport
QBCore (old and new player class) QBCore.Player.Login qb-apartments with qb-spawn, then qb-spawn, otherwise a direct teleport
ESX Legacy ESX’s own multicharacter join (esx:onPlayerJoined) Direct teleport

Characters are always written by the framework itself, so differences between framework versions (extra or missing database columns) do not matter.

Appearance resource Character previews First-character editor
illenium-appearance Yes Yes (QBX, QBCore, ESX)
fivem-appearance Yes Yes
qb-clothing Yes Yes
bl_appearance Yes Yes
esx_skin with skinchanger Yes Yes

The preview peds read the format of each saved skin rather than checking which resource is running. A server that switched appearance scripts still shows correct previews for older characters.

Kivo Multichar is the hub. It talks to the other two.

Returning character

  1. The player connects. Multichar moves them into a separate routing bucket and shows the selection scene.
  2. The player picks a character and presses Play. Multichar moves the player back to the normal world bucket and logs the character in through your framework.
  3. Multichar hands the player to the spawn system set in Config.spawnSelector. With 'kivo-spawn' it fades the screen out and fires the client event kivo:client:readyForSpawn.
  4. Kivo Spawn opens the location picker. The player chooses a location (or Last Location), the screen fades, and the player is placed in the world.

New character

  1. The player clicks an empty slot. Multichar opens Kivo Identity Creator on top of the same scene camera. If Config.useIdentityCreator = false, or the identity creator is not running, Multichar shows a built-in dialog instead.
  2. The player fills in the form. Identity Creator fires kivo-multichar:identityCreated and Multichar asks your framework to create the character. On every framework this one step creates the character and logs the player in. If the player presses Back, the selection screen returns.
  3. The new character is placed at Multichar’s Config.defaultSpawn (on ESX, Config.esxNewCharSpawn when set) and your appearance editor opens. The spawn picker is not shown to a brand-new character.
Connect
-> Kivo Multichar (selection scene, routing bucket)
-> empty slot -> Kivo Identity Creator -> character created and logged in
-> default spawn -> appearance editor
-> existing -> framework login -> Kivo Spawn (location picker) -> in the world

Multichar is the core of the suite. Identity Creator and Spawn each plug into it through one setting in Multichar’s config.lua.

Setup Multichar settings Result
Full suite (recommended) useIdentityCreator = true, spawnSelector = 'kivo-spawn' Identity form for new characters, location picker for returning characters.
Multichar and Spawn useIdentityCreator = false, spawnSelector = 'kivo-spawn' Built-in dialog for creation, Kivo Spawn for spawning.
Multichar and Identity Creator useIdentityCreator = true, spawnSelector = 'default' Identity form, then your framework’s spawn selector (or a direct teleport).
Multichar only useIdentityCreator = false, spawnSelector = 'default' No other Kivo resource needed.
Kivo Spawn without Multichar none Kivo Spawn opens by itself once your framework reports the character as loaded.
Kivo Identity Creator without Multichar Config.selfHandle = true in Identity Creator Standalone mode. Treat it as experimental and test it first.

Mismatches are handled for you: if a setting points at a Kivo resource that is not running, Multichar falls back (built-in dialog, or 'default' spawning) and prints a warning in the console.

Requirement Needed by
oxmysql Multichar, Identity Creator
ox_lib Multichar, Identity Creator
One framework: qbx_core, qb-core or es_extended All three

Kivo Spawn does not need ox_lib or oxmysql.

Start the database and library resources, then your framework, then the Kivo resources:

  1. oxmysql
  2. ox_lib
  3. your framework (qbx_core, qb-core or es_extended)
  4. kivo-multi-char
  5. kivo-identity-creator
  6. kivo-spawn

This is the recommended order. If a Kivo resource starts before the framework, it detects the framework again once the framework has started, and prints a reminder in the console.

The full copy-paste server.cfg blocks are on the installation page.