Studios
Appearancehouse-3.jpg

Configuration

SoonAppearanceQBCore · Qbox · ESX
PAGE 03 OF 07  ·  INSTALLATION → CONFIGURATION → EXAMPLESdocs.glitchstudios.dev
Browse docs

Configuration files#

Everything you are meant to change stays open under escrow:

File What it holds
shared/config.lua Prices, checkout, server checks, shops, rooms, blips, job and gang uniforms, integrations
shared/peds.lua Config.Peds: which ped models each job, gang or ACE may pick
shared/tattoos.lua The tattoo list, with an optional cost per tattoo
shared/blacklist.lua Config.CollectionLocks, Config.Departments and Config.Blacklist
shared/theme.lua Menu colours
shared/overrides/*.lua Your own settings. Each file loads after the four config files above.
locales/*.lua Text in 15 languages
sql/*.sql Table install files

Put your changes in shared/overrides/, for example shared/overrides/myserver.lua:

Config.ClothingCost = 200
Config.ThumbnailUrl = "https://photos.example.com/clothing"
Config.Stores[1].showBlip = false

Prices and checkout#

Setting Default What it does
Config.ClothingCost 150 Clothing shop fee
Config.BarberCost 75 Barber fee
Config.TattooCost 150 Tattoo shop fee, or the price of one tattoo without a cost
Config.SurgeonCost 25000 Surgeon fee
Config.TattooFlatFee true Charge only TattooCost at the tattoo shop, however many tattoos are added. false adds the price of each new tattoo.
Config.ChargePerTattoo false Upstream behaviour: each tattoo is paid when it is applied
Config.LegacyChargeEvent false Registers the upstream illenium-appearance:server:chargeCustomer event for old scripts that still trigger it

Server checks#

Setting Default What it does
Config.ShopCheckRadius 25.0 Metres a player may be from a barber, tattoo or surgeon shop of that type to pay there. The same radius around any shop or room decides whether the menu may make the player invincible.
Config.MaxAppearanceSize 60000 Longest saved look, in characters of JSON
Config.PedMenuGrantMinutes 30 How long a ped menu grant lasts
Config.MaxOutfits 100 Saved outfits per character
Config.OutfitActionCooldown 1 Seconds between outfit saves, updates, deletes and code imports per player
Config.CreatorBucketBase 0 The character creator uses routing bucket CreatorBucketBase + server id
Config.ServerClothingLocks true Check clothing locks on the server as well as in the menu
Config.InvincibleDuringCustomization true The player cannot be hurt while the menu is open
Config.ReloadSkinCooldown 5000 Milliseconds between /reloadskin uses

Shops and prompts#

Setting Default What it does
Config.Stores Stock illenium-appearance shops Every shop: type (clothing, barber, tattoo, surgeon), coords, size, rotation, usePoly with points for a floor outline, optional job or gang, showBlip, and ox_target = true for a target box instead of the walk-in prompt
Config.UseTarget false true uses ox_target or qb-target peds for every shop. false uses walk-in zones with a key prompt.
Config.ShopKey "E" Default key for the walk-in prompt. Players can rebind it in the FiveM key bindings.
Config.UseUiElementsPrompt true Show the prompt on the glitch-uiElements keybind HUD when it runs
Config.TextUIOptions { position = "left-center" } ox_lib text UI position
Config.NotifyOptions { position = "top-right" } Notification position
Config.TargetConfig Table Target ped model, scenario, icon, label and distance per shop and room type
Config.Blips Table Show, Sprite, Color, Scale and Name per shop type
Config.ShowNearestShopOnly false Show only the nearest shop's blip
Config.NearestShopBlipUpdateDelay 10000 Milliseconds between nearest-blip checks
Config.ClothingRooms Police room at Mission Row Job clothing rooms
Config.PlayerOutfitRooms Empty Outfit rooms limited to a job or to citizen ids
Config.OnDutyOnlyClothingRooms false Clothing rooms only for players on duty

Outfits and uniforms#

Setting Default What it does
Config.Outfits Police samples Job and gang uniforms per gender, with the grades that may wear each one
Config.BossManagedOutfits false Bosses manage their job or gang uniforms from the boss menu
Config.PersistUniforms false Put a job or gang uniform back on after a reconnect or character switch. It is kept in memory only.
Config.EnableJobOutfitsCommand false Adds /joboutfits and /gangoutfits
Config.OutfitCodeLength 10 Length of share codes

Character creator and menu#

Setting Default What it does
Config.NewCharacterSections All on except Tattoos Editor tabs in the character creator. Tattoos are bought in shops.
Config.InitialPlayerClothes Table Starting clothes for new male and female characters
Config.EnablePedMenu true Registers /pedmenu
Config.PedMenuGroup "group.admin" Who may use /pedmenu
Config.Aces { "admin" } ACE permissions the job, gang and ACE filters may use
Config.HideRadar false Hide the minimap while the menu is open
Config.AutomaticFade false Off: fades are picked by hand in the Hair tab
Config.PreventTrackerRemoval true Disable the Scarf and Chains section while the player wears a tracker
Config.DisableComponents, Config.DisableProps Tables Hide editor sections
Config.UseRadialMenu, Config.UseOxRadial false Radial menu entries
Config.RCoreTattoosCompatibility false Only for servers running rcore_tattoos

Photos#

Setting Default What it does
Config.ThumbnailUrl false Base address of your clothing photos, laid out as <url>/<gender>/<slot>/<drawable>.webp. false shows numbered tiles.
Config.ThumbnailBlanks {} Clothing idents whose photo is empty, left out of the menu
Config.PedImageUrl "https://docs.fivem.net/peds/" Ped photos in the ped menu (<url><model>.webp). false shows model names only.

Integrations#

Each switch is only used while that resource runs.

Setting Default Resource
Config.PauseMenuLegend true glitch-pauseMenu
Config.TreasurySink true glitch-treasury
Config.AnticheatIgnore true glitch-poolcleaning
Config.NetGuard false glitch-poolcleaning. When on, server/guard.lua loads that resource's guard/server.lua before any event is registered. server/guard.lua is left out of the escrow so you can read it.

Clothing locks#

Config.CollectionLocks in shared/blacklist.lua locks whole packs or single items:

Config.CollectionLocks = {
    { label = "Police", collections = { "mp_m_my_police_pack", "mp_f_my_police_pack" }, jobs = { "police" } },
    { label = "Gang colours", collections = { "mp_m_my_gang_pack" }, gangs = { "ballas" } },
    { label = "Removed", idents = { "M11-0011" } },
}

A rule with no jobs, gangs or aces hides the items from everyone. Config.Departments defines the departments that clothing tags lock items to, and Config.Blacklist keeps the upstream lock by drawable number.

Clothing idents and menu order#

Setting Default What it does
Config.ClothingIdents.Enabled false Stable names for addon clothing, from data/clothing-registry.json
Config.ClothingIdents.RequiredMigrations {} Earlier migrations that must exist before the idents migration runs
Config.ClothingIdents.ExtraTables {} Other resources' tables of saved looks to convert too
Config.ClothingIdents.StaffAce "glitchappearance.idents" Console and panel permission without glitch-admin
Config.ClothingIdents.MigrateAce "glitchappearance.idents.migrate" Run, finish and restore permission without glitch-admin
Config.ClothingIdents.MigrateStaffLevel 3 glitch-admin staff level for run, finish and restore
Config.ClothingOrder Empty Where addon clothing sits in each slot of the menu. It changes the menu order only.