Configuration

Defaults below are copied from the shipped config.lua for version 1.0.0. Settings are described using the Configuration conventions.

⚙️ Framework

mode is standalone, orion or custom. Everything framework-specific goes through server/adapter.lua and client/adapter.lua.


Config.Framework = {
    mode = 'orion',
    resource = 'orion-core',
    cashAccount = 'cash',
    exports = {
        getIdentifier = 'GetIdentifier',
        getName       = 'GetPlayerName',
        getNameField  = 'name',
        getCash       = 'GetBalance',
        addCash       = 'AddMoney',
        removeCash    = 'RemoveMoney',
        notify        = 'Notify',
        isAdmin       = nil
    },
    standaloneStartingCash = 5000
}

Option	Default	What it does
mode	‘orion’	standalone, orion or custom.
resource	‘orion-core’	Resource that provides the exports.
cashAccount	‘cash’	Account name passed to getCash, addCash and removeCash.
exports.*	see code	Export names on that resource. Signatures are listed on the Exports and Events page.
standaloneStartingCash	5000	Dev only wallet for standalone mode.

⚙️ Branding, currency and interaction


Config.Branding = { name = 'NOMAD BANK', tagline = 'Your Money. Your Way.', badge = 'Premium', subtitle = 'LOS SANTOS', logo = '' }
Config.Currency = '$'
Config.Interaction = 'target'   -- 'target' or 'drawtext'
Config.Target = { distance = 2.0 }
Config.DrawText = { key = 38, label = 'E', distance = 2.0 }

Option	Default	What it does
Config.Branding.logo	”	Optional file inside html/, for example logo.png.
Config.Interaction	‘target’	Uses the framework target bridge and falls back to a key press when none is found.
Config.DrawText.key	38	Control id for the key press fallback (E).

⚙️ Limits, PIN and savings


Config.Limits = {
    maxTransaction = 1000000,
    maxAccountsPerPlayer = 5,
    maxMembersPerAccount = 8,
    maxCardsPerAccount = 3,
    atmPerTransaction = 5000,
    atmDailyDefault = 10000,
    atmDailyMax = 50000
}
 
Config.Pin = { maxAttempts = 3, lockSeconds = 300 }
Config.Savings = { enabled = true, intervalMinutes = 60, ratePercent = 0.1, maxPerPayout = 5000 }
Config.Statement = { pageSize = 25 }
Config.Invoices = { expireDays = 14 }
Config.Session = { maxDistance = 8.0, timeoutSeconds = 900 }

Option	Default	What it does
Limits.maxTransaction	1000000	Single deposit, withdraw or transfer.
Limits.atmPerTransaction	5000	Largest single ATM transaction.
Limits.atmDailyDefault / atmDailyMax	10000 / 50000	Default and highest daily card limit a player can set.
Pin.maxAttempts / lockSeconds	3 / 300	Wrong PIN attempts before the card locks, and for how long.
Savings.ratePercent	0.1	Percent paid per interval.
Session.maxDistance	8.0	How far a player may walk away from the bank or ATM.

⚙️ Creator and seeded locations


Config.Creator = {
    enabled = true,
    command = 'bankcreator',
    ace = 'nomad.banking.admin',
    defaultPed = 'a_m_m_business_01',
    maxLocations = 128
}
 
Config.SeedLocations = {
    -- { kind = 'bank', label = 'Legion Square Bank', x = 149.4, y = -1040.5, z = 29.4, heading = 340.0, ped = 'a_m_m_business_01' },
    -- { kind = 'atm',  label = 'Legion Square ATM',  x = 147.6, y = -1035.8, z = 29.3, heading = 160.0 },
}

Option	Default	What it does
Creator.ace	‘nomad.banking.admin’	ACE permission required for the creator.
SeedLocations	empty	Inserted once, only when the locations table is empty.