How to add a job on QBCore: shared/jobs.lua, grades and /setjob

On QBCore a job is a block in one Lua file, not a database row. You add the block, restart the core, and set the job on a player. This guide shows the structure, the command, and how to read the job in code, for QBCore and QBox.

#The structure

Open qb-core/shared/jobs.lua. Jobs are entries in the QBShared.Jobs table, keyed by the job name. Add yours:

['mechanic'] = {
    label = 'Mechanic',
    defaultDuty = true,
    offDutyPay = false,
    grades = {
        ['0'] = { name = 'Recruit', payment = 50 },
        ['1'] = { name = 'Mechanic', payment = 75 },
        ['2'] = { name = 'Boss', payment = 120, isboss = true },
    },
},

What each part means:

Two rules:

• Grade keys are strings on QBCore: ['0'], ['1']. Start at '0' with no gaps.
• Look at the jobs already in the file, such as police, and copy their shape. Some jobs carry an extra type field that other scripts use to group them, and the file shows what your version supports.

Warning: a missing comma or brace in jobs.lua stops qb-core from loading, and every script that depends on it with it.

#Restart and set the job

The core reads the file at start:

restart qb-core

Then, as an admin, in game or the console:

/setjob <player id> mechanic 1

The values are the player id, the job key and the grade number. If the command is refused, you lack admin permissions: see ACE permissions for admins.

#Read the job in scripts

On the server:

local QBCore = exports['qb-core']:GetCoreObject()

RegisterNetEvent('my_script:doWork', function()
    local src = source
    local Player = QBCore.Functions.GetPlayer(src)
    if not Player then return end

    local job = Player.PlayerData.job
    if job.name ~= 'mechanic' then
        return TriggerClientEvent('QBCore:Notify', src, 'You are not a mechanic', 'error')
    end

    if not job.onduty then
        return TriggerClientEvent('QBCore:Notify', src, 'Go on duty first', 'error')
    end

    -- allowed
end)

Player.PlayerData.job holds name, label, onduty, isboss, payment and a grade table with the rank's name and level. For the rank number use job.grade.level.

To change the job from code:

Player.Functions.SetJob('mechanic', 1)

If QBCore is nil here, see attempt to index a nil value (global 'QBCore').

#On the client

local QBCore = exports['qb-core']:GetCoreObject()
local PlayerData = {}

RegisterNetEvent('QBCore:Client:OnPlayerLoaded', function()
    PlayerData = QBCore.Functions.GetPlayerData()
end)

RegisterNetEvent('QBCore:Client:OnJobUpdate', function(job)
    PlayerData.job = job
end)

Reading GetPlayerData().job before the player has loaded gives nil, so wait for OnPlayerLoaded, and keep the job fresh with OnJobUpdate.

#On QBox

QBox's core is qbx_core, and the jobs file is qbx_core/shared/jobs.lua. The structure is the same: a label, defaultDuty, offDutyPay and grades. Open the file and follow the entries already in it, since QBox's file can differ in details such as how the grade keys are written, and new versions may add fields.

Restart qbx_core after the edit. For code, the compatibility layer still answers exports['qb-core']:GetCoreObject(), and QBox's own export is:

local player = exports.qbx_core:GetPlayer(source)
if player then
    print(player.PlayerData.job.name)
end

#Boss menu and funds

A grade with isboss = true is only the flag. The menu that lets the boss hire people and use the company account comes from your management resource, which usually has its own list of jobs to configure. If the boss menu does not open for your new job, check that resource's config for the job name.

#Common problems

• Job not found by /setjob. The core was not restarted, or the key is misspelled.
• Core fails after the edit. A syntax error in jobs.lua. Read the first red line in the console, and how to read a script error helps with the file and line.
• Pay is not received. offDutyPay = false means the player must be on duty, and the paycheck interval comes from the core's config.

#Checklist