Installation

💎 PAID | Purchase on Tebex

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

Prerequisites

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

Step 1: Download

Purchase and download nc-atm from noxcore.tebex.io, then extract the archive.

Step 2: Place Resource

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

resources/
  nc-atm/
    bridge/
    client/
    config/
    html/
    locales/
    server/
    fxmanifest.lua

Step 3: Database

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

Three tables are created:

Step 4: server.cfg

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

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

Step 5: Configuration

Edit config/config.lua. Key settings to check on first install:

-- Framework (auto-detected by default)
Config.Framework = 'auto'    -- 'qbcore' | 'qbox' | 'esx' | 'ox' | 'auto'

-- Target system (auto-detected by default)
Config.TargetSystem = 'auto' -- 'ox_target' | 'qb-target' | 'qtarget' | 'interact' | 'auto'

-- PIN settings
Config.RequirePin      = true
Config.DefaultPin      = '0000'
Config.PinLength       = 4
Config.MaxPinAttempts  = 5
Config.PinLockoutTime  = 30   -- seconds

-- Admin permission (set to ACE string for production)
Config.AdminAcePermission = false  -- e.g. 'nc-atm.admin'

Step 6: Admin Permissions (Production)

For a live server, set ACE permissions to restrict admin commands:

Config.AdminAcePermission = 'nc-atm.admin'

Then grant it in your server.cfg:

add_ace group.admin nc-atm.admin allow

Step 7: Verify

Start the server and check the console for:

[nc-atm] Database ready.

Approach any ATM in-game and press E (or use your target system) to open it.

Admin Commands