Skip to content

Installation

Supported Inventories

InventoryStatus
ox_inventorySupported
tgiann-inventorySupported
jaksam_inventorySupported
qs-inventorySupported
qs-inventory-proSupported
qb-inventorySupported
ps-inventorySupported
lj-inventorySupported
codem-inventorySupported

Recommendation

We heavily recommend using ox_inventory — it's the best inventory system available and more importantly, it's completely free and open source! You won't be missing out on any features in our scripts if you use a different inventory, this is simply a recommendation.

Supported Minigames

You only need one of the following minigame resources installed. Pick whichever you prefer.

ResourceMinigames
ps-uips-circle, ps-maze, ps-varhack, ps-thermite, ps-scrambler
memorygamememorygame-thermite
ran-minigamesran-memorycard, ran-openterminal
hackinghacking-opengame
howdy-hackminigamehowdy-begin
SN-Hackingsn-memorygame, sn-skillcheck, sn-thermite, sn-keypad, sn-colorpicker
rm_minigamesrm-typinggame, rm-timedlockpick, rm-timedaction, rm-quicktimeevent, rm-combinationlock, rm-buttonmashing, rm-angledlockpick, rm-fingerprint, rm-hotwirehack, rm-hackerminigame, rm-safecrack
ox_liblib.skillCheck
bl_uibl-circlesum, bl-digitdazzle, bl-lightsout, bl-minesweeper, bl-pathfind, bl-printlock, bl-untangle, bl-wavematch, bl-wordwiz
glitch-minigamesgl-firewall-pulse, gl-backdoor-sequence, gl-circuit-rhythm, gl-surge-override, gl-circuit-breaker, gl-data-crack, gl-brute-force, gl-var-hack

Dependencies

Ensure the following dependencies are installed and running on your server before starting:

DependencyRequiredNotes
FrameworkYesqb-core / qbx_core / es_extended
sd_libYes
Target SystemYesox_target / qb-target / qtarget
DoorlockYesox_doorlock / qb-nui_doorlock
MinigameOptionalAny of the supported minigames listed above, can be disabled
InventoryYesAny of the supported inventories listed above

TIP

Framework, target system, doorlock, and inventory are all automatically detected — no configuration needed.

1 Add the Resource

  1. Download the latest version of sd-traphouse from the CFX Portal
  2. Extract it into your server's resources directory
  3. Ensure the resource is started in your server.cfg (or resources.cfg, in case you load resources differently). Simply ensuring the sub-folder (i.e. ensure [sd]) will work too, provided dependencies are started in a separate sub-folder before. Here's an example:
cfg
ensure sd_lib
ensure ox_lib
ensure ox_target
ensure ox_doorlock
ensure qb-core

ensure sd-traphouse

2 Import Doorlock Data

Import the doorlock config that matches your doorlock system from the sd-traphouse/doorlock/ folder:

Doorlock SystemWhat to do
ox_doorlockImport doorlock/ox_doorlock/traphouse.sql into your database
qb-doorlock / nui_doorlockPlace doorlock/qb-nui_doorlock/traphouse.lua into your doorlock resource's configs folder, or copy its contents into your main doorlock config

3 Add Items

Register the required items in your inventory system:

lua
['gang-keychain'] = {
    label = 'Keychain',
    weight = 50,
    stack = true,
    close = true,
    description = 'A keychain with a load of oddly labelled keys',
},
['safecracker'] = {
    label = 'Safe Cracker',
    weight = 500,
    stack = true,
    close = true,
    description = 'A specialized tool used for breaking into safes.',
},
lua
['gang-keychain'] = { name = 'gang-keychain', label = 'Gang Keychain', weight = 20,  type = 'item', image = 'gang-keychain.png', unique = true,  useable = false, shouldClose = true, description = 'A keychain with a load of oddly labelled keys' },
['safecracker']   = { name = 'safecracker',   label = 'Safe Cracker',  weight = 500, type = 'item', image = 'safecracker.png',   unique = true,  useable = false, shouldClose = true, description = 'A specialized tool used for breaking into safes.' },

4 Add Item Images

Copy the item images from sd-traphouse/images/ to your inventory's image folder. You can also download them directly from the container below.

Traphouse Item Images2 images
Gang Keychain
gang-keychain.png
Safecracker
safecracker.png

5 Start the Resource

To load the resource, you can either:

  • Restart your server entirely, or
  • Run the following commands in your server console (F8 or txAdmin live console):
cfg
refresh
ensure sd-traphouse

Configuration

Configure the resource to fit your server's needs. See the Configuration page for detailed explanations of each setting, or edit the config files directly in the resource's configs/ folder.