NPC Pro – talking, remembering street NPCs with trust, gossip and errands NPC PRO - talk to ANY ped. They remember, they gossip, they snitch. €29.99 See NPC PRO
Before you start

Installation

nCore Character – appearance, clothing stores, barber, tattoo parlor and character creator installation

v1.0.15 Updated 7 sections · 4 min
View product · Free Documentation Changelog
On this page
  1. Before you start
  2. Steps
  3. server.cfg order
  4. Optional
  5. Moving looks from your old script (Takeover mode)
  6. Updating
  7. If a store doesn't open

Before you start#

  • OneSync has to be on. The server measures the distance to every counter itself, without OneSync every store answers "too far".
  • Pick a mode in config.lua:
    • Config.Takeover = false (default, Beside mode): the stores run next to illenium-appearance or qb-clothing and save through it. Needs oxmysql. Your appearance resource keeps its standard folder name, it's found by that name.
    • Config.Takeover = true (Takeover mode): this resource is your character creator and stores the looks itself. Remove the old appearance resource. oxmysql is optional. In this mode the server accepts an outfit save or a convert save from the client without the store distance check or a price. The SaveLook export and the qb-clothing and esx_skin save stand-ins need that. A modded client can put on any valid clothes for free, anywhere. Config.Outfit.saveLook = false turns the outfit save off.
  • Beside mode can't save through fivem-appearance or esx_skin. On a server with one of those, use Takeover mode.
  • On ND_Core and ox_core use Takeover mode. Beside mode's save check only knows the playerskins (QBCore, QBox) and users.skin (ESX) tables.
  • Standalone has no money system, so only free visits work there (set the prices in Config.Pricing to 0).

Steps#

  1. Copy the ncore_character folder into your resources, for example resources/[ncore]/ncore_character. Don't rename the folder.
  2. Takeover mode with oxmysql: import sql/install.sql. The table is also created at start when oxmysql runs. Beside mode doesn't use it.
  3. Add the ensure lines to server.cfg, in the order below for your framework. oxmysql and your framework go before ncore_character: the framework is detected once at start, and if oxmysql isn't up yet the looks of that whole session go to KVP.
  4. Add the admin ace (for appcreator, /appindex and the inventory admin panel):
server.cfg
add_ace group.admin ncore_character.admin allow
  1. Open config.lua and set Config.Takeover, Config.Pricing and, if you want the creator to open for new players, Config.Creator.forceOnFirstLogin = true (Takeover only).
  2. Leave Config.Debug = false on a live server.

You can also set both switches from server.cfg without touching config.lua. A convar wins over the config value:

server.cfg
setr ncore_character:takeover true
setr ncore_character:debug true
  1. Restart the server and read the console. A red box means something is missing, and it says what.

server.cfg order#

Leave out the lines for resources you don't run. ncore_inventory is optional, it goes before ncore_character.

QBox, Beside mode#

server.cfg
ensure oxmysql
ensure qbx_core
ensure illenium-appearance
ensure ncore_inventory
ensure ncore_character

QBCore, Beside mode#

server.cfg
ensure oxmysql
ensure qb-core
ensure qb-clothing
ensure ncore_inventory
ensure ncore_character

Beside qb-clothing there is no tattoo parlor and GTA characters can't use the stores. That's a limit of qb-clothing's saved format.

ESX with illenium-appearance, Beside mode#

server.cfg
ensure oxmysql
ensure es_extended
ensure illenium-appearance
ensure ncore_inventory
ensure ncore_character

ESX with esx_skin, Takeover mode#

Remove the esx_skin and skinchanger lines. ncore_character answers their events and exports while they're gone.

server.cfg
ensure oxmysql
ensure es_extended
ensure ncore_inventory
ensure ncore_character

QBox or QBCore, Takeover mode#

Remove the illenium-appearance or qb-clothing line. On QBCore with qb-multicharacter set Config.Database.mirrorPlayerskins = false.

server.cfg
ensure oxmysql
ensure qbx_core
ensure ncore_inventory
ensure ncore_character

ND_Core, ox_core or standalone, Takeover mode#

server.cfg
ensure oxmysql
ensure ND_Core
ensure ncore_character

Use ox_core in place of ND_Core, or neither on standalone. On ox_core set Config.Pricing.account = 'bank', it's the only account ox_core charges.

Optional#

  • ncore_inventory 1.0.25 or newer: clothes as items, bags, the Binco fitting room, the Sell clothes button, the admin panel menus and the key-hint stack. Keep both resources on their current release.
  • screenshot-basic: only for /appthumbs (your own clothing pictures). /appthumbs also needs Config.Debug = true while it runs, so turn debug off again when the pictures are done.
  • Language: Config.Locale = 'auto' follows the first of the server's lr:locale, locale, ox:locale and esx:locale convars that names a shipped language, English if none does, and the players get the same language. Or set Config.Locale = 'en' or 'hu' directly.

Moving looks from your old script (Takeover mode)#

From the server console, with oxmysql running:

Code
appmigrate appearance dry
appmigrate appearance run

appearance reads every skin in illenium-appearance's format (with a headBlend field) from both playerskins and users.skin. Use qb for qb-clothing skins and esx for ESX skinchanger skins in users.skin. Each source imports once, players who already have a look are skipped.

Updating#

Updates don't install themselves. Download the new version from intelnpc.com, keep your config.lua and the web/thumbs folder if you rendered pictures, and copy every other file over the old ones. Settings missing from an older config.lua get their default at start. CHANGELOG.md says when a version needs anything else.

If a store doesn't open#

Stand at the counter and type /appwhy. It prints the reason in F8 and on the server console.

nCore Character is made by nCore Development. It is not approved, sponsored or endorsed by Rockstar Games.