Tutorial / Settings
Jobs
Make the jobs players pick in RP mode: pay, model, weapons, slots, ranks, abilities, staff jobs, licenses and elected jobs.
What it does
Jobs is the editor for the toolbox's own RP jobs. A job sets a player's paycheck and what they are allowed to do. It is also a team, so it colors their name on the scoreboard and in chat.
A job can also give models, weapons, health and armor. Staff jobs are limited to admins and a whitelist, and elected jobs are won by a vote.
Players without a job are Unemployed, in their own grey team. Jobs only run when Settings > Gameplay > Server mode is RP, and they are off while DarkRP runs. You can still set them up in any mode.
Where to find it
Q menu > KGX's Admin Toolbox > Settings > Jobs.
Anyone can open the page, but only superadmins can change jobs and settings. Whitelists are only sent to superadmins.
Players pick a job in these places:
!jobs,/jobsor the console commandkgxat_jobs. With the F3 hub on (the default), these open the hub's Jobs tab.- F4, when the F3 hub is turned off. It opens the Jobs window.
!job <name>takes a job by name.!job unemployedor!job nonequits.- For players: the C menu's ATB window, Me tab > Jobs.
- Talking NPCs can also give jobs, and admins can set anyone's job from the Player Manager (Set job).
The panel
Sliders in the first group only apply when you click Apply. Checkboxes and the Jobs list shows box apply at once. Every change to the job list is saved straight away.
Job settings
| Option | What it does | Default |
|---|---|---|
| Jobs on | Turns the job system on in RP mode. | On |
| Jobs set their player model (off: players pick their look at a Wardrobe talking NPC) | Jobs change the player's model. | On |
| Seconds between job changes | Cooldown for players (admins skip it). | 10 (0-600) |
| Paycheck of Unemployed players (-1 = normal paycheck of their rank, 0 = none) | What players without a job are paid. | 0 (-1 to 100000) |
| Check every player's weapons after a spawn or job change (missing ones given, the gamemode's default weapons removed) | The gear check. Weapons bought in stores are kept. | On |
| Toolbox admins also spawn with the Physics Gun and Tool Gun in RP mode | Admin tools in RP mode, whatever the citizen weapons are. | On |
| Apply | Sends the two sliders to the server. |
Unemployed / citizens
| Option | What it does | Default |
|---|---|---|
| Weapons (classes, comma separated; default kgxat_hands) + Apply | What players without a job spawn with. Jobs add theirs on top unless they replace them. | kgxat_hands |
| Model (path or player model name; empty = the player's own) + Apply | The Unemployed model. Pick a player model... fills the box from the installed models. | empty |
| Jobs list shows | No model, The job model's head or The job model's full body in the job list. | The job model's head |
Keys, Hands and Pockets are always handed out when they are on. With Settings > Citizen Looks on, citizens wear one of that list instead of the model.
The job list
The list has the columns Job, Slots and Pay. Click a job to load it into the form below. Right-click a job for Move up, Move down, Rename..., Set slots..., Set paycheck..., Duplicate and Remove....
The job form
| Option | What it does | Default |
|---|---|---|
| Name | Job name, up to 32 characters. | |
| Description | Shown in the job list. | |
| Model (path or player model name, empty = their own) | Look 1 of the job. | empty |
| More models players can choose from (comma separated; the model above is look 1) | Extra looks, up to 16. Add a player model to the choices... adds one from a list. | empty |
| Weapons (classes, comma separated) | Up to 16 weapon classes. | |
| Only for ranks (comma separated, empty = everyone) | Up to 16 ranks. Double-click a rank in the list below to add or remove it. | empty |
| Paycheck (-1 = normal) | Pay per paycheck. -1 = the rank's normal paycheck. | -1 (-1 to 10000) |
| Slots (0 = no limit) | Most players in the job. | 0 (0-64) |
| Health (0 = normal) | Max health and health on spawn. | 0 (0-1000) |
| Armor (0 = none) | Armor on spawn. | 0 (0-1000) |
| Only the job's weapons (replace the normal loadout) | Strips other weapons. Keys and Pockets are still given. | Off |
| Spawn at | Normal spawns, Spawn points named "...", or Warp: .... | Normal spawns |
| Move members there when they take the job | Taking the job moves the player to that spot. | On |
| Elected by vote (players run for it, everyone votes; Utilities > Voting settings) | The job is won in an election. | Off |
| Needs license | A license players need to take the job. | (none) |
| Members get these licenses while in it (ids, comma separated: gun, medical, ...) | Up to 8 license ids the job grants. | empty |
| Ability checkboxes | What the job can do (see below). | Off |
| Store type checkboxes | Which shipments a store job may buy and sell (Settings > Shipments > Store types). | Off |
| Skill sliders | How good the job is with each tool. | 1 (0.25-4) |
| Who can take it | Everyone (normal job), Admin job (admins + whitelist) or Superadmin job (superadmins + whitelist). | Everyone |
| Whitelisted players get toolbox admin access while in this job | Staff job access for whitelisted members. | On |
| Whitelist (SteamIDs, comma separated; BOT = test dummies) | Up to 64 SteamIDs. | empty |
| Color mixer | The team color. |
Below the form are the buttons Add as a new job, Update the selected job, Remove the selected job, the Add a preset job box, and Move the selected job up / Move the selected job down.
The abilities and skills
| Ability | What it allows |
|---|---|
| Store owner | Buys and sells shipments (F3 hub > Shipments). |
| Lockpicking | Uses the Lockpick when it is limited to these jobs. |
| Keypad hacking | Uses the Keypad Hacker when it is limited to these jobs. |
| Black market dealer | Sells printer upgrades, Repair Tools and Printer Hackers (!blackmarket). |
| Robber | May rob money sources set to "jobs that can rob". |
| Police | Police gear; told where a robbery starts. |
| Pickpocket | May pick pockets when that is limited to these jobs. |
| Hobo | May use Poop. |
| Treasury (v3.6.20) | Sees the server treasury and pays players out of it with !treasury, within the limits of Settings > Taxes & Treasury (for a Mayor). |
Skills exist for Lockpick, Keypad Hacker, Printer Hacker, Repair Tool (money printers), Pickpocketing (Hands) and Robbing money sources. A value of 2 is twice as fast with twice the chance (at most 100%). 0.5 is half as fast.
How to use it
Make a new job
- Set Settings > Gameplay > Server mode to RP.
- Open Settings > Jobs and type a Name and Description.
- Fill in Model, Weapons, Paycheck (-1 = normal) and Slots (0 = no limit).
- Tick the abilities the job needs and pick a team color.
- Click Add as a new job. It is saved at once and shows in every player's job list.
Change or remove a job
- Click the job in the list. Its settings fill the form.
- Change what you need and click Update the selected job.
- To delete it, click Remove the selected job and confirm. Players in it become Unemployed.
Make a staff job
- Make or select a job and set Who can take it to Admin job (admins + whitelist).
- Open Add an online player to the whitelist and pick a player, or type SteamIDs.
- Leave Whitelisted players get toolbox admin access while in this job ticked to give them admin access in the job.
- Click Update the selected job.
Regular players see the job as Locked with the reason. A whitelisted player in the job uses the toolbox like an admin, but superadmin settings still need a real superadmin. Taking someone off the whitelist removes them from the job.
Make an elected job
- Select the job, tick Elected by vote (players run for it, everyone votes; Utilities > Voting settings) and click Update the selected job.
- When a player picks the job, chat says they are running. Others pick the job in the next
kgxat_election_joinseconds to run too (up to 6). - Everyone then votes. With one candidate it is a yes / no vote. The winner gets the job if it is still free.
Settings and commands
| Setting or command | What it does | Default | Range |
|---|---|---|---|
kgxat_jobs (convar) |
Jobs in RP mode | 1 | 0-1 |
kgxat_job_models |
Jobs set the player model | 1 | 0-1 |
kgxat_job_cooldown |
Seconds between job changes | 10 | 0-600 |
kgxat_unemployed_pay |
Unemployed paycheck | 0 | -1 to 100000 |
kgxat_job_gear_check |
Gear check after spawns | 1 | 0-1 |
kgxat_rp_admin_tools |
Admins get Physics Gun and Tool Gun | 1 | 0-1 |
kgxat_citizen_weapons |
Unemployed weapons | kgxat_hands |
text |
kgxat_citizen_model |
Unemployed model | empty | text |
kgxat_jobs_model_view |
0 no model, 1 head, 2 full body | 1 | 0-2 |
kgxat_job_equip |
Taking a job: 3 = dissolve, 2 = instant death, 1 = instant loadout, 0 = off (Settings > Gameplay; replaces kgxat_job_respawn) |
3 | 0-3 |
kgxat_license_jobs |
Jobs with Needs license need it | 1 | 0-1 |
kgxat_elections |
Elected jobs use an election (0 = taken like any job) | 1 | 0-1 |
kgxat_election_join |
Seconds others have to run too | 30 | 10-120 |
kgxat_election_time |
Seconds the election vote runs | 30 | 15-120 |
!jobs, kgxat_jobs (command) |
Open the job list | ||
!job <name> |
Take a job by name |
Tips and limits
- At most 32 jobs. Jobs are saved in
garrysmod/data/kgx_admin_toolbox/jobs.json. - A server with no jobs gets the preset jobs once. Add a preset job adds any of them again: Store Owner, Police Officer, Medic, Thief, Chef, Hobo, Hacker, Bank Robber and Black Market Dealer.
- Taking a job (Settings > Gameplay > Job equip): by default the player dies dissolving and respawns where they stood (or at the job's spawn), so the new job's gear comes with a fresh spawn; the death takes nothing and does not count. Instant loadout freezes the player ("Changing job..."), respawns them in place and runs the gear check. Either way weapons bought in stores come back with their ammo. Not while jailed or handcuffed.
- Players cannot change jobs while jailed. Admins skip the cooldown, rank limits and the license need.
- Leaving RP mode or turning jobs off takes everyone out of their job.
- With several looks, players pick one next to Become.
- Spawn at uses World > Spawn Points names and Utilities > Warps. Maps without them use the normal spawns.