Installation

Requirements

Dependency	Required	Notes
`ox_lib`	yes	Callbacks, notifications, command registration, textUI, points.
Inventory	one of	`ox_inventory` (preferred), `qb-inventory`, or ESX’s legacy inventory.
Framework	one of	`qbx_core`, `qb-core`, `es_extended`, or `ND_Core`.
`ox_target`	optional	Needed for the EMS player target option, and for the medic NPC when `Config.Interaction = 'target'`.

Steps

Drop the nexdev_crutchsystem/ folder into your resources/ tree, e.g.:
resources/[assets]/nexdev_crutchsystem

Add it to your server.cfg after ox_lib and your inventory:

ensure ox_lib
ensure ox_inventory   # if you use it
ensure ox_target      # if you want the target option
ensure nexdev_crutchsystem

Register the crutch item in your inventory — see Inventory item below.
Copy the bundled icon into your inventory’s image folder:
- ox_inventory/web/images/crutch.png
- qb-inventory/html/images/crutch.png
The source PNG ships at install/crutch.png inside the resource.
Restart the server.

The UI ships ready to use — there is no build step and nothing to compile.

Inventory item

Pick the snippet that matches your inventory. The full reference lives in install/items.lua inside the resource.

ox_inventory

Add this entry to ox_inventory/data/items.lua:

['crutch'] = {
    label       = 'Crutch',
    weight      = 1500,
    stack       = false,
    close       = true,
    description = 'A medical crutch. Use to toggle limping on or off.',
    client = {
        image = 'crutch.png',
    },
    server = {
        export = 'nexdev_crutchsystem.useCrutch',
    },
},

The server.export points at the existing useCrutch handler in nexdev_crutchsystem/server/crutches.lua, which already handles the per-player use counter, breaking, and the equip / unequip toggle.

QBCore / Qbox

Add to qb-core/shared/items.lua (or qbx_core/shared/items.lua):

crutch = {
    name        = 'crutch',
    label       = 'Crutch',
    weight      = 1500,
    type        = 'item',
    image       = 'crutch.png',
    unique      = false,
    useable     = true,
    shouldClose = true,
    description = 'A medical crutch. Use to toggle limping on or off.',
},

Then register the use callback in any server script:

QBCore.Functions.CreateUseableItem('crutch', function(source, item)
    exports['nexdev_crutchsystem']:useCrutch(source, item, item.slot, nil)
end)

ESX legacy

ESX.RegisterUsableItem('crutch', function(source)
    local xPlayer = ESX.GetPlayerFromId(source)
    local item    = xPlayer.getInventoryItem('crutch')
    exports['nexdev_crutchsystem']:useCrutch(source, item, item and item.slot, nil)
end)

Checking it worked

From your server console:

state nexdev_crutchsystem

Should print started. From F8 in-game:

lua print(GetResourceState('nexdev_crutchsystem'))

Stand near a configured MedicLocations entry — the NPC should spawn within Config.SpawnDistance and the blip should be on the map.

Updating

config.lua and the bridge/*.lua files are listed under escrow_ignore, so your settings and any custom framework / inventory adapters survive updates.

Replace the resource files with the new version (keep your edited config.lua and any bridge tweaks).
Restart the resource:
restart nexdev_crutchsystem

Get Started

Scripts

Changelog

Requirements

Steps

Inventory item

ox_inventory

QBCore / Qbox

ESX legacy

Checking it worked

Updating

​Requirements

​Steps

​Inventory item

​ox_inventory

​QBCore / Qbox

​ESX legacy

​Checking it worked

​Updating

Requirements

Steps

Inventory item

ox_inventory

QBCore / Qbox

ESX legacy

Checking it worked

Updating