> ## 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.

# Configuration overview

> How the config folder is laid out, plus the core, currency, and money settings you'll touch first.

Every setting lives in the `config/` folder, one file per topic. These files are yours to edit; the server and client code is protected. Start with `config/core.lua` (this page) and [`config/accounts.lua`](/resources/awoken-banking/configuration/accounts) - the rest you can tune feature-by-feature later.

| File                                                                        | What it controls                                                       |
| --------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `config/core.lua`                                                           | Framework, inventory, interaction, language, debug, and notifications. |
| [`config/accounts.lua`](/resources/awoken-banking/configuration/accounts)   | Currency, money limits, fees, cooldowns, account types, and sharing.   |
| [`config/atm.lua`](/resources/awoken-banking/configuration/atms)            | ATM props, locations, and withdrawal caps.                             |
| [`config/cards.lua`](/resources/awoken-banking/configuration/cards)         | Physical and virtual bank cards.                                       |
| [`config/loans.lua`](/resources/awoken-banking/configuration/loans)         | Loans and the credit score.                                            |
| [`config/tiers.lua`](/resources/awoken-banking/configuration/savings)       | Savings accounts and interest.                                         |
| [`config/tax.lua`](/resources/awoken-banking/configuration/tax)             | Tax rules.                                                             |
| [`config/bills.lua`](/resources/awoken-banking/configuration/billing)       | Bills and one-off payment requests.                                    |
| [`config/stocks.lua`](/resources/awoken-banking/configuration/investing)    | The stock market and investing.                                        |
| [`config/scheduled.lua`](/resources/awoken-banking/configuration/scheduled) | Scheduled and recurring payments.                                      |
| [`config/phone.lua`](/resources/awoken-banking/configuration/phone)         | The Bank app on the player's phone.                                    |
| [`config/webhooks.lua`](/resources/awoken-banking/configuration/webhooks)   | Discord audit logging.                                                 |
| [`config/theme.lua`](/resources/awoken-banking/configuration/theming)       | The app's colours and look.                                            |
| [`config/locales/`](/resources/awoken-banking/configuration/language)       | Every word players see, one file per language.                         |

## Core settings

Open `config/core.lua`. Each of these defaults to auto-detection, so you only set them by hand if the guess is ever 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'
```

* `Config.Framework` picks the first compatible framework that's running. Override only if it chooses wrong.
* `Config.Inventory` is only for physical bank-card items. Set it to `'none'` if you don't use them.
* `Config.Interaction` chooses how players reach tellers and ATMs: `ox_target`, or a simple **\[E]** prompt (`drawtext`).

### Language

Awoken Banking ships in 11 languages. Set `Config.Locale` to the code you want, or add your own - see [Language](/resources/awoken-banking/configuration/language).

```lua config/core.lua theme={"dark"}
Config.Locale = 'en'
```

### Debug

```lua config/core.lua theme={"dark"}
Config.Debug = true   -- DEV ONLY
```

<Warning>
  **Set `Config.Debug = false` on any live server.** When it's on, `/bank` opens the bank from anywhere and clients can skip the server's proximity check, so any player could open the bank remotely. It also floods your console with logging.
</Warning>

### Notifications

Where on-screen messages appear and how long they stay.

```lua config/core.lua theme={"dark"}
Config.Notifications = {
    position = 'top',   -- ox_lib position: top, top-right, bottom, etc.
    duration = 4000,    -- ms
}
```

## Currency

Set in `config/accounts.lua`. `Config.Currency` is the ISO code sent to the app for number formatting; `Config.CurrencySymbol` is the sign shown next to amounts.

```lua config/accounts.lua theme={"dark"}
Config.Currency       = 'USD'   -- ISO code, shipped to the UI for formatting
Config.CurrencySymbol = '$'
```

## Money limits, fees, and cooldowns

Also in `config/accounts.lua`, `Config.Money` sets the caps, fees, cooldowns, and quick-amount buttons. Every cap here is enforced by the server.

| Option               | What it does                                                                     | Default                    |
| -------------------- | -------------------------------------------------------------------------------- | -------------------------- |
| `maxTransfer`        | Largest amount allowed in a single transfer.                                     | `1000000`                  |
| `maxDeposit`         | Largest amount allowed in a single deposit.                                      | `5000000`                  |
| `maxWithdraw`        | Largest amount allowed in a single withdraw (ATM caps live in `config/atm.lua`). | `5000000`                  |
| `transferFeePercent` | Percentage fee on a transfer, `0` to `1` (`0` = free).                           | `0.0`                      |
| `transferFeeFlat`    | Flat fee added on top of the percentage fee.                                     | `0`                        |
| `transferCooldownMs` | Wait between transfers per player, in milliseconds (`0` = none).                 | `0`                        |
| `withdrawCooldownMs` | Wait between withdrawals per player, in milliseconds (`0` = none).               | `0`                        |
| `quickAmounts`       | The quick-amount chips shown in the app.                                         | `{ 100, 500, 1000, 5000 }` |

`config/accounts.lua` also covers account types, readable account numbers, society and shared-account access, and account slots - see [Accounts](/resources/awoken-banking/configuration/accounts).