NX CreativeNX CreativeDocs
ScriptsRealbanking

Installation

Resource-specific setup for nx_realbanking. Dependencies, database import, and framework detection.

For server-wide prerequisites (artifacts, oxmysql, ox_lib), work through the generic install guide first. This page only lists what is specific to nx_realbanking.

Dependencies

Framework detection is automatic: ESX Legacy (1.9.0+) or QBCore. Make sure the framework resource starts before nx_realbanking.

oxmysql
Required

Database driver for all persistent state.

ox_lib
Required

Callbacks, notifications, and UI utilities.

nx-3d
Required

Renders the ATM UI onto 3D in-world panels (screen and keypad).

ox_inventory
Optional

Physical bank cards, ATM receipts, and credit-card items.

ox_target
Optional

Target-based ATM and bank-ped interaction. qb-target is also supported via Config.TargetSystem.

Database import

Import the two SQL files into the same database oxmysql points at:

mysql -u <user> -p <database> < sql/schema.sql
mysql -u <user> -p <database> < sql/invoices_schema.sql

The schemas create:

  • nx_realbanking_accounts. Account records.
  • nx_realbanking_transactions. Transaction history.
  • nx_realbanking_daily_limits. Daily limit counters.
  • nx_realbanking_interaction_logs. Security and audit trail.
  • Invoice tables. Invoices, items, autopay, credit cards, billing.

[!tip] sql/schema.sql also renames older legacy columns when upgrading from a pre-release version. A fresh install can ignore name_change.sql, it is only for existing installs.

server.cfg order

ensure oxmysql
ensure ox_lib
ensure nx-3d
# ensure your framework here (es_extended or qb-core)
ensure nx_realbanking

Optional items

If ox_inventory is present, register the card and receipt items in ox_inventory/data/items.lua:

['bank_card'] = {
    label = 'Maze Bank Card',
    weight = 10,
    stack = false,
    close = true,
    description = 'Official Maze Bank debit card'
},
['atm_receipt'] = {
    label = 'ATM Receipt',
    weight = 0,
    stack = true,
    close = false,
    decay = 1440
},
['credit_card'] = {
    label = 'Credit Card',
    weight = 10,
    stack = false,
    close = true
}

The credit-card item name is configurable, see Config.Credit.items.creditCardItem.

Convars

Set these in server.cfg to override runtime behavior without editing the config file:

set nx_realbanking:debug "true"
set nx_realbanking:locale "en"
set nx_realbanking:framework "auto"  # auto | esx | qbcore