Tutorial / Settings
Licenses
Set the license rules (property, guns, driving, jobs), pick the Tool License's tools, and make your own custom licenses.
What it does
Licenses are kept with each player's SteamID. Anyone can buy them at a store that sells them; the F3 hub's Server Store has every built-in one. Admins give and take them in the Player Manager (right-click a player > Licenses).
This panel sets which actions need a license: buying property, buying guns and ammo, driving, and taking jobs. It lists the built-in licenses.
It also sets the Tool License: its holders may use the tools you pick, like a Player Access tick. You can make custom licenses too, which can need another license first, be free for some jobs or ranks, and carry their own tools.
Where to find it
Q menu > KGX's Admin Toolbox > Settings > Licenses.
Only superadmins can change these settings. Everyone else sees the line "Only superadmins can change these settings." with the controls greyed out. With a server owner set (v3.6.12), only owners change which tools licenses give and the ranks that get them free. Players see their own licenses with the !licenses chat command.
The panel
Rules
Each checkbox applies as soon as you tick it.
| Option | What it does | Default |
|---|---|---|
| Buying or renting property needs a Property License | Property needs the Property License. | On |
| Buying guns and ammo (stores, shipments) needs a Gun License | Weapons and ammo from stores and shipments need the Gun License. | Off |
| Driving a vehicle needs a Driver's License (not seats or chairs) | Entering a vehicle needs the Driver's License. | Off |
| Jobs that ask for a license need it (Settings > Jobs: Needs license) | Jobs with "Needs license" can only be taken with it. | On |
Any store item can ask for a license too (Store editor > Items: Needs ...). Jobs can also give their members licenses while they are in the job (Settings > Jobs).
Built-in
| License | Id | Use |
|---|---|---|
| Property License | property |
Needed to buy or rent property (kgxat_property_license). |
| Gun License | gun |
Needed to buy guns and ammo when kgxat_license_gun is on. |
| Driver's License | driver |
Needed to drive vehicles when kgxat_license_driver is on. |
| Food License | food |
For cooks and food sellers (store items and jobs can ask for it). |
| Medical License | medical |
For medics and medical items (store items and jobs can ask for it). |
| Business License | business |
For shop owners (store items and jobs can ask for it). |
| General License | general |
A general trade license (store items and jobs can ask for it). |
| Tool License | tool |
Lets its holder use the tools picked for it. |
| Phone License | phone |
Lets its holder own and use a phone book (calls, texts, groups) when kgxat_phone_license is on (v3.6.21.2). Phone booths work without it. |
Tool License
A status line shows how many tools it has, and the ranks that get it for free.
| Option | What it does |
|---|---|
| Tool License: free for these ranks... | Pick ranks that have the Tool License without buying it. Saved when you press Done. |
| Tool License: pick its tools... | Opens a tool browser with search. Tick the tools, then Done saves them. |
Tools marked "also: ..." in the browser unlock more than the tool (the same notes as Player Access).
Custom licenses
| Option | What it does |
|---|---|
| List: Id, Name, Needs | Every custom license. Click one to load it into the form. A tool count shows after the name. |
| Id (letters, digits, _) | The license id. Built-in ids cannot be used. |
| Name | The name players see. |
| Description | A short description. |
| Needs this license first | (nothing), or a license a player must hold before buying this one. |
| Free for these jobs (comma separated) | Jobs whose members have it without buying it. |
| Pick jobs... | Fills the box above from the list of jobs and teams. |
| Free for these ranks... | Pick ranks that have it without buying it. The button then lists them. |
| Tools for this license (makes it a tool license; after the id)... | Pick tools its holders may use. Type the id first. |
| Add / replace (by id) and save | Saves the form. A license with the same id is replaced. |
| Remove the selected one and save | Deletes the selected license. |
How to use it
Require a Gun License
- Open Q menu > KGX's Admin Toolbox > Settings > Licenses as a superadmin.
- Tick Buying guns and ammo (stores, shipments) needs a Gun License.
- A player without one now sees "You need a Gun License to buy <item>." at stores and shipments.
Hand out tools with the Tool License
- Press Tool License: pick its tools....
- Search, double-click the tools to tick them, then press Done.
- Players who buy the Tool License (or get it in the Player Manager) can use those tools.
- To give it to a rank for free, press Tool License: free for these ranks... and pick the rank.
Make a custom license
- Type an Id (letters, digits, _), for example
fishing, and a Name. - Optional: pick Needs this license first, for example General License.
- Optional: fill Free for these jobs (comma separated) or press Free for these ranks....
- Press Add / replace (by id) and save.
- Sell it with the Store Maker (item type License), or give it in the Player Manager.
Settings and commands
| Convar / command | Default | What it does |
|---|---|---|
kgxat_property_license |
1 | Property needs a Property License. |
kgxat_license_gun |
0 | Guns and ammo need a Gun License. |
kgxat_license_driver |
0 | Driving needs a Driver's License. |
kgxat_license_jobs |
1 | Jobs that ask for a license need it. |
!licenses / kgxat_mylicenses |
Shows your licenses in chat. | |
kgxat_licenses [name] |
Admins: lists every license in the console, and which ones a player has. |
For server Lua: KGXAT.RegisterLicense({id = "fishing", name = "Fishing License", desc = "Fish at the pier.", check = function(ply) return true end, onGive = function(ply) end, onTake = function(ply) end}), KGXAT.HasLicense(ply, "fishing"), and the hook KGXATLicenseChanged(ply, id, on). The Logic tool's License action gives or takes one.
Tips and limits
- Admins are not blocked by the gun and driver rules.
- The driver rule does not cover seats and chairs.
- Up to 64 custom licenses. Each can be free for up to 16 jobs and 32 ranks.
- Licenses free for a rank follow rank changes at once.
- Saved in
data/kgx_admin_toolbox/license_custom.json. - A custom license that used the id
toolis renamedtool_custom;toolis the built-in Tool License. - A tool hidden from a player in Settings > Tool Visibility cannot be used, even with a license.