Configuration
Every lation banking option with its default and limits, edited in game under /bankadmin > Config, since the resource has no config file.
lation banking has no config file. Every option lives in the database (the lation_banking_config table) and is edited in game under /bankadmin > Config, where a change applies to the server and every player the moment it saves, with no restart. The panel itself is covered on the admin page.
On the very first start, each section is seeded from shared/defaults.lua (and the Logging section from server/utils/logging.lua). After that, editing those files changes nothing on your server.
Numbers outside an option's limits are held to the nearest limit, and text longer than its limit is cut. The key column is the option's path inside its section, as GetConfig returns it.
General
| Option | Key | Default | Notes |
|---|---|---|---|
| Interaction system | interact | auto | auto picks lation_interact, ox_target or qb-target, in that order. Also each by name, or custom for your own in client/utils/interact.lua. |
| Notification system | notify | auto | auto uses lation ui while it runs and ox_lib otherwise. Also lation_ui, ox_lib, esx, qb, okok, wasabi_notify, or custom in client/utils/notify.lua. |
/bank command | commands.bank | Off | Opens the full bank from anywhere |
/givecash command | commands.givecash | On | Hands cash to a player standing nearby |
/bill command | commands.bill | On | Opens the bill card anywhere |
/pos command | commands.pos | On | Opens the register, for staff of a business with one |
| Nearby range (m) | nearby | 10 | 2 to 50. How far the nearby-player pickers, /givecash and a register's customer reach |
| Branch prompt icon | icons.bank | building-columns | A FontAwesome solid icon name, up to 40 characters. Also the notifications' icon. |
| ATM prompt icon | icons.atm | credit-card | |
| Register prompt icon | icons.pos | cash-register | |
| Check for updates | version | On | restart. A line in the server console when a newer version is out |
| Debug messages | debug | Off | Extra server console output. It costs resmon, so keep it off on a live server. |
Currency
| Option | Key | Default | Notes |
|---|---|---|---|
| Symbol | symbol | $ | Up to 4 characters, shown with every amount |
| Symbol after the amount | suffix | Off | 1.000 € instead of $1,000, with a space before the symbol, in the bank and in its notifications |
| Number locale | locale | en-US | Digit grouping and dates, such as en-US or de-DE. Up to 12 characters. |
Quick amounts
The amount buttons under the bank's amount fields, so they fit your economy. Each list holds up to 8 amounts, 1 to 1,000,000,000 each; leave a list empty for no buttons. The ATM keeps its own list, under ATMs.
| Option | Key | Default | Notes |
|---|---|---|---|
| Deposit and withdraw | cash | 100, 500, 1000, 5000 | When cash goes in or comes out at a branch |
| Send money | transfer | 100, 500, 1000, 5000, 10000 | On the Transfer page, when sending or requesting |
| Bills and requests | bill | 100, 250, 500, 1000, 5000 | When a bill or request is written, on the Bills page and the /bill card |
Branches
The places players walk up to for the full bank. Each branch has a label (up to 40 characters), a position with heading, and a ped model. Leave the ped model empty for a plain interaction point instead. Add a branch adds one, Use my position fills in where you stand and Go there teleports you to check it. Up to 50 branches.
| Label | Position | Ped |
|---|---|---|
| Pacific Standard | 241.44, 227.19, 106.29, 170.43 | u_m_m_bankman |
| Fleeca Bank | 313.84, -280.58, 54.16, 338.31 | ig_barry |
| Fleeca Bank | 149.46, -1042.09, 29.37, 335.43 | ig_barry |
| Fleeca Bank | -351.23, -51.28, 49.04, 341.73 | ig_barry |
| Fleeca Bank | -1211.9, -331.9, 37.78, 20.07 | ig_barry |
| Fleeca Bank | -2961.14, 483.09, 15.7, 83.84 | ig_barry |
| Fleeca Bank | 1174.8, 2708.2, 38.09, 178.52 | ig_barry |
| Blaine County Savings | -112.22, 6471.01, 31.63, 134.18 | u_m_m_bankman |
A branch's ped appears when a player comes within 60 metres. With no branches, players can only use ATMs (and /bank, while it is on).
Map blip
| Option | Key | Default | Notes |
|---|---|---|---|
| Show branches on the map | enabled | On | One blip per branch |
| Sprite | sprite | 108 | 1 to 900. The blip icon id; 108 is the bank |
| Color | color | 2 | A blip color id, 0 to 85 |
| Scale | scale | 0.8 | 0.1 to 3 |
| Label | label | Bank | Up to 30 characters, the name on the map legend |
ATMs
| Option | Key | Default | Notes |
|---|---|---|---|
| ATM models | models | prop_atm_01, prop_atm_02, prop_atm_03, prop_fleeca_atm | Every object with one of these models is an ATM. Up to 12. |
| Withdrawals at ATMs | withdraw | On | Take cash out at any ATM |
| Deposits at ATMs | deposit | Off | Off means cash only goes in at a branch |
| Quick amounts | amounts | 100, 500, 1000, 2000, 5000 | The preset buttons on the ATM keypad, 1 to 1,000,000 each. Up to 8; empty for none. The bank's own are under Quick amounts. |
| Play the ATM animation | animation | On | The player stands at the machine while the screen is open |
| Ask for a PIN | pin | Off | ATMs open on a keypad. A player without a PIN is sent to a branch to set one. Also what RequestPin checks. |
| Other accounts | otherAccounts | Off | An account number and its PIN open that account at any ATM, withdraw only |
Lists such as the models and the amounts are typed comma separated, and save when you leave the field. An entry that isn't a number is dropped from a list of amounts.
Accounts
| Option | Key | Default | Notes |
|---|---|---|---|
| Society accounts | society.enabled | On | One account per job, used by its bosses. Turning it on opens what is missing at once. Off, no new ones are opened, for lation jobs either. |
| Gang accounts too | society.gangs | On | One account per gang as well (Qbox and QBCore) |
| Shared accounts | shared.enabled | On | Players open accounts and share them with members |
| Shared accounts per player | shared.maxPerPlayer | 3 | 0 to 50. How many one player may own; 0 for no limit |
| Owners can close shared accounts | shared.allowDelete | On | The balance goes back to the owner |
| Account number prefix | number.prefix | LS | Up to 4 letters in front of the digits; may be empty |
| Account number digits | number.digits | 8 | 4 to 16. Applies to accounts opened from now on |
Transfers
| Option | Key | Default | Notes |
|---|---|---|---|
| Transfers to offline players | offline | On | The money is credited to their character right away |
| Minimum transfer | min | 1 | The smallest amount a player can send; 0 for no minimum |
| Maximum transfer | max | 0 | Per transfer; 0 for no limit. Also caps a single bill, request or sale |
| Saved contacts per player | maxContacts | 20 | 0 to 100 |
These hold for players in the bank. Exports skip them.
Transactions
| Option | Key | Default | Notes |
|---|---|---|---|
| Track other scripts' bank moves | trackFramework | On | Paychecks, purchases and fines from other scripts land in the player's history with the reason that script gave |
| Keep transactions for (days) | retentionDays | 0 | 0 to 3650. Older rows are removed on start and once a day after; 0 keeps them forever |
Bills
| Option | Key | Default | Notes |
|---|---|---|---|
| Bills | enabled | On | Bills sent from a society account are paid into it. Off, bills are off everywhere: nothing billed shows, is paid, declined or collected until it is back on, and the register and ongoing payments go too. See switching bills off. |
| Every employee can bill | employees | On | Everyone in a job sends bills from its society account, not only the bosses |
| Days until due | dueDays | 7 | 1 to 90. A bill shows as overdue after this |
| Collect overdue bills automatically | autoPay | Off | From the personal account, while the player is online and can cover it. Never a bill sent to an account. |
| Players can decline bills | allowDecline | Off | Requests, register sales and bills sent to an account can always be declined |
| Pay bills from /bill | payAnywhere | Off | The /bill card also lists what the player owes, so a fine or a sale sent as a bill can be paid on the spot |
| Businesses that bill | societies | None | Only these societies can send bills, to players and to other businesses. Each has an employee cut (0 to 50%) and up to 24 preset reasons with an amount. Up to 100 societies. |
See Bills and requests.
Requests
| Option | Key | Default | Notes |
|---|---|---|---|
| Requests | enabled | On | Players ask other players for money. Off, nothing requested shows or can be paid until it is back on. |
| Requests expire after (days) | expiryDays | 3 | 1 to 30. A request nobody answered expires after this |
POS
| Option | Key | Default | Notes |
|---|---|---|---|
| POS | enabled | On | Businesses ring up sales at a register. Needs Bills on. |
| Every employee can ring sales | employees | On | Off means only the bosses of a business work its register |
| Off-menu lines | customLines | On | The cashier can add a line that is not on the menu: labour, a service, a custom amount |
| Cash payments | cash | On | The customer can pay a sale in cash as well as from an account |
| POS item | item | Empty | A usable inventory item that opens the register; empty for none |
| Registers | locations | None | Register points, each for one business or any. Up to 50, counting the ones another resource places with SetPosLocation |
| Product pictures | images | auto | auto uses the inventory that is running, or a nui:// path to an images folder |
| Sales tax (%) | tax.rate | 0 | 0 to 100. Added on top of every sale unless a business sets its own |
| Tax paid into | tax.account | None | The society the tax goes to unless a business names its own. None, and the tax leaves the economy |
| Businesses | businesses | None | The societies with a register, each with its own tax rate, tax account, menu, and whether its bosses may edit the menu. Up to 100. Another resource can list one with SetPosBusiness; what you set here stays. |
The menus themselves are kept in the lation_banking_pos_products table, not in this section. See Register.
Savings
| Option | Key | Default | Notes |
|---|---|---|---|
| Savings accounts | enabled | On | Every player can open one |
| Interest per day (%) | rate | 0.5 | 0 to 100, to two decimals. Paid for every full day the balance is held |
| Interest stops at | maxBalance | 0 | Interest never takes the balance above this; 0 for no cap |
Loans
| Option | Key | Default | Notes |
|---|---|---|---|
| Loans | enabled | On | Players can borrow from the bank |
| Smallest loan | min | 5000 | The least a player can borrow |
| Largest loan | max | 250000 | The most a player can borrow |
| Interest (%) | interest | 10 | 0 to 100. Flat, on the amount borrowed |
| Terms offered (days) | terms | 7, 14, 30 | The repayment lengths a player can pick, 1 to 365 days each. Up to 6 |
| Missed installments before default | missedLimit | 3 | 1 to 30. A defaulted loan blocks new ones until it is paid off |
See Loans.
Logging
Never sent to players, and not returned by GetConfig.
| Option | Key | Default | Notes |
|---|---|---|---|
| Service | service | none | none, fivemanage or discord |
| Attach screenshots | screenshots | Off | Fivemanage only |
| Webhook name | discord.name | Banking | The name Discord messages are posted under |
| Webhook link | discord.link | Empty | The Discord webhook URL. Hidden in the panel until you press the eye icon |
| Avatar image | discord.image | https://i.imgur.com/ILTkWBh.png | The picture next to the webhook name |
| Footer image | discord.footer | https://i.imgur.com/ILTkWBh.png | The small picture in the embed footer |
Fivemanage logging needs the fmsdk resource started before lation_banking.
Each event can be switched on its own. All are on by default.
| Event | Key | What is logged |
|---|---|---|
| Deposits | events.deposit | Cash put into an account |
| Withdrawals | events.withdraw | Cash taken out |
| Transfers | events.transfer | Money sent between accounts from the bank |
| Accounts opened | events.accountCreated | Shared accounts opened by players |
| Accounts closed | events.accountDeleted | Shared accounts closed by their owner |
| Access changes | events.memberChanged | Members added to or removed from an account |
| Bills | events.bill | Bills sent, paid, declined or cancelled |
| Sales | events.pos | Sales rung up and paid, and menus changed |
| Requests | events.request | Requests sent, paid or declined |
| Loans | events.loan | Loans taken, paid off or defaulted |
| Savings | events.savings | Savings accounts opened or closed |
| Admin actions | events.admin | Everything done from the admin panel |
| PINs | events.pin | PINs set or removed, lockouts, and another account opened at an ATM |
Open files
These ship unescrowed, so you can change them:
| File | What it is |
|---|---|
bridge/server.lua, bridge/client.lua | The framework calls: players, money, jobs, gangs, HasSocietyAccess, usable items |
client/utils/interact.lua | The interaction systems, with a custom slot |
client/utils/notify.lua | Notifications, with a custom slot |
client/utils/peds.lua | How branch peds are spawned |
server/utils/perms.lua | Who is an admin |
server/utils/hooks.lua | Server hooks; see hooks |
server/utils/logging.lua | Logging and its first-start defaults |
server/database/schema.sql, queries.lua, migrations.lua | The tables, every query and the schema updates |
locales/*.json | Every string |
Still stuck? Ask in our Discord: the people who write the scripts answer.
Last updated