Studios
Appearancehouse-3.jpg

Installation

SoonAppearanceQBCore · Qbox · ESX
PAGE 02 OF 07  ·  OVERVIEW → INSTALLATION → CONFIGURATIONdocs.glitchstudios.dev
Browse docs

Requirements#

The server

Framework One of qbx_core (Qbox), qb-core, es_extended or ox_core.
Resources ox_lib, oxmysql
OneSync Required. The manifest depends on /onesync.
Database MySQL or MariaDB through oxmysql. Four install files are in sql/.
Tested with qbx_core 1.24.0, ox_lib 3.40.0, oxmysql 2.14.2 and ox_target 1.17.2

Optional resources

Each one is detected at run time. When it is not running, its feature is skipped.

ox_target or qb-target Shop peds when Config.UseTarget is true, and the job clothing room boxes. Without a target resource those rooms use the walk-in prompt.
qbx_management or qb-management Boss menu entries for job and gang uniforms (Config.BossManagedOutfits).
glitch-uiElements Shop key hint on its keybind HUD (Config.UseUiElementsPrompt). Without it, ox_lib text UI is used.
glitch-pauseMenu Shop names in the pause map legend (Config.PauseMenuLegend).
glitch-admin Staff permission for /pedmenu, an action log and a Clothing idents panel. Without it, ACE permissions and a console command do the same job.
glitch-treasury Shop money booked as removed from the economy (Config.TreasurySink).
glitch-poolcleaning Anticheat exceptions while the menu is open (Config.AnticheatIgnore) and its net event guard (Config.NetGuard).
glitch-onboarding Told when a new character has saved their first look.
glitch-shotMaker Photo cross-check for the clothing idents tool, and department tags on clothing items.

Installation steps#

  1. Put the glitch-appearance folder in your resources folder. The folder name is case-sensitive. Remove illenium-appearance, fivem-appearance or qb-clothing if you run one of them. Do not run illenium-appearance next to this resource.

  2. Run the four files in sql/ once on your database: playerskins.sql, player_outfits.sql, player_outfit_codes.sql and management_outfits.sql. Qbox and QBCore usually have playerskins and player_outfits already. ESX keeps skins in users.skin. There are no items or inventory images to add.

  3. Add to server.cfg, after ox_lib, oxmysql, your framework and ox_target or qb-target if you use one:

    ensure glitch-appearance
    
    # optional: language (default en)
    setr illenium-appearance:locale "en"
    
  4. Go through shared/config.lua: shop positions, prices and the integration switches. The defaults are the stock illenium-appearance shops and police clothing room.

  5. Restart the server.

Permissions#

What Default
/pedmenu group.admin (Config.PedMenuGroup). With glitch-admin running, the staff role also needs its pedmenu permission.
/clothinglocks group.admin
/migrateskins group.god
Clothing idents console and panel glitchappearance.idents (Config.ClothingIdents.StaffAce)
Clothing idents run, finish and restore glitchappearance.idents.migrate (Config.ClothingIdents.MigrateAce)
add_ace group.admin glitchappearance.idents allow
add_ace group.god glitchappearance.idents.migrate allow

With glitch-admin running, its staff roles decide the clothing idents permissions instead.

Moving from another clothing script#

If you are coming from qb-clothing or fivem-appearance, run /migrateskins qb-clothing or /migrateskins fivem-appearance once from an account in group.god, in the city, with no other players online.

Updating#

Keep your settings in a .lua file of your own in shared/overrides/. Releases never include a .lua file in that folder, so you can replace everything else and restart the resource. Also keep data/clothing-registry.json and clothing_job_tags.json if your server has them. node tools/release.js --check lists the files that belong to your server.