Setup

Steps for setting up your zyke_status resource.

ESX Guide

1

Database

Run the SQL query located in zyke_status/extras/zyke_status.sql.

2

Remove Old Status

Remove your old esx_status resource from the server, and make sure it does not get started in your server.cfg.

3

Start zyke_status after zyke_lib.

---

QBCore Guide

For QBCore, it is slightly more complicated because of their setup. The exact steps and lines may differ based on your version and your hud of choice, but the events we need to remove are usually the same.

We offer two approaches, depending on if you want QB to still handle some values, or completely rely on our system. However, we do recommend that you follow the "Full Control" giode so that there are no duplicate drains/effects etc.

Basic Compatibility

To get the basic compatibility going, you will need to modify the SetMetaData function. This allows us to catch any attempts to modify your status, which then dispatch it to our system to handle the rest. Our system will execute everything needed for the rest of your server to proceed as normal.

1

Database

Run the SQL query located in zyke_status/extras/zyke_status.sql.

2

Modify Player Method

Navigate here and replace the entire function with the code provided below (L274-L281).

-- Modified to execute our export when triggered
-- Also blocks duplicate requests that will occur when we dispatch
function self.Functions.SetMetaData(meta, value)
    if (not meta or type(meta) ~= "string") then return end

    local invoker = GetInvokingResource()

    -- If the request was not made by our resource, dispatch it to us and block the rest
    -- Our system will re-trigger this event after updating all of our values and sync qb-core
    if (invoker ~= "zyke_status") then
        if (meta == "hunger" or meta == "thirst" or meta == "stress") then
            if (value > 100.0) then value = 100.0 end
            if (value < 0.0) then value = 0.0 end

            return exports["zyke_status"]:SetStatusValue(self.PlayerData.source, {meta, meta}, value)
        end
    end

    self.PlayerData.metadata[meta] = value
    self.Functions.UpdatePlayerData()
end

3

Avoid Duplicate Calls

Navigate here and disable the two events (L213-L225). This is simply to avoid duplicate calls, and we ensure the best performance by not making any workarounds and just disabling them entirely. This step may differ based on your consumable resource on your server, but should be the same event names despite what resource they are in.

4

Start zyke_status after zyke_lib.

Full Control (Remove QBCore drains/additions/effects)

• [Gaining Stress] Navigate here and remove the entire event (L20-L40).

• [Stress Relieving] Navigate here and remove the entire event (L42-L62).

• [Hunger & Thirst Drain] Navigate here and replace the entire event with the code provided below (L151-167).

-- Modified to remove hunger & thirst drain
RegisterNetEvent('QBCore:UpdatePlayer', function()
    local ply = QBCore.Functions.GetPlayer(source)
    if (not ply) then return end

    ply.Functions.Save()
end)

• [Stress Effects] Navigate here and remove the entire thread (L977-L1011)

---

Qbox Guide

Basic Compatibility

To get the basic compatibility going, you will need to modify the SetMetaData function. This allows us to catch any attempts to modify your status, which then dispatch it to our system to handle the rest. Our system will execute everything needed for the rest of your server to proceed as normal.

1

Database

Run the SQL query located in zyke_status/extras/zyke_status.sql.

2

Modify SetMetadata

Navigate here and paste in the snippet below the line you are referred to.

if (metadata == "hunger" or metadata == "thirst" or metadata == "stress") then
    if (GetInvokingResource() ~= "zyke_status") then
        -- We don't support changing these values offline at the moment
        if (player.Offline) then return end

        if (value > 100.0) then value = 100.0 end
        if (value < 0.0) then value = 0.0 end

        local source = player.PlayerData.source

        return exports["zyke_status"]:SetStatusValue(source, {metadata, metadata}, value)
    end
end

3

Avoid Duplicate Calls

To avoid duplicate calls, we have to disable events that are triggered within the core. We catch these events and process them already.

• Navigate here and remove the event (L159-171)
• Navigate here and remove the event (L180-192).

4

Start zyke_status after zyke_lib.

Full Control (Remove Qbox drains/additions/effects)

• [Gaining Stress] Navigate here and remove the entire event (L25-L47).
• [Stress Relieving] Navigate here and remove the entire event (L49-L71).
• [Hunger & Thirst Drain] Navigate here and remove the entire thread (L15-L23).
• [Stress Effects] Navigate here and remove the entire thread (L884-L918)