Skip to content

Integration

Kivo Appearance is a menu that other scripts open. It does not open itself.

The resource README and fxmanifest.lua do not publish a list of exports or events. This documentation therefore does not list any, and it does not show code that calls the menu. Anything beyond what is written here would be a guess.

What is confirmed from the files an admin works with:

  • The resource has no chat command and no key bind.
  • It has one client script and the menu page. There is no server script, no SQL and no framework code.
  • The manifest declares no dependencies.
  • The ped list, the tattoo list and all menu text are plain JSON files. See Configuration.

Three things connect Kivo Appearance to the rest of your server.

Item What to do
Resource name Other scripts find this resource by its folder name. Use the same name in server.cfg and in every script that refers to it. This documentation uses kivo-appearance.
Start order Start kivo-appearance before the scripts that open it.
Data lists The Model dropdown and the tattoo dropdowns only show what is in peds.json and tattoos.json. Add the models and tattoos your other scripts rely on.
ensure kivo-appearance
ensure your-multicharacter
ensure your-identity-creator
ensure your-clothing-shop
ensure your-job-script

Kivo Appearance has no server script and no database access. Where a character’s appearance is stored, and when it is applied again after a player connects, is decided by the script that opens the menu and by your framework. Check that script’s documentation for how it saves and restores appearance.

Work through this list for each script on your server that used to open an appearance menu.

  1. Stop the old appearance resource and start kivo-appearance (see Installation).
  2. If the multicharacter has a setting that names the appearance resource, set it to the folder name of Kivo Appearance.
  3. Create a test character and confirm that the menu opens, that saving closes it and that the saved look is still there after relogging.
  1. Use the same resource name and start order as above.
  2. Create a new character and confirm that the menu opens after the identity step.
  3. Check that the sex chosen in the identity step matches the freemode model shown in the Model dropdown (mp_m_freemode_01 or mp_f_freemode_01).
  1. Use the same resource name and start order as above.
  2. Open a shop, change clothes, save and confirm the clothes stay after leaving the shop.
  3. Test Exit as well. The menu shows a confirmation dialog, and exiting does not keep the changes.
  1. Use the same resource name and start order as above.
  2. If a job script changes a player’s outfit, check that the outfit is restored when the player leaves duty.
  3. Keep every model that a job script uses in peds.json. If a player is in a model that is not listed, the menu treats the current model as mp_m_freemode_01.

If a script does not support Kivo Appearance

Section titled “If a script does not support Kivo Appearance”
  • Check that script’s documentation for the appearance resources it supports.
  • Ask the author of that script whether it can open Kivo Appearance.
  • Do not run two appearance menus side by side. Kivo Appearance is built to manage customization in one place.

See also Examples and troubleshooting.