Framework support

As mentioned previously we have full support for QBCore, ESX and vRP and have tested all three frameworks to ensure they work perfectly.

Don't forget the resource is still standalone, it just works best on these three frameworks.

This part of the config is only relevant if you want to set the defib up as an item to be used as part of your EMS/Ambulance job for example, or to give to police officers as part of their loadout, to revive players when on duty.

Setting up

To begin, open the config.lua file and navigate to the framework = { section.

framework = {
    itemEnabled = true,
    standalone = true,
    QBCore = {
        enabled = false,
        itemName = 'defib',
        groupCheck = {
            enabled = false,
            groupsToCheck = {"ambulance", "police"}
        },
    },
    vRP = {
        enabled = false,
        itemName = "defib",
        groupCheck = {
            enabled = false,
            groupsToCheck = {"EMS", "FireFighter"}
        },
    },
    ESX = {
        enabled = false,
        itemName = "defib",
        groupCheck = {
            enabled = false,
            groupsToCheck = {"ambulance", "police"}
        },
    },
}

To begin, if you're not using this standalone, start by setting standalone to false. This will disable standalone mode. You should then enable a framework in order to use this.

Before we enable a framework, you should ensure itemEnabled is set to true in this section, as otherwise having the framework setting enabled won't change anything - it is mainly for the item.

Setting up frameworks is simple, if you need QBCore, go to that section and the same for vRP and ESX.

Enabling the framework: Navigate to your framework section and set enabled to true.

Item name: Each config section has a value named itemName, you should set this to the desired name of the defib. By default, this is set to "defib".

You are required to add this as an item in your framework, see the documentation for your relevant framework for more information on this. This will ensure our resource links in with your inventory/item system correctly and without the item setup in your framework config, it won't work.

Group check: Each config framework section has an identical sub-section for group checks:

groupCheck = {
            enabled = false,
            groupsToCheck = {"ambulance", "police"}
        },

The group check for items is designed as a second line of permission incase the item is given to another player or obtained by a player who isn't on duty as ambulance/EMS, or whichever job you desire.

To add a new job, just wrap it in speech marks "" and separate them with a comma.

This is where you may want to add your ambulance/police job.