Skip to content

Installation

Kivo Appearance needs no database import, no items and no framework setup. Installation is a folder copy and a few lines in server.cfg.

  • Server and game build: any FiveM server that supports fx_version 'cerulean' and game 'gta5'.
  • Dependencies: none are declared in fxmanifest.lua.
  • Have the release package of the resource, not a source copy. The package contains the game/dist and web/dist folders that the manifest points to.
  1. Copy the resource folder into your server’s resources folder, for example:

    resources/[kivo]/kivo-appearance
  2. Check that the folder contains these items:

    kivo-appearance/
    fxmanifest.lua
    peds.json
    tattoos.json
    locales/
    cs.json
    de.json
    en.json
    es-ES.json
    fa-IR.json
    fr.json
    pt-BR.json
    game/dist/index.js
    web/dist/index.html
    web/dist/assets/ (the .js files)
  3. Add the resource to server.cfg. Put the optional settings above the ensure line, and put the scripts that open the menu below it:

    # Optional. Defaults are shown. "setr" is required so players receive the value.
    setr fivem-appearance:locale "en"
    setr fivem-appearance:automaticFade "1"
    ensure kivo-appearance
    # Scripts that open the appearance menu start after it
    ensure your-multicharacter
    ensure your-identity-creator
    ensure your-clothing-shop
  4. Restart the server, or run ensure kivo-appearance from the server console.

Kivo Appearance is built to manage all player and ped customization in one place, so only one appearance resource should run on your server. To replace an existing one:

  1. Stop the old appearance script from the server console, for example stop old-appearance-script.
  2. Remove its ensure or start line from server.cfg, or comment it out with #.
  3. Add Kivo Appearance as shown above.
  4. Open the configuration of every script that opened the old menu (multicharacter, identity creator, clothing shops, jobs). Change the resource name or the call it uses so that it points to Kivo Appearance.
  5. Restart the server and test each of those scripts.

What this documentation can and cannot promise:

  • Kivo Appearance ships no SQL and no server script. It does not read, convert or migrate appearance data stored by your old script or your framework.
  • This documentation does not list a set of exports or events that makes Kivo Appearance a drop-in replacement for another script. Check the documentation of each script that opens the menu to see whether it supports this resource. See Integration.
  • Keep a backup of your server.cfg and of the old resource folder until every script has been tested.
  • Edit peds.json, tattoos.json and the files in locales/ to fit your server. See Configuration.
  • The resource does not register a command. To test it, use the script on your server that opens the menu.
  • After you edit any file in the resource folder, run restart kivo-appearance.
Problem Likely cause and fix
The console reports a missing file such as game/dist/index.js You copied a source copy. Use the release package that contains the game/dist and web/dist folders.
The menu opens but shows no text or no sections The language file for the chosen language is missing or is not valid JSON. See Examples and troubleshooting.
The language does not change The setting was written with set instead of setr, or the value does not match a file name in locales/.
Another script cannot find the resource The folder name differs from the name that the other script expects. Rename the folder or change the other script’s setting.