Tutorial / Settings

Player Loadouts

Decide what players spawn with outside RP mode: weapons, ammo, model, health, armor, speeds, gravity and size, per rank.

What it does

Player Loadouts decides what players spawn with outside RP mode: gear, reserve ammo, player model, health, armor, walk and run speed, jump, gravity and size. You make named loadouts, then assign one to each rank, with a default for everyone else.

Loadouts work in the Sandbox and Build / PvP server modes. In RP mode jobs decide instead, and citizens are players without a job.

Loadouts are given on spawn only. The inventory is emptied first, and dying does not hand back extra weapons. Players can also pick a loadout themselves with F4 or !loadout when it is allowed for them.

v3.6.15: each loadout has a Game mode: outside matches (as before), any match, or one Game Modes mode. Match loadouts are picked on the loadout screen of modes with Loadouts: players pick (Utilities > Game Modes, mode editor). In a match the loadout gives the weapons and ammo; health, armor, model and speed stay the class's (role's). Match loadouts work whether Player Loadouts on is ticked or not.

Where to find it

Q menu > KGX's Admin Toolbox > Settings > Player Loadouts.

Superadmins only. Everyone else sees "Only superadmins can see and edit player loadouts." Players pick loadouts with F4 or the !loadout chat command (also !loadouts, /loadout, or the console command kgxat_loadout_menu).

The panel

Top settings
Option What it does Default
Player Loadouts on Turns loadouts on. Saved with SAVE LOADOUTS. Off
Server mode Sandbox (loadouts), Build / PvP (loadouts) or RP (jobs instead of loadouts). Applies as soon as you pick. Build / PvP
Picking a loadout with F4 costs its price F4 picks cost the loadout's price in economy money. Applies at once. Off
Reset the Admin and Superadmin loadouts every time the server loads The built-in Admin and Superadmin loadouts and their rank assignments go back to default on every server or map load. Saved with SAVE LOADOUTS. On
Loadout list and editor
Option What it does Default (new loadout)
Loadouts list: Name, Game mode, Gear Every loadout, what it is for (Outside matches, Any match, or a mode's name) and its weapon count. Click one to edit it.
Loadout name Name for New loadout and Rename.
Gear list: Weapon, Class Weapons of the selected loadout. Double-click to remove. Hands, Tool Gun, Physics Gun, Crowbar, Pockets
Search weapons to add (double-click), or type a class and press Enter Filters the weapon list, or adds a typed class on Enter.
Weapon list: Weapon, Category, Class Every weapon. Double-click to add it.
Reserve ammo (0 = game default) Reserve ammo for each weapon's ammo types (0-9999). 0
Player model (empty = the player's own) Model path. empty
Pick a player model... Opens a searchable model picker.
Use the player's own model Clears the model.
Game mode v3.6.15: Outside matches (F4, ranks), Any match (modes with Loadouts on), or Match: <mode>. Ranks can only be given loadouts for outside matches. Outside matches
Only for Everyone, Admins (and superadmins) or Superadmins. Everyone
Players can pick this loadout (F4, or the match's loadout screen) Shows it on the loadout screen. On
Price (F4 with prices on: wallet; matches with paid loadouts: match money, once) 0-100000. Outside matches: the wallet, with F4 prices on. In a mode with Loadouts: cost their price in match money: match money, paid once per match. 0
Health 1-1000. 100
Armor 0-255. 0
Walk speed 1-1000. 200
Run speed 1-2000. 400
Jump power 0-1000. 200
Gravity multiplier 0.05-5. 1
Player size 0.1-5. 1
Which loadout each rank gets

One row per rank: Everyone else (default), then Rank: <name> for user, admin, superadmin, your admin mod's ranks, assigned ranks and ranks online.

Choice What it does
(use the default above) The rank gets the default row's loadout.
(gamemode default - no loadout) The gamemode's own spawn gear.
A loadout name That loadout.
Buttons
Option What it does
New loadout (name above) Makes a loadout with the typed name, copied from the selected one.
Rename selected to the name above Renames it and updates rank assignments.
Delete selected loadout Deletes it after a question. Ranks that used it lose the assignment.
SAVE LOADOUTS Saves everything to the server.
Apply to everyone now (re-equips living players) Gives every living player their loadout now. Not jailed or ragdolled players.
Undo unsaved changes Loads the saved loadouts again.
Reset the Admin and Superadmin loadouts Puts the built-in Admin and Superadmin loadouts and assignments back, after a question.
Reset to defaults... Replaces all loadouts with the default "Builder" loadout, after a question.

How to use it

Give every user a set of weapons
  1. Open Q menu > KGX's Admin Toolbox > Settings > Player Loadouts as a superadmin.
  2. Tick Player Loadouts on. Make sure Server mode is Sandbox or Build / PvP.
  3. Select Builder. Double-click weapons in the weapon list to add them; double-click gear to remove it.
  4. Set the stats, for example Health 150.
  5. In Rank: user, pick Builder.
  6. Press SAVE LOADOUTS, then Apply to everyone now (re-equips living players).
Make a new loadout
  1. Type a name in Loadout name.
  2. Press New loadout (name above). It starts as a copy of the selected loadout.
  3. Edit its gear and stats, then press SAVE LOADOUTS.
Let players buy loadouts with F4
  1. Tick Picking a loadout with F4 costs its price.
  2. For each loadout, tick Players can pick this loadout with F4 and set F4 price (with prices on).
  3. Press SAVE LOADOUTS. Players press F4 or type !loadout and press Pick.
Give a game mode its own loadouts (v3.6.15)
  1. Make loadouts and set Game mode to Match: Team Deathmatch (or Any match). Put the primary weapon first, then the secondary, then equipment: that is their order on the hotbar (1, 2, 3...).
  2. Press SAVE LOADOUTS.
  3. In Utilities > Game Modes, edit the mode and set Loadouts to Server loadouts (or Both with the players' Armory classes). Save the mode.
  4. When its lobby opens, every player gets the loadout screen: 1-9 pick, Enter equip, U use current, C show current, Esc skip. F4 opens it again during the match.
Keep admins on the gamemode loadout
  1. In Rank: admin, pick (gamemode default - no loadout).
  2. Untick Reset the Admin and Superadmin loadouts every time the server loads, or the assignment comes back on the next load.
  3. Press SAVE LOADOUTS.

Settings and commands

Convar / command Default What it does
kgxat_playmode 1 Server mode: 0 Sandbox, 1 Build / PvP, 2 RP.
kgxat_loadout_prices 0 1 = picking a loadout with F4 costs its price.
kgxat_gear_debug 0 1 = the server console prints what every spawning player gets and why.
!loadout, !loadouts, /loadout, /loadouts Opens the loadout screen (in a match with loadouts: that match's).
kgxat_loadout_menu Opens the loadout screen (console).

Tips and limits

  • Nothing in the editor reaches the server until you press SAVE LOADOUTS. Server mode and the F4 price box apply at once.
  • Up to 20 loadouts, and up to 30 weapons per loadout.
  • Saved in data/kgx_admin_toolbox/loadouts.json.
  • The built-in Admin loadout has Hands, Physics Gun, Tool Gun, Gravity Gun, Camera, Crowbar, Pistol, SMG and Pockets, 100 armor and 120 ammo. Superadmin adds the .357.
  • A model set with the Player Model tool (kept after respawn) wins over the loadout model.
  • v3.6.16: players can also build their own classes in the Armory (Settings > Armory); modes with Both offer server loadouts and classes, Armory only classes (v3.6.17).
  • The loadout screen (v3.6.15): loadouts on the left (CURRENT, price or OWNED); on the right the primary weapon with its model and stat bars (Damage, Fire rate, Range, Accuracy, Mobility, Control), the secondary, the equipment and the class or player stats. Stats come from the weapon's Lua (Garry's Mod SWEPs, M9K, TFA, ArcCW, ARC9, CW 2.0) or a built-in table for HL2 weapons; a weapon without readable stats says so.
  • v3.6.18.1: the loadout screen shows your character on the right: the player model holding the primary weapon, turning slowly (drag it to turn it). When the loadout sets a Player model (or, in a match, the class role has one), a switch shows LOADOUT MODEL / CLASS MODEL or YOUR MODEL (your Q menu > Player Model choice, with its skin, bodygroups and color). Weapon previews are at most 300 x 170 and cards keep sensible sizes on big and wide screens.
  • Keys, Pockets and Hands are always given back after a loadout.
  • Jailed players get no gear on spawn.
  • A pick from F4 applies now if you spawned less than 20 seconds ago (or are an admin); otherwise on the next spawn.
  • F4 prices only apply when the economy is on.

Back to Settings

Type to search every tool, panel, setting, FAQ answer and release.