Installation

nc-banking V2 (2.0.0+) — fresh install or upgrade from V1.

This guide explains how to install nc-banking V2 on a new server and how to safely
upgrade from nc-banking V1.

Prerequisites

  • FiveM server (latest recommended artifacts)
  • oxmysql — database driver
  • ox_lib — callbacks, UI
  • One of: QBCore / QBox / ESX / OX Core

1. Download

  1. Purchase and download nc-banking from your Tebex store.
  2. Extract the archive.

V2 uses the same resource name (nc-banking) as V1 so it can drop in as an upgrade.

2. Place Resource

Place the nc-banking folder in your server's resources directory.

Example:

resources/
  └── [noxcore]/
      └── nc-banking/

If you are upgrading from V1, replace the old nc-banking folder with the new one
(after backing it up — see upgrade notes below).

3. Database

Database tables are automatically created and upgraded on first start when
Config.AutoInstallSQL = true (default).

On startup, nc-banking will:

  • Detect if required tables already exist
  • Create any missing tables (accounts, loans, invoices, cards, branch/vault tables, etc.)
  • Run upgrade migrations for new columns/features

If you prefer manual setup, run sql/install.sql in your database and set
Config.AutoInstallSQL = false in config/config.lua.

4. server.cfg

Add nc-banking to your server cfg after oxmysql, ox_lib, and your framework:

ensure oxmysql
ensure ox_lib
ensure qb-core       # or es_extended, ox_core, qbx_core
ensure nc-banking

⚠️ Load order matters: nc-banking must start after oxmysql, ox_lib, and your framework.

5. Basic Configuration

Edit config/config.lua. Most settings work out of the box, but key options to check:

-- Framework auto-detected, or set manually:
Config.Framework = 'auto'    -- 'qbcore' | 'qbox' | 'esx' | 'ox' | 'auto'

-- Target system auto-detected, or set manually:
Config.TargetSystem = 'auto' -- 'ox_target' | 'qb-target' | 'qtarget' | 'interact'

-- Inventory system auto-detected from presets:
Config.InventorySystem = 'auto'

-- Language (locale files in locales/ folder):
Config.Locale = 'en'         -- 'en' | 'de' | 'es' | 'fr' | 'pt'

For all other options — including the banking job & branch system under
Config.BankingJob — see the Configuration page.

6. Language / i18n (Optional)

nc-banking ships with 5 locales. Set your preferred language:

Config.Locale = 'en'  -- English (default)
-- Config.Locale = 'de'  -- German
-- Config.Locale = 'es'  -- Spanish
-- Config.Locale = 'fr'  -- French
-- Config.Locale = 'pt'  -- Portuguese

Locale files live in the locales/ folder. You can:

  • Edit the shipped locales to change wording.
  • Copy an existing file to add a new language and translate the strings.

Both server-side messages (shared/locale.lua) and NUI text (web/src/utils/locale.js)
use the same i18n system.

7. Bank Card Item (Optional)

If you enable the inventory-based card system (Config.BankCard.useInventory = true),
register the card item in your inventory system.

ox_inventory

Add to ox_inventory/data/items.lua:

['atm_card'] = {
    label = 'Bank Card',
    weight = 0,
    stack = false,
    description = 'Fleeca Bank Card',
},

QBCore (qb-core/shared/items.lua)

['atm_card'] = {
    name = 'atm_card',
    label = 'Bank Card',
    weight = 0,
    type = 'item',
    image = 'atm_card.png',
    unique = true,
    useable = false,
    shouldClose = false,
    description = 'Fleeca Bank Card',
},

If useInventory = false, no item registration is needed — cards are tracked in the
database only. The item name is configurable via Config.BankCard.itemName
(default: atm_card).

8. Admin Permissions (Optional)

For ATM spawning and calibration commands, grant ACE permissions:

# server.cfg
add_ace group.admin nc-banking.admin allow

Or per player:

add_ace identifier.license:xxxx nc-banking.admin allow

9. Restart & Verify

Restart or start nc-banking:

refresh
ensure nc-banking

Watch the server console for:

[nc-banking] Database schema installed successfully!
[nc-banking] Framework detected: qbcore
[nc-banking] Inventory detected: ox_inventory
[nc-banking] Locale loaded: en (... keys)

If you enabled the banking job, also look for logs related to branch tables and
vaults being created.

Troubleshooting

  • "Failed to detect framework"

    • Ensure your framework resource starts before nc-banking in server.cfg.

  • "No external inventory detected"

    • The resource will fall back to native framework inventory functions.
      This is normal if you are not using a standalone inventory.

  • Tables not creating

    • Check that oxmysql is running and database connection is configured.
    • Ensure Config.AutoInstallSQL = true on first start.

  • NUI not showing

    • Ensure the html/ folder contains index.html and the assets/ directory with
      the built JS/CSS files. If you are developing, run npm run build in the web/
      folder.
Last updated 1 month ago