Configuration — ns-banking 1.0.0

Routine changes never need core code: config.lua (rules), data/branches.lua (locations), data/markets.lua (simulated assets and events), locales/*.lua (texts). All four stay readable under Cfx escrow. Every value is validated on start; invalid values are reported and critical ones disable the feature they belong to.

Units: money = whole currency units · percent = percent (0.25 = 0.25 %) · time = seconds unless named days.

General

IBAN and privacy

Changing the IBAN format later only affects new accounts; existing IBANs stay valid only if prefix and length are unchanged.

Limits and fees

Limits.maxAmount (10 000 000) caps every single amount. deposit, withdraw, transfer each have { min, max, daily }; daily = rolling 24 h from the account's own history. transfer.cooldownSeconds (5).

Fees.deposit / withdraw / atmWithdraw / transfer = { fixed, percent, min, max } → fee = fixed + ceil(amount × percent / 100), clamped to [min, max] (max = 0 = no cap). Withdrawal and transfer fees are charged on top of the amount; deposit fees are taken from the deposited cash. Fees.collector = 'jobname' credits every fee to that business account (must exist in BusinessAccounts.jobs), nil = fees leave the economy.

Transfers.allowSelf (false) · noteMaxLength (64) · blockedIbans (list).

ATMs

ATMs always serve the personal account only.

Card PIN (Atm.pin): enabled (true), length (4, 4–6), maxAttempts (3), lockMinutes (30), blockTrivial (refuses 0000 / 1234 / 4321 …). The PIN is chosen on the first ATM use and reset at any branch (Settings → Card PIN).

ATM intro (Atm.visual): enabled, image (img/atm-machine.png), card (img/bank-card.png), hotspots in percent of the image — screen, slot, keypad = { x, y, w, h, cols, rows, keys }, optional led (blinks over the image's LED; without it the LED is drawn above the slot) — keyLabels (NUI writes the key labels for images with blank keys), debug (draws the hotspots). See ASSETS.md for sizes, AI prompts and calibration.

Branches (Config.Branch, data/branches.lua)

Config.Branch: sessionTolerance (3 m), icon, tellerModel, guardModel, pedSpawnDistance (60 m).

data/branches.lua entry: id, label, enabled, coords (vector3), radius, services (nil = all; or { crypto = false, ... } with keys withdraw, deposit, transfer, history, savings, deposits, crypto, stocks, shared, business), limits (withdrawMax, withdrawDaily, depositMax, transferMax), jobs (restrict to jobs), blip ({ sprite, color, scale } or false), teller ({ coords = vector4, model? }), guards (list). NPCs are local and exist only near the branch. Branches can be toggled live: /bank branch <id> on|off.

Savings

Formula: for every ended interval, interest = min(floor(min(lowest balance during the interval, maxEligibleBalance) × rate / 100), maxPayoutPerInterval), 0 when the lowest balance is below minBalance. Money deposited during an interval earns from the next one. Changing interval restarts all cursors at the current period.

Fixed-term deposits

minAmount 1 000 · maxAmount 500 000 · maxActive 3 · allowEarlyWithdrawal true · earlyPenaltyPercent 2.0 · plans = { { id, days, ratePercent } } (ratePercent is for the whole term, fixed when the deposit is opened; days may be fractional for testing). Payout at maturity = principal + floor(principal × rate / 100); early = principal − ceil(principal × penalty / 100), interest forfeited.

Markets (Config.Markets, data/markets.lua)

Config.Markets: tickSeconds 300 · historyRetentionDays 14 · chartPoints 96 · maxSlippagePercent 1.5 · announceEvents true.

data/markets.lua → Markets.crypto / Markets.stocks: label, fee ({ fixed, percent, min, max }), alwaysOpen, hours = { open, close, days } (server clock, days 1 = Sunday … 7 = Saturday), assets:

MarketEvents = { { id, market, scope = 'asset' \| 'market', chancePerTick, driftPercent, durationTicks } }; label key event_<id> in the locales. Trigger manually: /bank market event <id> [SYM]. Pause: /bank market pause ….

Shared and business accounts

SharedAccounts: maxOwned 2 · maxMembers 6 · openingFee 500 · labelMaxLength 32. Members are added by their personal IBAN with deposit / withdraw / transfer / manage; only the owner can grant manage.

BusinessAccounts.jobs = { jobname = { label, grades = { view, deposit, withdraw, transfer, manage } } } — minimum job grade per permission; the account is created on first use.

Other

Runtime toggles that do not need a restart (persisted in ns_banking_meta): branch on/off, maintenance mode, market / asset pause. Everything else in config.lua is read on start: restart the resource after editing.