> For the complete documentation index, see [llms.txt](https://needforscript.gitbook.io/needforscripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://needforscript.gitbook.io/needforscripts/our-scripts/banking-script/installation.md).

# Installation

## Banking Script Installation Guide

Follow these steps to install the NeedForScripts Banking Script on your FiveM server.

### Prerequisites

Before you begin, ensure you have:

1. FiveM server with administrator access
2. Access to your server's database
3. File transfer capability (FTP or direct file access)

### Step 1: Install Dependencies

The Banking Script requires two dependencies:

1. [ox\_lib](https://github.com/overextended/ox_lib)
2. [bl\_bridge](https://github.com/Byte-Labs-Studio/bl_bridge)

To install these:

1. Download `ox_lib` from [overextended GitHub repository](https://github.com/overextended/ox_lib)
2. Download `bl_bridge` from [Byte Labs GitHub repository](https://github.com/Byte-Labs-Studio/bl_bridge)
3. Place both resources in your server's resources folder
4. Add the following lines to your `server.cfg`:

   ```
   ensure ox_lib
   ensure bl_bridge
   ```
5. Add bl\_bridge convars to your server.cfg  with your server options: 

```
# Frameworks 'ox' | 'qb' | 'esx' | 'qbx'
setr bl:framework 'qb' 

# Inventories 'ox' | 'qb' | 'esx' | 'ps' | 'qs' | 'origen' | 'none'
setr bl:inventory 'ox'

# Context 'ox' | 'qb'
setr bl:context 'ox'

# Target 'ox' | 'qb'
setr bl:target 'ox'

# Progress 'ox' | 'qb'
setr bl:progressbar 'ox'

# Radial 'ox' | 'qb'
setr bl:radial 'ox'

# Notification 'ox' | 'qb' | 'esx'
setr bl:notify 'ox'

# TextUI 'ox' | 'qb' | 'esx'
setr bl:textui 'ox'
```

### Step 2: Database Setup

You need to set up two tables in your database. Run the following SQL commands:

```sql
CREATE TABLE IF NOT EXISTS `banking_cards` (
  `owner` varchar(50) NOT NULL,
  `iban` varchar(8) NOT NULL,
  `data` longtext NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=latin1 COLLATE=latin1_swedish_ci;

CREATE TABLE IF NOT EXISTS `banking_transactions` (
  `iban` varchar(8) NOT NULL,
  `data` longtext DEFAULT NULL,
  KEY `iban` (`iban`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_general_ci;
```

You can run these commands using your preferred database management tool (e.g., phpMyAdmin, MySQL Workbench).

### Step 3: Install the Banking Script

1. Download the Banking Script from your keymaster granted assets
2. Extract the files to your server's resources folder
3. Add the following line to your `server.cfg`:

   ```
   ensure nfs-banking
   ```

### Step 4: Bank Card Item Setup

{% hint style="info" %}

### QBCore Setup

{% endhint %}

Add the following to `qb-core/shared/items.lua`:

```lua
['bank_card'] = {
    name = 'bank_card',
    label = 'Bank Card',
    weight = 100,
    type = 'item',
    image = 'bank_card.png',
    unique = true,
    useable = true,
    shouldClose = false,
    combinable = nil,
    description = 'A card used for banking transactions'
},
```

{% hint style="info" %}

### QBox Setup

{% endhint %}

Add the following to `qbx-core/shared/items.lua`:

```lua
['bank_card'] = {
    name = 'bank_card',
    label = 'Bank Card',
    weight = 100,
    type = 'item',
    image = 'bank_card.png',
    unique = true,
    useable = true,
    shouldClose = false,
    combinable = nil,
    description = 'A card used for banking transactions'
},
```

{% hint style="info" %}

### ESX Setup

{% endhint %}

Add the following to your items table in your database:

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

### Image Setup

1. Place the `bank_card.png` image in your inventory resource's image folder:
   * For qb-inventory: `qb-inventory/html/images/`
   * For ox\_inventory: `ox_inventory/web/images/`
   * For ESX inventory: Check your specific inventory resource's image directory

### Important Notes

* Ensure the image file name matches the one specified in the item configuration
* The weight value can be adjusted based on your server's weight system
* For ESX servers using ox\_inventory, you may need to add the item to the ox\_inventory/data/items.lua file instead

### Step 5: Configuration

1. Open the `config.lua` file in the Banking Script folder
2. Adjust settings according to your server's needs (refer to our Configuration Guide for details)

### Step 6: Start Your Server

1. Save all changes
2. Start or restart your FiveM server

### Verification

To verify the installation:

1. Connect to your server
2. Check if you can access banking features in-game
3. Confirm that the banking card displays correctly in the inventory

If you encounter any issues, please check our Troubleshooting Guide or contact our support team.

Enjoy using the NeedForScripts Banking Script on your server!