Installation Guide

Welcome to Oxide Banking by Oxide Studios. This guide will walk you through installing and configuring the resource on your QBCore FiveM server.

---

Table of Contents

1. Prerequisites
2. Download & Placement
3. Database Setup
4. Server Configuration
5. Migration from qb-banking
6. First Launch Verification
7. Support

---

Prerequisites

Before installing Oxide Banking, ensure you have:

Requirement	Description
qb-core	QBCore framework (required)
oxmysql	MySQL database resource (required)
qb-weathersync	For in-game time scheduling (optional, recommended)

Note: If qb-weathersync is not installed, the resource will fall back to real-time scheduling for interest, loans, and other time-based features.

---

Download & Placement

1. Download the oxide-banking resource from your purchase location.

2. Extract the folder to your server's resources directory:

   resources/
   └── [your-folder]/
       └── oxide-banking/
           ├── client/
           ├── server/
           ├── config/
           ├── html/
           ├── sql/
           ├── locales/
           └── fxmanifest.lua

3. Ensure the folder is named exactly oxide-banking.

---

Database Setup

Fresh Installation

If you are NOT migrating from qb-banking:

1. Open your database management tool (HeidiSQL, phpMyAdmin, etc.)

2. Select your FiveM server database

3. Run the SQL file located at:

   oxide-banking/sql/install.sql

4. This creates all required tables:

   • bank_accounts - Shared/job/gang accounts
   • bank_statements - Transaction history
   • bank_player_accounts - Player metadata and tiers
   • bank_credit_scores - Credit score data
   • bank_loans - Loan records
   • bank_cards - Bank card data
   • And 15+ additional tables for all features

Migration from qb-banking

If you are upgrading from qb-banking, see Migration from qb-banking below.

---

Server Configuration

Step 1: Remove or Disable qb-banking

Oxide Banking replaces qb-banking. You must remove or disable the original:

Option A - Remove from server.cfg:

# Remove or comment out this line:
# ensure qb-banking

Option B - Delete the resource: Delete the qb-banking folder from your resources directory.

Important: Do NOT run both resources at the same time.

Step 2: Add oxide-banking to server.cfg

Add the following to your server.cfg:

# Oxide Banking - Must start AFTER qb-core and oxmysql
ensure oxide-banking

Step 3: Ensure Correct Start Order

Your resource start order should look like this:

ensure oxmysql
ensure qb-core

# Other QBCore resources...
ensure qb-inventory
ensure qb-policejob
# etc...

# Banking - ensure it starts after core resources
ensure oxide-banking

Step 4: Configure Target System (Optional)

If you use qb-target for interactions, add this convar before ensuring the resource:

# Enable qb-target integration (set to 'true' or 'false')
set UseTarget "true"

ensure oxide-banking

If UseTarget is set to false or not set, the resource will use proximity-based interaction (press E near banks/ATMs).

---

Migration from qb-banking

If you have an existing qb-banking installation with player data:

Step 1: Backup Your Database

This is critical! Before migrating, create a full backup of your database.

-- Example backup command (adjust for your setup)
mysqldump -u username -p database_name > backup_before_migration.sql

Step 2: Stop Your Server

Shut down your FiveM server completely.

Step 3: Run the Migration Script

1. Open your database management tool

2. Run the SQL file located at:

   oxide-banking/sql/migrate.sql

3. The migration script will:

   • Preserve your existing bank_accounts and bank_statements tables
   • Add any missing columns to existing tables
   • Create new tables for enhanced features
   • Initialize all existing players with:
     • Basic tier accounts
     • Starting credit score of 600

Step 4: Update server.cfg

Replace qb-banking with oxide-banking in your server.cfg:

# Remove this:
# ensure qb-banking

# Add this:
ensure oxide-banking

Step 5: Start Your Server

Start your server and verify the migration was successful.

What Gets Migrated

Data	Migration Status
Bank account balances	Preserved
Shared/Job/Gang accounts	Preserved
Transaction history	Preserved
Player bank cards	Linked to checking accounts

What's New After Migration

All players will start with:

• Basic tier account (free)
• Credit score of 600 (Fair rating)
• Access to all new features based on their tier

---

First Launch Verification

After starting your server, verify the installation:

1. Check Server Console

Look for these startup messages:

[qb-banking-plus] Server-side initialization complete
[qb-banking-plus] Client zones.lua loaded
[qb-banking-plus] qb-target zones registered  (if using qb-target)
-- OR --
[qb-banking-plus] Proximity zones registered  (if not using qb-target)

2. Test In-Game

1. Connect to your server as a player
2. Visit a bank location (default locations have map blips)
3. Interact with the bank (target or press E)
4. Verify the banking UI opens
5. Test an ATM:
   • You need a bank card in your inventory
   • Interact with any ATM prop
   • Enter your PIN to access the ATM

3. Verify Database Tables

Check that all tables were created:

SHOW TABLES LIKE 'bank_%';

You should see approximately 20+ tables with the bank_ prefix.

4. Common Startup Issues

Issue	Solution
"qb-core not found"	Ensure qb-core starts before oxide-banking
"oxmysql not found"	Ensure oxmysql starts before oxide-banking
Database errors	Verify SQL script ran successfully
UI not opening	Check browser console (F8) for errors
ATM not working	Ensure player has bank_card item in inventory

---

Support

If you encounter any issues during installation:

1. Check the troubleshooting guide: See Troubleshooting for common issues
2. Join our Discord: https://discord.gg/dZ6q8FyGhm
3. Open a support ticket with:
   • Server console errors
   • Client console errors (F8)
   • Steps to reproduce the issue

---

Next Steps

After installation, we recommend:

1. Configure the resource: See Configuration
2. Review features: See Features
3. Customize the UI: See UI Customization