GKSHOP
GKS Bank

Installation

Install GKS Bank on your FiveM server.

GKS Bank

Full banking for FiveM — ESX, QBCore, QBox and Standalone

Get it

This guide is for GKS Bank 1.0.0 and newer. Back up your database before installing a new banking resource.

Requirements

Install these resources before GKS Bank:

  • ox_lib
  • oxmysql
  • One supported framework: ESX, QBCore, QBox, or Standalone

1. Download the resource

Download GKS Bank from your Cfx.re granted assets and extract it into your server's resources directory.

Keep the resource folder name as gks-banking:

resources/
└── [banking]/
    └── gks-banking/
        ├── bridge/
        ├── client/
        ├── compat/
        ├── config/
        ├── install/
        ├── locales/
        ├── server/
        ├── web/dist/
        └── fxmanifest.lua

2. Add the start order

Add the resources to server.cfg in this order:

server.cfg
ensure ox_lib
ensure oxmysql
ensure your-framework
ensure gks-banking

Replace your-framework with your framework resource name. For Standalone, remove that line.

3. Select your framework

Open config/config.lua and set the framework:

config/config.lua
Config.Framework = 'auto'

Available values are auto, esx, qbcore, qbox, and standalone. auto is recommended for standard framework installations.

Review config/config_bridge.lua for permissions, identifiers, and inventory detection.

4. Set the language and currency

config/config.lua
Config.Locale = 'en'

Config.Currency = {
    symbol   = '$',
    code     = 'USD',
    decimals = 2,
    position = 'before',
    thousand = ',',
    decimal  = '.',
}

Use tr for Turkish. Currency settings control the display format only.

5. Install the database

The recommended setup uses the built-in baseline installer:

config/config.lua
Config.Database.AutoInstall = true
Config.Database.AutoMigrate = true

Start the server once. GKS Bank creates the schema from install/gkbank.sql automatically.

If you prefer a manual setup, import install/gkbank.sql once with HeidiSQL, DBeaver, phpMyAdmin, or your preferred database tool. Do not import it repeatedly into an existing database.

6. Add inventory items

Inventory items are registered automatically when supported. If your inventory is read-only, add the definitions from the matching template:

InventoryTemplate
ox_inventoryinstall/items/ox_inventory.lua
qb-inventoryinstall/items/qb-core.lua
ESX default inventoryinstall/items/esx_items.sql

The default item names are:

bank_card
bank_chequebook
bank_cheque
bank_receipt

Change the item names in config/config.lua before registering them if your server already uses these names.

7. Start and verify

Restart the resource:

restart gks-banking

Then verify:

  • The resource starts without errors.
  • A bank location opens the banking UI.
  • An ATM opens the ATM flow.
  • Deposit, withdrawal, and transfer work.
  • The balance is still correct after reconnecting.
  • Physical card or cheque items work when enabled.
  • The phone app appears when phone banking is enabled.

Continue with Configuration after the basic checks pass.

Do not run another authoritative banking resource together with GKS Bank. GKS Bank already provides compatibility exports for common banking resources.

On this page