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
ox_libYes
Target SystemYesox_target / qb-target / qtarget / TextUI fallback
MinigameYesAny of the supported minigames listed above
InteractSoundOptionalFor SFX
InventoryYesAny of the supported inventories listed above

TIP

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

1 Add the Resource

  1. Download the latest version of sd-yacht 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 qb-core

ensure sd-yacht

2 Add Items

Register the required items in your inventory system:

lua
['yachtcodes'] = {
    label = 'Yacht Access Codes',
    weight = 200,
    stack = false,
    close = true,
    description = 'The first half of codes for the Yacht',
    consume = 0,
    server = {
        export = 'sd-yacht.useYachtcodes',
    },
},
['casinocodes'] = {
    label = 'Casino Access Codes',
    weight = 200,
    stack = false,
    close = true,
    description = 'The first half of codes for the Casino',
    consume = 0,
    server = {
        export = 'sd-yacht.useCasinocodes',
    },
},
['secured_safe'] = {
    label = 'Safe',
    weight = 200,
    stack = false,
    close = true,
    description = 'Meant to protect valuables',
    consume = 0,
},
['expensive_champagne'] = {
    label = 'Champagne',
    weight = 200,
    stack = true,
    close = true,
    description = 'A sparkling wine from France',
    consume = 0,
},
['default_gateway_override'] = {
    label = 'Gateway Override',
    weight = 200,
    stack = false,
    close = true,
    description = 'A default gateway override on a usb',
    consume = 0,
},
['revivekit'] = {
    label = 'Revival Kit',
    weight = 3000,
    stack = false,
    close = true,
    description = 'When your pal needs that pick me up',
    consume = 0,
    server = {
        export = 'sd-yacht.useRevivekit',
    },
},
lua
['yachtcodes']               = { name = 'yachtcodes',               label = 'Yacht Access Codes',  weight = 200,  type = 'item', image = 'yachtcodes.png',               unique = true,  useable = true,  shouldClose = true,  description = 'The first half of codes for the Yacht' },
['casinocodes']              = { name = 'casinocodes',              label = 'Casino Access Codes', weight = 200,  type = 'item', image = 'casinocodes.png',              unique = true,  useable = true,  shouldClose = true,  description = 'The first half of codes for the Casino' },
['secured_safe']             = { name = 'secured_safe',             label = 'Safe',                weight = 200,  type = 'item', image = 'secured_safe.png',             unique = true,  useable = true,  shouldClose = true,  description = 'Meant to protect valuables' },
['expensive_champagne']      = { name = 'expensive_champagne',      label = 'Champagne',           weight = 200,  type = 'item', image = 'expensive_champagne.png',      unique = false, useable = true,  shouldClose = true,  description = 'A sparkling wine from France' },
['default_gateway_override'] = { name = 'default_gateway_override', label = 'Gateway Override',    weight = 200,  type = 'item', image = 'default_gateway_override.png', unique = true,  useable = true,  shouldClose = true,  description = 'A default gateway override on a usb' },
['revivekit']                = { name = 'revivekit',                label = 'Revival Kit',         weight = 3000, type = 'item', image = 'revivekit.png',                unique = true,  useable = true,  shouldClose = false, description = 'When your pal needs that pick me up' },
sql
INSERT INTO `items` (`name`, `label`, `weight`) VALUES
  ('yachtcodes', 'Yacht Access Codes', 2),
  ('casinocodes', 'Casino Access Codes', 2),
  ('secured_safe', 'Safe', 2),
  ('expensive_champagne', 'Champagne', 2),
  ('default_gateway_override', 'Gateway Override', 2),
  ('revivekit', 'Revival Kit', 30);

3 Add Item Images

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

Yacht Item Images6 images
Casino Codes
casinocodes.png
Gateway Override
default_gateway_override.png
Expensive Champagne
expensive_champagne.png
Revive Kit
revivekit.png
Secured Safe
secured_safe.png
Yacht Codes
yachtcodes.png

4 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-yacht

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.