Documentation › Mushrooms › Integrations › Framework & Inventory Bridge

Framework & Inventory Bridge

How framework, inventory and target are detected and how to add your own.

The files in bridge/ stay open after escrow:

File What it does
bridge/shared/core.lua Framework detection
bridge/server/framework.lua Player, identifier, name, money, admin check, notifications
bridge/server/inventory.lua Add, remove, count items and quality metadata
bridge/client/inventory.lua Client inventory reads
bridge/client/target.lua ox_target, qb-target, interact
bridge/client/progress.lua ox_lib, QBCore or progressbar

Detection

With Config.AutoDetectFramework, Config.AutoDetectInventory and Config.AutoDetectTarget set to true the bridge checks which resources are started. Turn detection off and set Config.Framework, Config.Inventory or Config.Target if you want to force one.

Inventory detection order: ox → qs → qb → ps → codem → tgiann → jpr → ak47 → origen → ESX native.

Quality support

Inventory 1★–3★ quality
ox_inventory, qb-inventory, qs-inventory Yes (metadata)
Every other inventory No – every mushroom counts as 1★

Custom inventory

Set Config.Inventory = 'custom' and Config.AutoDetectInventory = false, then fill in _buildCustom() at the bottom of bridge/server/inventory.lua:

lua
local function _buildCustom()
    return {
        CanCarry   = function(src, item, count) return true, nil end,
        AddItem    = function(src, item, count) return false end,
        RemoveItem = function(src, item, count) return false end,
        Count      = function(src, item) return 0 end,
    }
end