Compability

config/config.compat.lua — frameworks, inventories, society accounts, licenses and other scripts.

Supported resources

Area	Supported	Option
Framework	ESX Legacy, QBCore, Qbox	`Config.Framework`
Target	ox_target, qb-target, or proximity prompt	`Config.Interaction.type`
Notifications	vms_notifyV2, okokNotify, ESX, QBCore, ox_lib, or your own function	`Config.Settings.notifyType`, `Config.Notify`
Inventory	ox_inventory, qs-inventory, origen_inventory, tgiann-inventory, core_inventory, framework inventories (qb-inventory, ps-inventory, ESX…)	`Config.Inventory`
Society accounts	esx_addonaccount, qb-banking, qb-management, Renewed-Banking, vms_bossmenu	`Config.Society`
Licenses	esx_license, Buty-license, QBCore / Qbox `metadata.licences`	`Config.LicenseSync`
Vehicles	`owned_vehicles` / `player_vehicles`, custom columns	`Config.DB`, `Config.OwnedVehiclesColumns`
Phones	sd-phone, LB Phone, 17Movement Phone, YSeries, qs-smartphone-pro, GKSPhone, qb-phone, any other phone through `Config.PhoneCustom`	`Config.Phone` (see Phone)
Other scripts	vms_cityhall export names, `esx_billing:sendBill`	`Config.Compat`

Framework

Config.Framework = 'auto'   -- 'auto' | 'esx' | 'qbcore' | 'qbox'

'auto' checks qbx_core, then qb-core, then es_extended. Players are identified by the ESX identifier or the QBCore / Qbox citizenid. Everything framework-specific lives in bridge/, which stays editable when the resource is escrowed.

Inventory

Config.Inventory = 'auto'   -- 'auto' | 'ox_inventory' | 'qs-inventory' | 'origen_inventory'
                            -- | 'tgiann-inventory' | 'core_inventory' | 'framework'

'auto' picks the first one that is started in that order. Usable document items on origen_inventory, tgiann-inventory and core_inventory go through the framework’s usable-item system, as they do for those inventories’ own items. The origen and tgiann bridges try both export spellings those inventories have used (AddItem / addItem…); if your version differs, edit bridge/sv_bridge.lua, which stays editable when escrowed. Used for Config.PaymentItem and document items. Give a document type an item to hand it out when ordered. On ox_inventory it gets holder, expires and description metadata:

-- config/documents.lua
{ id = 'id_card', name = 'ID Card', item = 'id_card', icon = 'CreditCard', options = { … } },

Society accounts

Config.Society = {
    system         = 'auto',  -- 'auto' | 'esx_addonaccount' | 'qb-banking' | 'qb-management'
                              -- | 'Renewed-Banking' | 'vms_bossmenu' | 'none'
    payBills       = true,    -- pay the society's share when a player pays a bill
    defaultPercent = 100,     -- share when the bill has no percentageForSociety
}

The society comes from the bill’s society ('society_police') or job ('police'). 'auto' uses vms_bossmenu when it’s running, otherwise esx_addonaccount (ESX), qb-banking → qb-management (QBCore) or Renewed-Banking → qb-banking (Qbox).

License sync

Licenses earned in the License Center are also granted in the framework, so police, gun shops and other scripts see them.

Config.LicenseSync = {
    system = 'auto',   -- 'auto' | 'esx_license' | 'Buty-license' | 'metadata' | 'none'
    butyCategories = { firearms = 'weapon' },   -- Buty-license category (default 'driving')
    map = {
        esx = { car = 'drive', motorcycle = 'drive_bike', truck = 'drive_truck', boat = 'boat', firearms = 'weapon' },
        qb  = { car = 'driver', motorcycle = 'driver', truck = 'driver', firearms = 'weapon' },
    },
}

Licenses not listed in the map are not synced. 'auto' uses esx_license, or Buty-license when esx_license isn’t running. On ESX the license type must exist in your licenses table. removeLicense (export) removes it again.

Other scripts

Config.Compat = {
    vmsCityhall  = false,
    vmsDocuments = false,
    esxBilling   = { enabled = false, maxAmount = 100000, requireJob = true },
    healthInsurance = 'health_insurance',   -- document type for the health insurance exports
    licenseAliases  = { drive_b = 'car', practical_boat = 'boat', … },   -- other scripts' license names
}

Option	What it does
`vmsCityhall`	Scripts that call `exports['vms_cityhall']` are answered by City Hall. Server: `giveBill`, `getVehicleInsurance`, `addVehicleInsurance`, `getHealthInsurance`, `addHealthInsurance`. Client: `openCityHall`, `getTaxAmount`. Ignored while vms_cityhall is installed. See the table below for the rest.
`vmsDocuments`	Scripts that call `exports['vms_documentsv2']` (`giveDocument`, `isAnyDocumentValid`, `invalidateDocument`, `getMyDocuments`, `GenerateSSN`) are answered by the built-in documents.
`esxBilling`	Handles `TriggerServerEvent('esx_billing:sendBill', target, 'society_x', label, amount)` from esx_policejob, esx_ambulancejob, esx_mechanicjob… and turns it into a City Hall invoice (due in 7 days, paid to the society). Only when `esx_billing` is not started. The issuer must have the society’s job, be within 15 m of the target, and the amount must be ≤ `maxAmount`.

VMS scripts

With vmsCityhall = true City Hall answers these exports['vms_cityhall'] calls:

Export	Used by	Needs
`giveBill`, `getVehicleInsurance`, `addVehicleInsurance`, `getHealthInsurance`, `addHealthInsurance`	MDTs, job scripts	bills, insurance
`getTaxAmount`, `addPlayerTaxToPay`, `addPlayerCustomTaxToPay`, `addCompanyTaxAmount`, `addCompanyCustomTaxAmount`, `addCompanyFlatTaxAmount`, `registerBusinessTaxAccount`, `getJobTaxes`, `TaxBusinessAllowMakeDelayedDeclarations`, `TaxBusinessPercentagePerMonthForDelay`	vms_tuning, vms_vehicleshopV2, vms_stores, vms_tattooshop, vms_barber, vms_gym, your own scripts	taxes
`getCompanyMoney`, `addCompanyMoney`, `removeCompanyMoney`	scripts that use City Hall’s money	taxes (the treasury)
`isLicenseSuspended`, `suspenseLicense`, `reinstateLicense`	vms_driveschoolV2, vms_boatschoolV2, vms_flightschoolV2 (`Config.UseVMSCityHall`), MDTs	always
`getPenaltyPoints`, `addPenaltyPoints`, `removePenaltyPoints`, `resetPenaltyPoints`	MDTs	penaltyPoints
`GenerateVIN`, `GenerateSSN`	vms_garagesV2, vms_vehicleshopV2, esx_identity / multicharacter edits	vin, documents
`updatePaychecks`	framework paycheck edit, vms_bossmenu	paychecks
`setResumeAllowed`, `getJobResumes`	vms_bossmenu	jobCenter

Some vms scripts only call City Hall when GetResourceState('vms_cityhall') == 'started' (vms_garagesV2 and vms_vehicleshopV2 for VINs). That check can’t see City Hall under another name. For those, set the script’s own City Hall option, or call exports['aps_cityhall'] in its open config instead.

Other VMS resources work alongside City Hall: vms_bossmenu (society money, badge numbers, tax and application permissions, announcements), vms_notifyV2 (notifications), vms_housing (property tax), and the business scripts’ company accounts (business taxes).

Home

Helpful

Assets

Supported resources

Framework

Inventory

Society accounts

License sync

Other scripts

VMS scripts

​Supported resources

​Framework

​Inventory

​Society accounts

​License sync

​Other scripts

​VMS scripts

Supported resources

Framework

Inventory

Society accounts

License sync

Other scripts

VMS scripts