Documentation
Follow the installation steps to get the script running quickly and correctly on your server, with everything you need to get started.
Before installing Quasar Banking, make sure your server meets the minimum requirements. The resource requires OneSync, a working MySQL database, and a supported framework and inventory.
Requirement | Status | Notes |
|---|---|---|
| Required | Database access |
Framework |
ESX, QBCore or QBox — auto-detected |
Inventory | Required | Must support metadata for cards |
| Optional | Set with |
| Optional | Unlocks the property desk and house collateral |
| Optional | Push notifications |
Everything framework- or third-party-specific sits behind a thin adapter, and the resource detects each layer automatically:
Layer | Detection order |
|---|---|
Framework |
|
Inventory |
|
Targeting |
|
Every optional integration degrades silently. If a resource is missing, the feature simply disappears from the interface instead of throwing errors.
After purchasing Quasar Banking, the resource is automatically linked to your CFX Portal account.
Sign in to the CFX Portal using the same account used during checkout, then open Granted Assets and locate Banking in your asset library. Download the latest version and extract the archive.
After extracting the download, you should have the following folder:
qs-bankingThe folder must be named
qs-banking. The resource checks its own name on startup and hard-stops otherwise.
Move the qs-banking folder into your server's resources directory. Although the resource can be placed anywhere inside the folder, keeping Quasar resources organized inside their own directory is recommended.
A typical installation looks like this:
resources/
└── [quasar]/
└── qs-banking/Once the resource has been copied, open your server.cfg and ensure every required dependency starts before Quasar Banking.
ensure oxmysql
# Framework
ensure es_extended
# ensure qb-core
# ensure qbx_core
# Inventory
ensure ox_inventory
ensure qs-bankingThe loading order matters. Always start your framework, oxmysql, your inventory and your targeting resource before starting qs-banking — the adapters resolve on startup, and a resource that starts later cannot be detected.
Quasar Banking stores branches, ATMs, cards, transactions, loans, society accounts, standing orders and property records inside your server's database.
Open your preferred database manager (such as phpMyAdmin, HeidiSQL, DBeaver, or Navicat), select your server's database, and execute one SQL file — the one matching your framework:
Framework | File to import |
|---|---|
ESX |
|
QBCore / QBox |
|
Import only one of them. Each file contains the full schema plus the 8 default branches.
The schema self-heals. Tables added by later versions are created on boot, and missing columns are added automatically. If an alteration fails, the console prints the exact
ALTER TABLEstatement to run by hand — so updating never requires a manual import.
The card item name is fixed: it must be called creditcard, and your inventory must support metadata.
ox_inventory — ox_inventory/data/items.lua:
['creditcard'] = {
label = 'Credit Card',
weight = 10,
stack = false,
close = true,
description = 'A bank card',
},qs-inventory / qb-inventory — shared/items.lua:
['creditcard'] = {
name = 'creditcard', label = 'Credit Card', weight = 10,
type = 'item', image = 'creditcard.png',
unique = true, useable = true, shouldClose = true,
description = 'A bank card'
},The item must be unique. A stackable card cannot carry its own card number, tier and PIN.
Card tiers are defined in Config.CardTiers, and their ids must match the themes declared in the interface — a tier with no matching theme will render without its design.
This step is only needed if you plan to lock branch doors that are not part of the game's own door list.
Add the following to your server.cfg:
setr game_enableDynamicDoorCreation "true"Without it, those doors are picked in the creator but can never be locked.
Everything tunable lives in config.lua. The values worth reviewing first:
Config.UseTarget = 'ox_target' -- 'ox_target' | 'qb-target' | 'none'
Config.Locale = 'en' -- 40 languages in locales/
Config.AtmLimit = { ... } -- hourly ATM withdrawal cap
Config.Ownable = { ... } -- branch ownership, fees and treasury
Config.Loans = { ... } -- lending terms and credit score
Config.CardTiers = { ... } -- card tiers and their minimum credit score
Config.Creator = { ... } -- who can open /bankcreatorAfter completing the installation, restart your FiveM server.
Join your server and walk into one of the 8 default branches — the blip, the teller ped and the counter interaction should all be there.
Then, with an administrator account or a job listed in Config.Creator.jobs, run:
/bankcreatorIf the bank creator opens, Quasar Banking has been installed correctly and your server is ready to place its first custom branch.
Nothing needs a restart from here on. Every branch, ATM, ped, blip, door and licence change is broadcast to clients immediately.