Configuration overview

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 - 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`	Currency, money limits, fees, cooldowns, account types, and sharing.
`config/atm.lua`	ATM props, locations, and withdrawal caps.
`config/cards.lua`	Physical and virtual bank cards.
`config/loans.lua`	Loans and the credit score.
`config/tiers.lua`	Savings accounts and interest.
`config/tax.lua`	Tax rules.
`config/bills.lua`	Bills and one-off payment requests.
`config/stocks.lua`	The stock market and investing.
`config/scheduled.lua`	Scheduled and recurring payments.
`config/phone.lua`	The Bank app on the player’s phone.
`config/webhooks.lua`	Discord audit logging.
`config/theme.lua`	The app’s colours and look.
`config/locales/`	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.

config/core.lua

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.

config/core.lua

Config.Locale = 'en'

Debug

config/core.lua

Config.Debug = true   -- DEV ONLY

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.

Notifications

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

config/core.lua

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.

config/accounts.lua

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.

Get Started

Awoken Scripts

Configuration overview

Core settings

Language

Debug

Notifications

Currency

Money limits, fees, and cooldowns

​Core settings

​Language

​Debug

​Notifications

​Currency

​Money limits, fees, and cooldowns

Core settings

Language

Debug

Notifications

Currency

Money limits, fees, and cooldowns