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 / TextUI fallback
DoorlockYesox_doorlock / qb-nui_doorlock / cd_doorlock
MinigameYesAny of the supported minigames listed above
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-bobcat 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-bobcat

2 Import Doorlock Data

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

Doorlock SystemWhat to do
ox_doorlockImport the .sql file from doorlock/ox_doorlock/ into your database
qb-doorlock / nui_doorlockPlace the .lua file from doorlock/qb-nui_doorlock/ into your doorlock resource's configs folder, or copy its contents into your main doorlock config
cd_doorlockPlace the .json file from doorlock/cd_doorlock/ into your cd_doorlock JSON files folder, or copy its contents into your door_data.json

TIP

Bobcat includes configs for three MLO variants (Gabz, NoPIxel, K4MB1) — make sure to import the one that matches your installed MLO.

3 Add Items

Register the required items in your inventory system:

lua
['bobcatkeycard'] = {
    label = 'Bobcat Security Card',
    weight = 1000,
    stack = false,
    close = true,
    description = 'A keycard used at the Bobcat Security Deposit.',
},
['c4_bomb'] = {
    label = 'C4 Brick',
    weight = 1000,
    stack = false,
    close = true,
    description = 'Very Dangerous! High Yield Explosive.',
},
['thermite_h'] = {
    label = 'Thermite',
    weight = 1000,
    stack = false,
    close = true,
    description = 'A low-yield thermite charge.',
    server = {
        export = 'sd-bobcat.useThermite_h',
    },
},
lua
['bobcatkeycard']  = { name = 'bobcatkeycard',  label = 'Bobcat Security Card', weight = 1000, type = 'item', image = 'bobcatkeycard.png', unique = false, useable = true,  shouldClose = true, description = 'A keycard used at the Bobcat Security Deposit.' },
['c4_bomb']        = { name = 'c4_bomb',        label = 'C4 Brick',            weight = 1000, type = 'item', image = 'c4_bomb.png',       unique = true,  useable = false, shouldClose = true, description = 'Very Dangerous! High Yield Explosive.' },
['thermite_h']     = { name = 'thermite_h',     label = 'Thermite',            weight = 1000, type = 'item', image = 'thermite_h.png',    unique = true,  useable = true,  shouldClose = true, description = 'A low-yield thermite charge.' },
sql
INSERT INTO `items` (`name`, `label`, `weight`) VALUES
  ('bobcatkeycard', 'Bobcat Security Card', 1),
  ('c4_bomb', 'C4 Brick', 10),
  ('thermite_h', 'Thermite', 10);

4 Add Item Images

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

Bobcat Item Images3 images
Bobcat Keycard
bobcatkeycard.png
C4 Bomb
c4_bomb.png
Thermite
thermite_h.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-bobcat

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.