Installation

Basic installation instructions for wasabi_banking.

danger

The resource folder must be named wasabi_banking.

warning

Remove or disable other banking scripts before installing (esx_banking, qb-banking, Renewed-Banking, okokBanking, and any previous wasabi_banking v1 install). If you are migrating existing balances, see Migration first.

Before installing

1. Install the required dependencies.
2. Remove or disable any existing banking resource for your framework.
3. Make sure ox_lib and oxmysql start before wasabi_banking.
4. Keep the public resource name as wasabi_banking in your resources folder and server.cfg.

Add the resource

1. Add the resource to your server resources folder as wasabi_banking.
2. Ensure dependencies and the resource in server.cfg:

ensure ox_lib
ensure oxmysql
ensure es_extended # or qb-core / qbx_core
ensure wasabi_banking

3. Configure the shared, client, and server config files as needed.
4. Database tables are created automatically when Config.AutomaticAddDatabaseTables = true (default).

Inventory items

Add the bankcard and transactionsreceipt items for your inventory. Examples ship in _invItems/data.lua.

ox_inventory

Add to ox_inventory/data/items.lua:

["bankcard"] = {
    label = 'Bank Card',
    description = 'A bank card for the bank.',
    weight = 1,
    stack = false,
    close = true,
    consume = 0,
    server = {
        export = "wasabi_banking.bankcard"
    }
},

["transactionsreceipt"] = {
    label = 'Transaction Receipt',
    description = 'A receipt for a transaction.',
    weight = 1,
    stack = false,
    close = true,
    consume = 0
},

info

No client Item() patch is required. The bankcard uses the server export wasabi_banking.bankcard.

qb-inventory / ps-inventory

Add to your shared items file (for example qb-core/shared/items.lua):

["bankcard"] = {
    name = "bankcard",
    label = "Bank Card",
    weight = 1,
    type = "item",
    image = "bankcard.png",
    unique = false,
    useable = true,
    shouldClose = true,
    combinable = nil,
    description = "A bank card for the bank.",
},
["transactionsreceipt"] = {
    name = "transactionsreceipt",
    label = "Transaction Receipt",
    weight = 1,
    type = "item",
    image = "transactionsreceipt.png",
    unique = false,
    useable = true,
    shouldClose = true,
    combinable = nil,
    description = "A receipt for a transaction.",
},

codem-inventory

Add to codem-inventory/config/itemlist.lua (Config.Itemlist):

["bankcard"] = {
    name = "bankcard",
    label = "Bank Card",
    weight = 1,
    type = "item",
    image = "bankcard.png",
    unique = false,
    useable = true,
    shouldClose = true,
    description = "A bank card for the bank.",
},
["transactionsreceipt"] = {
    name = "transactionsreceipt",
    label = "Transaction Receipt",
    weight = 1,
    type = "item",
    image = "transactionsreceipt.png",
    unique = false,
    useable = true,
    shouldClose = true,
    description = "A receipt for a transaction.",
},

tgiann-inventory

Add to tgiann-inventory/items/items.lua (itemsData). Resolve any name clashes with existing items:

["bankcard"] = {
    hasMetadata = true,
    label = "Bank Card",
    weight = 1,
    type = "item",
    image = "bankcard.png",
    unique = true,
    useable = true,
    shouldClose = true,
    description = "A bank card for the bank.",
},
["transactionsreceipt"] = {
    hasMetadata = true,
    label = "Transaction Receipt",
    weight = 1,
    type = "item",
    image = "transactionsreceipt.png",
    unique = true,
    useable = true,
    shouldClose = true,
    description = "A receipt for a transaction.",
},

jaksam_inventory

Add under Script.Items in jaksam_inventory/_data/items.lua. Items are driven by wasabi_banking via registerUsableItem; you do not need an onUse handler here:

['bankcard'] = {
    label = 'Bank Card',
    description = 'A bank card for the bank.',
    weight = 1,
    stack = false,
    close = true,
    consume = 0,
},
['transactionsreceipt'] = {
    label = 'Transaction Receipt',
    description = 'A receipt for a transaction.',
    weight = 1,
    stack = false,
    close = true,
    consume = 0,
},

Optional inventory images

Use the provided inventory item images from the installation / _invItems directory if your inventory expects image files.

Configure

Edit:

• config/shared/config.lua — currency, cards, banks, ATM models
• config/client/config.lua — interact, notify, progress
• config/server/config.lua — logger, society, inventory, loans, admin access

See Configuration.

Commands

Command	Who	Purpose
/bankmenu	Jobs/grades in Config.BankManager.jobnames	Opens the bank admin panel
/openbank [main|atm|admin]	Anyone when Config.Debug = true	Dev-only local UI opener

Migrating from another banking script?

Do not follow only this fresh-install page. Use Migration to import Wasabi v1, qb-banking, Renewed-Banking, or okokBanking data safely.

Final checklist

• Resource folder is named wasabi_banking.
• Old banking resources are disabled.
• ox_lib, oxmysql, and your framework start before wasabi_banking.
• Inventory items are installed for your inventory backend.
• Config files are reviewed.
• Bank locations and ATM models are tested in-game.