Build a custom bridge - Developers

This example registers a custom player provider and a client interaction provider. Add only the domains your server owns.

Directory

resources/
├── humalike/
└── my-humalike-bridge/
    ├── fxmanifest.lua
    ├── server.lua
    └── client.lua

Manifest

fx_version 'cerulean'
game 'gta5'
lua54 'yes'

name 'my-humalike-bridge'
version '1.0.0'

dependency 'humalike'

server_script 'server.lua'
client_script 'client.lua'

Start it after HumaLike:

ensure humalike
ensure my-humalike-bridge

Server provider

local function registerProviders()
    local ok, err = exports.humalike:RegisterProvider('player', {
        name = 'my_framework',
        apiVersion = 1,
        priority = 100,

        Available = function()
            return GetResourceState('my-core') == 'started'
        end,

        GetCharacterId = function(source)
            local player = exports['my-core']:GetPlayer(source)
            return player and player.characterId or nil
        end,

        GetCharacterName = function(source)
            local player = exports['my-core']:GetPlayer(source)
            return player and player.fullName or nil
        end,

        IsCharacterLoaded = function(source)
            return exports['my-core']:GetPlayer(source) ~= nil
        end,

        HasJob = function(source, jobNames, requireDuty)
            local player = exports['my-core']:GetPlayer(source)
            if not player then return false end

            for _, name in ipairs(jobNames) do
                if player.job.name == name then
                    return not requireDuty or player.job.onDuty == true
                end
            end
            return false
        end,

        Notify = function(source, message, kind)
            TriggerClientEvent('my-ui:notify', source, message, kind)
        end,
    })

    if not ok then
        print(('[my-humalike-bridge] player provider failed: %s'):format(err))
    end
end

AddEventHandler('onResourceStart', function(resource)
    if resource == GetCurrentResourceName() then registerProviders() end
end)

AddEventHandler('humalike:integration:ready', registerProviders)

Do not cache a player object across callbacks. Resolve the active character from source each time so reconnects and character switches are handled correctly.

Client interaction provider

local entries = {}

local function registerInteraction()
    exports.humalike:RegisterInteractionProvider({
        name = 'my_target',
        apiVersion = 1,
        priority = 100,

        Available = function()
            return GetResourceState('my-target') == 'started'
        end,

        watchedResources = { 'my-target' },

        Add = function(id, entity, options)
            entries[id] = { entity = entity, options = options }
            exports['my-target']:AddEntity(entity, options)
            return true
        end,

        Remove = function(id)
            local entry = entries[id]
            if not entry then return end
            exports['my-target']:RemoveEntity(entry.entity)
            entries[id] = nil
        end,

        Progress = function(durationMs, label)
            return exports['my-progress']:Run(durationMs, label) == true
        end,
    })
end

AddEventHandler('onClientResourceStart', function(resource)
    if resource == GetCurrentResourceName() then registerInteraction() end
end)

AddEventHandler('humalike:integration:ready', registerInteraction)

Each option contains text, optional icon, canInteract(entity), and onSelect(entity). Preserve those callbacks when adapting the option to your target system.

Select and verify

set humalike_player my_framework
setr humalike_interaction my_target

Run humalike_status in both the server and client consoles. Both domains should show selected, the expected provider name, and the bridge as owner. See Provider API for every descriptor and return value.

Next