Studios
Chop Shophouse-3.jpg

Installation

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

Requirements#

Framework qbx_core (Qbox) used directly, or ESX, QBCore or Qbox through glitch-abstraction.
Resources ox_lib and oxmysql. Without glitch-abstraction you also need ox_inventory and ox_target. With it, the inventory can be ox_inventory, qb-inventory or the ESX inventory, and the target ox_target or qb-target.
Server A FiveM server artifact with OneSync enabled.
Database No tables of its own. The resource reads your owned vehicles table to refuse player-owned cars and keeps cooldowns in resource KVP.
Optional glitch-xpSystem (levels, XP and perks), glitch-criminaltablet (REP, the Fence, the tablet map), glitch-uiElements (task list), rc-interactions (yard boss dialogue), ps-dispatch or cd_dispatch (police alerts), glitch-economy (crime ledger), glitch-tebex (store car protection), glitch-pauseMenu (map legend names), glitch-poolcleaning (net event guard)

Tested with qbx_core 1.24.0, ox_inventory 2.48.0, ox_lib 3.40.0, ox_target 1.17.2, oxmysql 2.14.2, glitch-abstraction 1.1.0 and ps-dispatch 3.0.0.

The optional resources are detected at run time. When one is not running, its feature is skipped and the rest works as normal.

Installation steps#

  1. Copy the glitch-chopShop folder into your resources folder. The folder name is the resource name and is case-sensitive, so keep it exactly as glitch-chopShop.

  2. Add the items. Paste install/ox_inventory_items.lua into ox_inventory/data/items.lua, paste install/qb_core_items.lua into qb-core/shared/items.lua, or run install/esx_items.sql against your ESX database if you use the ESX inventory.

  3. Add item images. The package ships none. Put a PNG named after each item in your inventory's image folder: car_door, car_hood, car_wheel, car_mirror, car_headlight, muffler, steeringwheel, car_speakers, car_radio, car_battery, car_brakes, sport_rim, airbag, car_ecu, car_turbo, catalytic_converter.

  4. Check the dirty money. Selling at the yard pays dirty money by default. On ESX that is the black_money account. On every other setup it is the item named in ServerConfig.Selling.dirtyItem (black_money), so make sure that item exists, or set ServerConfig.Selling.dirty = false to pay cash.

  5. Add the resource to server.cfg, after ox_lib, oxmysql, your framework, inventory and target, and after glitch-abstraction if you use it:

    ensure ox_lib
    ensure oxmysql
    ensure qbx_core
    ensure ox_inventory
    ensure ox_target
    # ensure glitch-abstraction   (only if you use it)
    ensure glitch-chopShop
    

    On ESX or QBCore, put your own framework, inventory and target in place of the Qbox lines.

  6. Set up the yards in config/shared.lua. Two example yards are included (ids eastls and sandyshores). Rename them to suit your city and move them if those spots are taken on your map.

  7. Give staff the admin command. /chopadmin is restricted to group.admin through ox_lib, so anyone in that group can use it:

    add_principal identifier.license:YOUR_LICENSE group.admin
    
  8. Optional: set up the integrations below.

Optional integrations#

glitch-xpSystem: add a chopping category whose maxLevel matches ServerConfig.TierWeights.maxLevel (20). The resource reads the perk keys chop_speed, chop_skill, chop_rare, chop_bonus, chop_double, chop_price, chop_alert, chop_torch, chop_list, chop_yard_aura and chop_yard_cut. Leave out any you do not want. The Loot & Perks page lists what each one does.

glitch-criminaltablet: add a chop job (ServerConfig.Tablet.jobId), add the parts to the Fence's sell list, and list glitch-chopShop with the GetTabletPlaces export as a places provider.

rc-interactions: open /interactioneditor, import rc-interactions/chop_yard_boss.json and press Save. The server finds the flow by its name, Chop Shop - Yard Boss. If you do not use rc-interactions, set Config.Interactions.useRcInteractions = false.

Commands#

Command Who What
/chopadmin status group.admin List every yard and who has a car in its bay
/chopadmin end <yard> group.admin Close a bay and crush the car
/chopadmin cooldown <playerId> group.admin Clear a player's drop-off cooldown

Updating#

Back up config/shared.lua, config/server.lua and locales/, replace the folder, then merge your settings into the new config files. Read CHANGELOG.md for new settings. Cooldowns live in resource KVP and survive the update. If you use the yard boss dialogue and the new version ships a changed rc-interactions/chop_yard_boss.json, import it again and press Save.