Installation

$50 $25 Early Access | Purchase on Tebex

Complete guide for installing nc-banking on your FiveM server.

Prerequisites

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

Step 1: Download

  1. Purchase and download nc-banking from noxcore.tebex.io
  2. Extract the archive

Step 2: Place Resource

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

Step 3: Database

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

No manual SQL execution is needed. The resource will:

  • Detect if tables exist
  • Create all 13 tables if missing
  • Run upgrade migrations for new columns/features

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

Step 4: server.cfg

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.

Step 5: 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'

Step 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 are in the locales/ folder. You can edit them or add new languages by copying an existing file and translating the strings.

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

Step 7: Bank Card Item (Optional)

If using 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).

Step 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

Step 9: Restart

refresh
ensure nc-banking

Check 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 (864 keys)

Framework-Specific Notes

QBCore

No extra steps needed. Uses qb-core exports and QBCore.Functions.

QBox (qbx_core)

Auto-detected when qbx_core resource is present. Uses qbx_core exports and ox_lib player data.

ESX

Uses es_extended exports. Ensure esx_identity is installed for character name support.

OX Core

Uses ox_core exports and Ox.GetPlayer API. Supports the OxAccount system for atomic deposits/withdrawals and group (business) account operations.

OX Core bridge uses ox_core's ClassInterface method binding — all account/player methods are called without explicit self passing (ox_core auto-binds via __index).

Troubleshooting

"Failed to detect framework"

Ensure your framework resource is started 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're not using a standalone inventory resource.

Tables not creating

Check that oxmysql is running and database connection is configured. Enable Config.AutoInstallSQL = true.

NUI not showing

Ensure the html/ folder contains index.html and the assets/ directory with built JS/CSS files. If you're developing, run npm run build in the web/ folder.

Last updated 1 month ago