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.
Before you start
Section titled “Before you start”- Server and game build: any FiveM server that supports
fx_version 'cerulean'andgame 'gta5'. - Dependencies: none are declared in
fxmanifest.lua. - Have the release package of the resource, not a source copy. The package contains the
game/distandweb/distfolders that the manifest points to.
Install the resource
Section titled “Install the resource”-
Copy the resource folder into your server’s
resourcesfolder, for example:resources/[kivo]/kivo-appearance -
Check that the folder contains these items:
kivo-appearance/fxmanifest.luapeds.jsontattoos.jsonlocales/cs.jsonde.jsonen.jsones-ES.jsonfa-IR.jsonfr.jsonpt-BR.jsongame/dist/index.jsweb/dist/index.htmlweb/dist/assets/ (the .js files) -
Add the resource to
server.cfg. Put the optional settings above theensureline, 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 itensure your-multicharacterensure your-identity-creatorensure your-clothing-shop -
Restart the server, or run
ensure kivo-appearancefrom the server console.
Replace an existing appearance script
Section titled “Replace an existing appearance script”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:
- Stop the old appearance script from the server console, for example
stop old-appearance-script. - Remove its
ensureorstartline fromserver.cfg, or comment it out with#. - Add Kivo Appearance as shown above.
- 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.
- 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.cfgand of the old resource folder until every script has been tested.
After installation
Section titled “After installation”- Edit
peds.json,tattoos.jsonand the files inlocales/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.
Common installation problems
Section titled “Common installation problems”| 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. |
