> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roadshop.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Complete setup guide for RoadBanking

# Installation

RoadBanking is a full bank for your server: checking, savings, shared and
business accounts, transfers by account number, debit cards with PIN, ATMs,
loans with a credit score, invoices and standing orders. Players use it at
bank branches and at every ATM on the map.

The checking account **is** the player's framework bank balance, so wages,
shops and every other script that pays into or charges `bank` keep working.

![RoadBanking account overview at a branch](https://mintcdn.com/roadshop/AKiPzd5n7NuA4-R3/images/roadbanking/accounts.webp?fit=max\&auto=format\&n=AKiPzd5n7NuA4-R3\&q=85\&s=3148e7596201631f44ea3ff040e12f3a)

> [!CAUTION]
>
> **Do not use FileZilla**. It can corrupt or skip hidden files during upload.
> We recommend **WinSCP**.

> [!NOTE]
>
> The download comes from the [cfx.re Portal](https://docs.roadshop.org/license-system.md). The database
> tables are created automatically on the first start.

## 📋 Prerequisites

> **oxmysql and ox\_lib**
>
> Both are required and must start before RoadBanking.

> **OneSync**
>
> Required.

> **Framework**
>
> ESX Legacy, QBCore, Qbox or no framework (standalone).

> **Target script**
>
> Optional: ox\_target or qb-target. Without one, players press **E** at the
> counter or ATM.

## 🚀 Setup Instructions

**1. Extract the resource**

Put the folder into your resources. We recommend a `[road]` folder
alongside our other scripts:

```bash theme={null}
resources/
└── [road]/
    ├── road_banking/
    └── other_scripts/
```

> [!WARNING]
>
> The folder name must stay `road_banking`. Events and exports use this
> name.

**2. Start it after its dependencies**

```cfg server.cfg theme={null}
ensure oxmysql
ensure ox_lib
# your framework and inventory
ensure road_banking
```

**3. Give your admins access**

```cfg server.cfg theme={null}
add_ace group.admin road_banking.admin allow
```

This unlocks [`/bankadmin`](https://docs.roadshop.org/roadbanking/commands) on every framework.

**4. Add the card item**

With an inventory that supports item metadata, bank cards are real items.
Without one (for example the default ESX inventory), skip this step: cards
are then bound to the player. See [Cards and ATMs](https://docs.roadshop.org/roadbanking/cards.md).

Copy `install/bank_card.png` into your inventory's image folder, then add
the item:

**ox\_inventory (ESX, Qbox)**

Image folder: `ox_inventory/web/images/`

```lua ox_inventory/data/items.lua theme={null}
['bank_card'] = {
    label = 'Bank card',
    weight = 10,
    stack = false,
    close = true,
},
```

**QBCore (qb-inventory)**

Image folder: `qb-inventory/html/images/`

```lua qb-core/shared/items.lua theme={null}
bank_card = { name = 'bank_card', label = 'Bank card', weight = 10, type = 'item', image = 'bank_card.png', unique = true, useable = false, shouldClose = true, description = 'Debit card' },
```

**5. Remove other ATM and bank interactions**

If another banking script also adds ATM and bank counter options, players
see both. Stop that script or remove its targets.

> [!WARNING]
>
> Keep the resource that holds your society money (esx\_addonaccount,
> qb-management, qbx\_management or qb-banking) running: business accounts
> read their balance from it.

## 🌐 Language

```lua config.lua theme={null}
Config.Locale = 'en'
```

English (`en`) and German (`de`) are built in. The setting changes both the
in-game texts and the bank screen. To add your own language, see
[Configuration](https://docs.roadshop.org/roadbanking/configuration.md#language).

## ✅ Verification

1. The server console shows no `road_banking` errors on start.
2. Bank blips appear on the map at the eight default branches.
3. At a branch counter or an ATM you get the target option or the
   **E** help text, and the bank opens.
4. Your checking account shows the same balance as your framework bank money.

## 📚 Next Steps

> **[Accounts and transfers](https://docs.roadshop.org/roadbanking/accounts.md)**
>
> Account types, shared accounts, transfers and history

> **[Cards and ATMs](https://docs.roadshop.org/roadbanking/cards.md)**
>
> Item cards, player-bound cards, PIN and daily limits

> **[Configuration](https://docs.roadshop.org/roadbanking/configuration.md)**
>
> Branches, fees, limits, loans and owner hooks

> **[FAQ](https://docs.roadshop.org/roadbanking/faq.md)**
>
> Any problems or questions?


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.