Skip to content

Kivo Identity Creator Configuration

Kivo Identity Creator has two editable files: config.lua and shared/framework.lua.

Option Default Description
Config.debug false true prints debug messages to the console.
Config.selfHandle false false: the creator fires an event and the script that opened it (Kivo Multichar) writes the character and handles the spawn. true: standalone mode, the creator writes the character to the database itself. Standalone mode is experimental.
Config.callbackEvent 'kivo-multichar:identityCreated' Client event fired when the player confirms the form. Kivo Multichar listens for this name.
Config.callbackResource 'kivo-multi-char' Only used with Kivo Multichar builds older than 1.5.0. Current builds tell the creator they are in charge when they open it, so the folder name does not matter.
Config.backEvent 'kivo-multichar:identityBack' Client event fired when the player presses Back. Kivo Multichar listens for this name.

These options apply when the creator is opened by a script other than Kivo Multichar (see Examples). Inside the Multichar flow the Multichar scene camera stays in place behind the form, so these values are not used there.

Option Default Description
Config.defaultCam.coords vector3(-1850.8547, -1230.2957, 13.0172) Camera world position.
Config.defaultCam.rot vector3(-8.0, 0.0, -119.0) Camera rotation (pitch, roll, yaw).
Config.defaultCam.fov 50.0 Camera field of view.
Config.defaultPedCoords vector4(-1075.34, -248.12, 43.14, 60.0) Position and heading of the blank ped shown during creation.
Config.blankPedModel 'mp_m_freemode_01' Model of the blank ped.

Choose a clear spot on your map for the camera and the ped, and make sure the ped is in the camera’s view.

Config.fields decides which inputs appear in the form. Each sub table is keyed by the framework name that shared/framework.lua sets: qbx, qb or esx. Set a field to false to hide it. A field left out of a table counts as false.

Field qbx qb esx default
firstname true true true true
lastname true true true true
dob true true true true
gender true true true true
height true false false false
nationality true false false false

Config.fields.default is the fallback when no framework is detected.

Config.fields = {
qbx = {
firstname = true,
lastname = true,
dob = true,
gender = true,
height = true,
nationality = true,
},
-- qb, esx and default follow the same shape
}

When the form is used through Kivo Multichar, Multichar passes the values to your framework, which creates the character.

Framework Saved from the form Value when the field is hidden
QBX First name, last name, date of birth, gender, nationality Nationality: Los Santos. Height is not stored by QBX.
QBCore First name, last name, date of birth, gender, nationality Nationality: Los Santos. Height is not stored by QBCore.
ESX First name, last name, date of birth, gender, height Height: 180. Nationality is not stored by ESX.

The form sends the date of birth as DD/MM/YYYY. For QBX and QBCore it is converted to YYYY-MM-DD. A hidden date of birth is saved as 2000-01-01 (01/01/2000 on ESX).

On QBX and QBCore the height field has no effect, and on ESX nationality has no effect. The shipped Config.fields already hides them where they are not stored, except height on QBX. Hide it with Config.fields.qbx.height = false if you do not want players to fill in a value that is not saved.

shared/framework.lua runs when the resource starts and sets Config.framework.

Order Resource checked Config.framework
1 qbx_core started or starting 'qbx'
2 qb-core started or starting 'qb'
3 es_extended started or starting 'esx'
none nothing above is started nil (uses Config.fields.default)

QBX is checked before QBCore, so if both resources are started, QBX wins. Start the framework before Kivo Identity Creator. To support another framework, see Exports and integration.