/jobscreator menu, go to settings, and choose it. As easy as that.
Available Modules
| Category | Available Options |
|---|---|
| Banking | default, example, okok |
| Boss | default, example |
| Logs | custom, jaksam |
| Notify | default, example, origen, ox_lib |
| Outfits | default, illenium-appearance, rcore_clothing |
| Progress Bar | jaksam, ox_lib, qb-core |
| Search Player | jaksam, jaksam_inventory, ox_inventory |
| Skillcheck | jaksam, ox_lib |
| Stash | default, hc_inventory, jaksam_inventory, ox-inventory, qb-inventory |
| Text UI | esx, jg-text, none, ox_lib |
Creating a Custom Module
Pick the category you want to create a module for. Each tab walks you through the exact steps for that category and gives you a ready-to-edit template.- Banking
- Boss
- Logs
- Notify
- Outfits
- Progress Bar
- Search Player
- Skillcheck
- Stash
- Text UI
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/banking folder.2
Duplicate an existing module
Copy an existing module (e.g.
example) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating:
local moduleType = "banking"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Returns the current money balance of the given society/business account
Integrations[moduleType][moduleName].getSocietyMoney = function(societyName)
-- Add your code here
end
-- Adds money to the given society/business account
Integrations[moduleType][moduleName].giveMoneyToSociety = function(societyName, amount)
-- Add your code here
end
-- Removes money from the given society/business account
Integrations[moduleType][moduleName].removeMoneyFromSociety = function(societyName, amount)
-- Add your code here
end
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/boss folder.2
Duplicate an existing module
Copy an existing module (e.g.
example) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating. All four functions are optional overrides: returning
nil leaves the default Jobs Creator behavior untouched.local moduleType = "boss"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Called before returning the employees list to the client, return the (optionally modified) list
Integrations[moduleType][moduleName].modifyEmployeesList = function(employeesArray, jobName)
-- Add your code here
return employeesArray
end
-- Called when an employee is fired. Return true if you handled it yourself, nil to keep the default behavior
Integrations[moduleType][moduleName].fireEmployee = function(playerId, employeeIdentifier, jobName)
-- Add your code here
return nil
end
-- Called before recruiting a player. Return true if you handled it yourself, nil to keep the default behavior
Integrations[moduleType][moduleName].recruitPlayer = function(playerId, targetId, jobName)
-- Add your code here
return nil
end
-- Called before changing an employee's grade. Return true if you handled it yourself, nil to keep the default behavior
Integrations[moduleType][moduleName].changeGradeToEmployee = function(playerId, employeeIdentifier, newGrade, jobName)
-- Add your code here
return nil
end
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/logs folder.2
Duplicate an existing module
Copy an existing module (e.g.
jaksam) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating:
local moduleType = "logs"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Sends a log entry (e.g. to a Discord webhook or a custom logging script)
Integrations[moduleType][moduleName].log = function(playerId, title, description, type, logType)
-- Add your code here
end
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/notify folder.2
Duplicate an existing module
Copy an existing module (e.g.
example) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating:
local moduleType = "notify"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Shows a notification with a plain message and an (optionally) colored version of it
Integrations[moduleType][moduleName].showNotification = function(message, coloredMessage)
-- Add your code here
end
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/outfits folder.2
Duplicate an existing module
Copy an existing module (e.g.
rcore_clothing) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating.
openExternalMenu controls the others: return true to fully replace the outfits UI with your own script (only openWardrobe/openJobOutfits are used), or false to keep using the Jobs Creator menu (getPlayerClothes/setPlayerClothes are used instead).local moduleType = "outfits"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Return true to fully replace the outfits UI with your own script, false to keep using the Jobs Creator menu
Integrations[moduleType][moduleName].openExternalMenu = function()
return false
end
-- Opens your script's saved player outfits menu (only used if openExternalMenu returns true)
Integrations[moduleType][moduleName].openWardrobe = function()
-- Add your code here
end
-- Opens your script's saved job outfits menu, fully replacing the Jobs Creator job outfit feature (only used if openExternalMenu returns true)
Integrations[moduleType][moduleName].openJobOutfits = function()
-- Add your code here
end
-- Returns the player's current outfit/clothes table (only used if openExternalMenu returns false)
Integrations[moduleType][moduleName].getPlayerClothes = function()
-- Add your code here
end
-- Applies the given outfit/clothes table to the player (only used if openExternalMenu returns false)
Integrations[moduleType][moduleName].setPlayerClothes = function(outfit, saveAfterRestart)
-- Add your code here
end
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/progressbar folder.2
Duplicate an existing module
Copy an existing module (e.g.
jaksam) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating:
local moduleType = "progressbar"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Starts a progress bar for the given time (ms), with the given text and color
Integrations[moduleType][moduleName].start = function(time, text, hexColor)
-- Add your code here
end
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/search_player folder.2
Duplicate an existing module
Copy an existing module (e.g.
ox_inventory) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating:
local moduleType = "search_player"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Opens the target player's search/inventory UI (e.g. after checking they're handcuffed)
Integrations[moduleType][moduleName].search = function(targetServerId)
-- Add your code here
end
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/skillcheck folder.2
Duplicate an existing module
Copy an existing module (e.g.
ox_lib) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating:
local moduleType = "skillcheck"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Starts a skillcheck minigame with the given difficulty and speed
Integrations[moduleType][moduleName].start = function(difficulty, speed)
-- Add your code here
end
-- Cancels the currently running skillcheck minigame
Integrations[moduleType][moduleName].cancel = function()
-- Add your code here
end
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/stash folder.2
Duplicate an existing module
Copy an existing module (e.g.
jaksam_inventory) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating:
local moduleType = "stash"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Opens the stash UI for the given marker
Integrations[moduleType][moduleName].open = function(type, markerId)
-- Add your code here
end
1
Navigate to the modules folder
Go to the
jobs_creator/_modules/textui folder.2
Duplicate an existing module
Copy an existing module (e.g.
ox_lib) and paste it in the same folder as a template.3
Rename the copy
Rename the pasted copy to match the integration you want to create.
4
Implement the required functions
Open the renamed file and edit it to match the events of the third-party script you’re integrating:
local moduleType = "textui"
local moduleName = "yourModuleName"
Integrations.modules = Integrations.modules or {}
Integrations.modules[moduleType] = Integrations.modules[moduleType] or {}
Integrations[moduleType] = Integrations[moduleType] or {}
Integrations[moduleType][moduleName] = {}
table.insert(Integrations.modules[moduleType], moduleName)
-- Shows a text UI prompt with the given message
Integrations[moduleType][moduleName].show = function(message)
-- Add your code here
end
-- Hides the text UI prompt
Integrations[moduleType][moduleName].hide = function()
-- Add your code here
end