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

# Installation

> Remove the old bank, drop Awoken Banking in, and start - tables build themselves.

## Asset download

Once you buy from our official website, the asset lands in your [Cfx.re portal](https://portal.cfx.re/). Download it from there. The asset must sit on the keymaster account that made the purchase, or transfer it across first.

## What you need

<CardGroup cols={2}>
  <Card title="Required" icon="circle-check">
    **ox\_lib** and **oxmysql**. Database tables are created automatically.
  </Card>

  <Card title="Optional" icon="circle-plus">
    **ox\_target** (or the built-in prompt) to walk up to tellers and ATMs, and an **inventory** for physical bank-card items.
  </Card>
</CardGroup>

Awoken Banking works on **QBox, QBCore, and ESX** and detects your framework automatically.

## Remove your old bank first

<Warning>
  Awoken Banking **replaces** your existing bank and the society money store. It answers to the same names other scripts call (`Renewed-Banking`, `qb-banking`, `qb-management`, `esx_society`), so running the originals alongside it will clash. Delete or comment out those `ensure` lines before you start.
</Warning>

* **`Renewed-Banking` / `qb-banking`** - the player bank. Awoken Banking replaces it completely.
* **`qb-management` / `esx_society`** - the **society money store**: the shared cash behind each job and gang. Awoken Banking becomes that store, so job and gang balances, boss deposits and withdrawals, and automatic paychecks all flow through it.

<Info>
  **You do not lose hiring, firing, or rank management.** Those are part of your framework (qbx\_core / qb-core / es\_extended), not the bank. Awoken Banking only takes over the **money** side of job and gang accounts, so your job system keeps working exactly as before.
</Info>

<Note>
  Prefer to keep your own society money system and use Awoken Banking only for player accounts? Set `Config.SocietyBridge = false` and remove the `provide 'qb-management'` / `provide 'esx_society'` lines from `fxmanifest.lua`. See [Business & shared accounts](/resources/awoken-banking/configuration/society).
</Note>

## Install

<Steps>
  <Step title="Drop the folder in place">
    Put the **`awoken_banking`** folder (the one from `releases/`) into your server's `resources/`. Keep the folder name exactly `awoken_banking`.
  </Step>

  <Step title="Add the bank-card item (optional)">
    Only needed for **physical** bank cards in the inventory. Virtual cards and ATMs work without it.

    * Copy the item block from `install/inventories/` into your inventory's item list.
    * Copy `install/inventories/images/bank_card.png` into your inventory's images folder.

    To skip cards entirely, set `Config.Cards.inventory.enabled = false` in `config/cards.lua`. See [Bank cards](/resources/awoken-banking/configuration/cards).
  </Step>

  <Step title="Grant the admin permission">
    Lets your staff use the setup and management commands. In `server.cfg`:

    ```cfg server.cfg theme={"dark"}
    add_ace group.admin command.awoken_banking allow
    ```
  </Step>

  <Step title="Set the ensure order">
    ```cfg server.cfg theme={"dark"}
    ensure ox_lib
    ensure oxmysql
    ensure qbx_core            # your framework: qbx_core / qb-core / es_extended
    ensure ox_inventory        # your inventory (optional)
    ensure ox_target           # optional
    ensure awoken_banking
    ```
  </Step>

  <Step title="Start the server">
    On first launch the database tables build themselves - **there is no SQL file to import**. Watch the console for a clean start with no oxmysql errors. A set of default bank tellers is placed on the map automatically; move or add your own later. See [Bank locations](/resources/awoken-banking/bank-locations).
  </Step>
</Steps>

## Point it at your framework

Open `config/core.lua`. Auto-detection handles most setups; override by hand if it guesses wrong:

```lua config/core.lua theme={"dark"}
Config.Framework   = 'auto'         -- 'esx' | 'qbcore' | 'qbx' | 'auto'
Config.Inventory   = 'ox_inventory' -- 'ox_inventory' | 'qb-inventory' | 'ps-inventory' | 'none'
Config.Interaction = 'ox_target'    -- 'ox_target' | 'drawtext'
```

Set `Config.Inventory = 'none'` if you don't use physical cards, and `Config.Interaction = 'drawtext'` for a simple **\[E]** prompt instead of ox\_target.

## What's inside

| Path                           | What it is                                                                | Edit it?   |
| ------------------------------ | ------------------------------------------------------------------------- | ---------- |
| `config/`                      | Every setting - money limits, cards, ATMs, loans, savings, tax, and more. | **Yes**    |
| `config/locales/`              | Every word players see, one file per language.                            | **Yes**    |
| `install/`                     | The bank-card item snippets for each inventory.                           | Copy-paste |
| `server/` · `client/` · `web/` | The banking logic and the app itself.                                     | No         |

Everything in `config/` (including `config/locales/`) is left open by asset escrow - those are the files you're meant to touch. Everything else is protected. See [FiveM asset escrow](/fivem-asset-escrow).

## Moving from another bank

Awoken Banking can do a **one-time import** of existing balances and history from Renewed-Banking, qb-banking, ESX, DM Banking, Bablo, Snipe, and Nano Banking. Run it automatically on first start (`Config.AutoImport`) or manually from the console with a dry-run preview. See [Moving from another bank](/resources/awoken-banking/configuration/accounts#moving-from-another-bank).

## Updating

Re-download the asset from your Cfx.re portal, replace the folder, and restart with `ensure awoken_banking`.

<Warning>
  Replacing the folder overwrites everything in `config/`. If you've tuned your settings, back the `config/` folder up first, then re-apply your changes.
</Warning>

## First check

Once you're in-game, walk up to a bank teller or an ATM and open the app. If it shows your balance, you're live. From here:

<CardGroup cols={2}>
  <Card title="Set your options" icon="sliders" href="/resources/awoken-banking/configuration/overview">
    Money limits, currency, language, and which features are on.
  </Card>

  <Card title="Place your banks" icon="location-dot" href="/resources/awoken-banking/bank-locations">
    Move the default tellers or add your own with the in-game creator.
  </Card>
</CardGroup>