> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aps-store.com/llms.txt
> Use this file to discover all available pages before exploring further.

# config.compat.lua

> Framework, inventory, notification and society settings of aps_banking, plus the switches for the drop-in export answers of other banking scripts.

`config/config.compat.lua` holds these settings. Every option is explained in the comments below, and the [Compability](https://docs.aps-store.com/assets/aps_banking/compability.md) page lists what each one supports.

> [!NOTE]
>
> Runs on: **shared**. This file stays editable when the resource is escrow-protected. Restart the resource after a change.

```lua theme={null}
Config = Config or {}

-- ─────────────────────────────────────────────
--  Framework
--    'auto'   first one started: qbx_core → qb-core → es_extended
--    'esx' | 'qbcore' | 'qbox' | 'custom'
--    'custom' fills in bridge/sv_custom.lua and bridge/cl_custom.lua
-- ─────────────────────────────────────────────
Config.Framework = 'auto'

-- ─────────────────────────────────────────────
--  Inventory — card and receipt items
--    'auto'  first one started of the list below, otherwise 'framework'
--    'ox_inventory' | 'qb-inventory' | 'ps-inventory' | 'qs-inventory'
--    | 'codem-inventory' | 'jaksam_inventory' | 'tgiann-inventory' | 'framework'
--  ('framework' = xPlayer / Player.Functions item functions. Default ESX has
--   no item metadata, so a card item there stands for "any of my cards".)
-- ─────────────────────────────────────────────
Config.Inventory = 'auto'

-- ─────────────────────────────────────────────
--  Notifications
--    'auto'  vms_notifyV2 → okokNotify → ox_lib on Qbox → framework
--    'esx' | 'qb' | 'ox_lib' | 'okokNotify' | 'vms_notifyV2'
--    'custom' calls Config.NotifyFn from config/config.client.lua
-- ─────────────────────────────────────────────
Config.Notify = 'auto'

-- ─────────────────────────────────────────────
--  Society balances
--    system  'auto'  ESX with esx_addonaccount started → 'esx_addonaccount',
--                    everything else → 'own'
--            'esx_addonaccount'  balance stays in addon_account_data, so
--                                esx_society and other ESX scripts see it
--            'own'               balance lives in aps_bank_accounts
--    prefix  ESX account name prefix ('society_police')
-- ─────────────────────────────────────────────
Config.Society = {
    system = 'auto',
    prefix = 'society_',
}

-- ─────────────────────────────────────────────
--  Drop-in export answers for other banking resources
--    Each group answers calls to exports['<that resource>'] with APS Banking,
--    through the same checks and logging as the rest of the script.
--    A group is skipped while the real resource is running.
-- ─────────────────────────────────────────────
Config.Compat = {
    ['qb-management']   = true,
    ['qb-banking']      = true,
    ['Renewed-Banking'] = true,
    ['okokBanking']     = true,
    -- Unknown job / gang names sent to these exports create the society
    -- account on first use, the same way Renewed-Banking pre-creates them.
    autoCreateSociety   = true,
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.