Installation Guide

This guide covers the verified installation steps for ARS Banking, including the database, framework selection, and the optional bank_card inventory item.

Table of Contents

1. Prerequisites
2. Installation Steps
3. Configure Inventory Items
4. Verification
5. Updating
6. Troubleshooting

Prerequisites

• ox_lib - Required for UI components and callbacks
• oxmysql - Required for database access
• ESX, QBCore, or QBX
• An inventory that can register the bank_card item if Config.UseBankCards = true

Installation Steps

1. Download and Place Resource

Place the resource in your server’s resources directory:

server-data/resources/[folder]/ars_banking/

2. Import the Database Schema

Import the provided database file:

ars_banking/sql/database.sql

This creates the banking tables used by the script:

Table	Purpose
ars_bank_accounts	Bank accounts (checking, savings, shared, job, gang)
ars_bank_statements	Transaction history and audit trail
ars_bank_loans	Loan records, applications, terms, and payment tracking
ars_bank_cards	Debit, credit, and prepaid card data
ars_bank_pos_terminals	Registered POS terminals
ars_bank_pos_transactions	POS payment records and receipts
ars_bank_investments	Player stock market holdings

3. Configure Framework

Open config.lua and set your framework:

Config.Framework = 'qb' -- 'esx', 'qb', or 'qbx'

If your server uses target interaction, keep target mode enabled:

Config.UseTarget = true

The script auto-detects the supported target resource.

4. Add to Server Config

Add the following to your server.cfg, ensuring dependencies start before ARS Banking:

ensure oxmysql
ensure ox_lib
ensure ars_banking

Configure Inventory Items

ARS Banking uses a bank_card item for ATM access when Config.UseBankCards is enabled.

Add the Bank Card Item

ESX (SQL)

Add the item to your ESX item table:

INSERT INTO items (name, label, weight, rare, can_remove) VALUES
('bank_card', 'Bank Card', 1, 0, 1);

ox_inventory and ak47_inventory (Lua)

Add the item to your inventory item file:

['bank_card'] = {
    label = 'Bank Card',
    weight = 1,
    stack = false,
    close = true,
    description = 'A physical card used for ATM access.'
}

Note: ak47_inventory uses the same Lua item format as ox_inventory.

qb-inventory (Lua)

Add the item to your shared items file:

bank_card = {
    name = 'bank_card',
    label = 'Bank Card',
    weight = 1,
    type = 'item',
    image = 'bank_card.png',
    unique = true,
    useable = true,
    shouldClose = true,
    description = 'A physical card used for ATM access.'
}

Note: qs-inventory and ps-inventory use the same format as qb-inventory.

Copy Item Images

Copy the included bank card image to your inventory’s image folder.

Source: ars_banking/images/bank_card.png

Destination paths:

Inventory	Path
ox_inventory	ox_inventory/web/images/
qb-inventory	qb-inventory/html/images/
qs-inventory	qs-inventory/html/images/
ps-inventory	ps-inventory/html/images/
ak47_inventory	ak47_inventory/web/build/images/

Restart the inventory resource or your server if the icon does not appear.

Tip: If Config.UseBankCards = false, you can skip the inventory item setup.

Verification

1. Start your server and check the console for ARS Banking errors.
2. Confirm the SQL import completed and the ars_bank_* tables exist.
3. Open a bank location and make sure the UI loads.
4. Test ATM access with and without bank_card if you changed Config.UseBankCards.
5. Verify the bank_card icon appears after copying the image.

Troubleshooting

Missing Database Tables

• Issue: The script fails to load because ars_bank_* tables are missing.
• Fix: Import sql/database.sql and confirm your database user can create tables.

Framework Not Detected

• Issue: Money does not sync with your framework.
• Fix: Verify Config.Framework matches the framework running on the server.

NUI Not Loading

• Issue: The banking interface does not appear.
• Fix: Confirm the built html/ folder exists in the resource.

Bank Card Not Working at ATM

• Issue: Using the bank card does not open the ATM interface.
• Fix: Verify Config.UseBankCards = true and that the bank_card item exists in your inventory.

---

Note: This guide is written by a third party. If you find any incorrect or outdated information, please contact us on Discord so we can update it for you.