Studios
Uniformshouse-3.jpg

Installation

SoonUniformsQbox
PAGE 02 OF 06  ·  OVERVIEW → INSTALLATION → CONFIGURATIONdocs.glitchstudios.dev
Browse docs

Requirements#

The server

Framework qbx_core (Qbox). ESX and plain QBCore are not supported.
Resources ox_lib, oxmysql, ox_target
Server build A FiveM artifact with OneSync enabled
Database A database oxmysql can connect to. The glitch_uniforms table is created on first start.
Optional glitch-admin (staff levels and Discord role gates, otherwise ACE is used), glitch-appearance or illenium-appearance (saves the worn uniform to the character), qbx_police (locker zones, opened through the Open export)

There are no inventory items and no images to install.

Installation steps#

  1. Copy the glitch-uniforms folder into your resources folder. The folder name is case-sensitive and must stay glitch-uniforms.

  2. The glitch_uniforms table is created when the resource starts. If your database user cannot create tables, run sql/install.sql once by hand.

  3. Open config/main.lua. Set Config.Preset = false for the generic police and EMS setup, then move the two entries of Config.Lockers to your own station interiors. The coordinates in the package are placeholders.

  4. Add the resource to server.cfg, after ox_lib, oxmysql, ox_target and qbx_core:

    ensure ox_lib
    ensure oxmysql
    ensure ox_target
    ensure qbx_core
    ensure glitch-uniforms
    
  5. Give your staff the ACE permissions below, or run glitch-admin:

    add_ace group.admin glitch-uniforms.edit allow
    add_ace group.admin glitch-uniforms.menu allow
    add_ace group.superadmin glitch-uniforms.all allow
    
  6. Start the server, dress a ped, open a locker and set the outfits up. See Examples.

[!NOTE] With the default Config.Preset, the bundled nsw example preset is picked on its own when config/presets/nsw.lua exists and glitch-admin is running. It replaces the generic departments and lockers with an example setup that uses clothing collections from another server's packs. Set Config.Preset = false or delete that file to opt out.

Updating#

Replace everything except your edited files in config/ and locales/, then restart the resource. The catalogue is stored in the database, so updating the files does not touch outfits your staff have set up. Compare your config/main.lua with the new one for added keys before you restart.