Docs /Banking/Installation
v1.0.0

Installation — foltone_banking

Requirements

  • ESX Legacy or QBCore or QBX — Framework
  • oxmysql — MySQL library

Optional Dependencies

DependencyPurpose
esx_addonaccountSociety accounts (ESX only)
qb-bankingSociety accounts (QBCore / QBX only)
ox_targetTarget interaction mode
qb-targetTarget interaction mode
qtargetTarget interaction mode
ox_inventoryPhysical bank card as item
lb-phonePhone notifications
qs-smartphonePhone notifications
gksphonePhone notifications

Download

Download the script from your Tebex account and place the foltone_banking folder in your resources/ directory.

Server Configuration

Add to your server.cfg:

ensure oxmysql
ensure es_extended       # or qb-core / qbx_core
ensure esx_addonaccount  # ESX only, for society accounts
ensure foltone_banking

Important: foltone_banking must start after your framework and oxmysql. If you use optional dependencies (ox_target, lb-phone, etc.), ensure them before foltone_banking.

Framework

The script supports 3 frameworks:

FrameworkConfig valueRequired dependenciesSociety dependency
ESX Legacy"esx"es_extended, oxmysqlesx_addonaccount
QBCore"qbcore"qb-core, oxmysqlqb-banking
QBX"qbx"qbx_core, oxmysqlqb-banking

Set the framework in config.lua:

Config.Framework = "esx" -- "esx", "qbcore" or "qbx"

Database Setup

Fresh Install

Run the sql/install.sql file in your database. This creates all required tables:

  • foltone_banking_accounts — Personal accounts
  • foltone_banking_transactions — Personal transaction history
  • foltone_banking_cards — Bank cards
  • foltone_banking_society_transactions — Society transaction history
  • foltone_banking_joint_accounts — Joint accounts
  • foltone_banking_joint_members — Joint account members
  • foltone_banking_joint_transactions — Joint transaction history
  • foltone_banking_savings — Savings accounts
  • foltone_banking_savings_locks — Fixed-term deposits
  • foltone_banking_crypto_holdings — Crypto portfolios
  • foltone_banking_crypto_trades — Crypto trade history
-- Import the full schema
SOURCE sql/install.sql;

Updating from a Previous Version

If you are updating from an earlier version, run the appropriate migration files in order:

Migration fileAdds
sql/migrate_phase3.sqlCredit score, account levels, interest, taxation columns
sql/migrate_phase4.sqlJoint accounts tables
sql/migrate_phase5.sqlSavings and crypto tables, extended transaction ENUM

Warning: Only run migration files that correspond to versions you have not yet installed. Running install.sql on a fresh server already includes everything.

Verification

After restarting your server:

  1. Check the server console for any errors related to foltone_banking
  2. Connect with a character
  3. Go to a bank location (a PED should be spawned at configured positions) or approach an ATM
  4. Interact with the bank PED or ATM to open the banking interface
  5. The NUI should appear with the dashboard showing your balance, IBAN, and available operations