Tutorial / Basics

Getting Started

Install KGX's Admin Toolbox, find its Q menu tab, learn who counts as an admin, and give players tools.

What it does

KGX's Admin Toolbox adds admin tools for the Sandbox tool gun on their own Q menu tab. It works in Sandbox and Sandbox-derived gamemodes (DarkRP and others) that use the tool gun.

The tab holds tools (used with the tool gun) and panels (settings and lists that open on the right of the menu). Admins can use everything. Superadmins decide which tools and panels non-admin players may use.

This guide covers the install, the tab and its categories, permissions, Player Access, Find a tool and favorites, and where the toolbox saves its data.

Where to find it

Q menu > KGX's Admin Toolbox. The tab label shows the installed version, for example KGX's Admin Toolbox (v3.6.9.4). It sits next to the game's own Tools, Utilities and Options tabs.

The categories, in order:

Category What is in it
Favorites Find a tool and the tools and panels you marked as favorites
Cheats God Mode, Noclip, Health & Armor, Movement, Give Weapon and similar
Fun Explosion, Launch, Rocket, Smite, Ragdoll, Player Effects
Functions Teleport, Freeze, Moderation, Jail, Spectate, Warp Points, Ranks, Keys
Building Door Maker, Button, Keypad, Precision Move, Stacker, Prefabs, Cameras
World Zones, NPC Spawner, Spawn Points, Storage, Talking NPC, Logic
Properties Inspector, Entity Properties, Ownership, Appearance, Paint Brush
Economy Store Maker, Money Printer, Money, Vehicle Pad, Economy
AI Commander, NPC Relationships, Patrol & Guard, NPC Editor, AI Brain
Utilities Player Manager, Server Tools, Reports, Bans, Voting, Diagnostics
Settings Server Settings, Player Access, Keybinds, Backup / Restore, Patch Notes & README

Admins also get the ATB window in the C menu (hold C). See the C Menu and the ATB Window guide.

Who is an admin

The toolbox checks these in order:

  1. A player who is incognito is treated as a normal player.
  2. With kgxat_superadmin_only 1, only superadmins can use the toolbox.
  3. A whitelisted player in a staff job that gives toolbox admin access can use it.
  4. With an admin mod that supports CAMI (ULX, SAM, sAdmin and others), the privilege KGX Admin Toolbox decides. Its default minimum rank is admin. Grant or revoke it per rank in your admin mod.
  5. Without such an admin mod, admin and superadmin can use it.

A non-admin who uses a toolbox tool gets "This tool is admin only." and nothing happens. Other tools are not affected.

Rank immunity (kgxat_immunity, on by default) stops admins from targeting superadmins. Non-admins can never target admins. With an admin mod, a rank cannot act on a rank that inherits from it. Players of the same rank may target each other while kgxat_immunity_same is 1.

Toolbox tools ignore prop protection ownership, so admins can act on anyone's props.

The panels

Player Access

Q menu > KGX's Admin Toolbox > Settings > Player Access. Only superadmins can change it; for others the checkboxes are greyed out.

Option What it does
Applies to All non-admin players, or Rank: plus a rank name, for one rank (for example VIP)
Refresh rank list Reloads the ranks in Applies to
Tool checkboxes One per toolbox tool, grouped by category (--- Cheats --- and so on)
Panel checkboxes Panels such as Player Manager (panel) and Reports (read and resolve) (panel), under Utilities
Orange notes What a tick unlocks besides the tool itself, for example Keys also gives Admin Keys
Allow everything (for the selection above) Ticks every tool and panel for the selection, after a Yes/No question
Untick everything (for the selection above) Clears every tick for the selection

A player may use a tool or panel when it is ticked for all players or for their rank. Admins can always use everything. With rank immunity on, players can never target admins with these tools.

Access is saved on the server for all maps, in data/kgx_admin_toolbox/access.json. Two other panels also control access. Settings > Tool Visibility hides tools and panels. Settings > Licenses can hand out tools with a Tool License.

Find a tool

Q menu > KGX's Admin Toolbox > Favorites > Find a tool. It lists every tool and panel you can see, with a search box.

Option What it does Default
Search box Searches names, categories and what each tool does, e.g. "freeze, door, ban, money" empty
Search every tab, not just the toolbox Includes tools from the other Q menu tabs off
Show favorites only Lists only your favorites off
Result list Columns: star, NEW icon or UPDATE (refresh) icon, Name, Category. NEW names are green, UPDATE names yellow, until opened. -
Open Opens the selected tool or panel -
Add to favorites / Remove from favorites Stars or unstars the selected entry -
Update the Favorites list now Reloads the menu so new favorites appear -
Clear all favorites Removes every favorite, after a question -
Clear the NEW and UPDATE tags (mark everything as seen) Hides every NEW and UPDATE tag -
Show NEW and UPDATE tags on tools and panels from recent updates kgxat_new_badges on

Click a result to see what it does. Double-click it, or press Enter in the search box, to open it.

Inside panels and tool windows (v3.6.21.2), a single setting added in a recent update has a green name and one changed in a recent update a yellow name, until you move the mouse over it once (its tooltip says NEW or UPDATED in this update). Clear the NEW and UPDATE tags clears these too; kgxat_new_badges 0 turns them off.

How to use it

Install the toolbox
  1. On your own game, subscribe to the toolbox on the Steam Workshop (item 3817351592).
  2. On a dedicated server, extract the kgx_admin_toolbox folder into GarrysMod/garrysmod/addons/.
  3. Restart the server. Clients download the Lua automatically.
  4. Join and open the Q menu. Check that the KGX's Admin Toolbox tab shows the version you installed.
Let VIPs use a tool
  1. Open Q menu > KGX's Admin Toolbox > Settings > Player Access as a superadmin.
  2. In Applies to, pick Rank: vip (use Refresh rank list if it is missing).
  3. Tick the tools and panels VIPs may use. Read any orange note under a tick first.
  4. Players of that rank can now use those tools. Admins keep full access.
Add a tool to your favorites
  1. Right-click any entry in the Q menu tool list, on any tab.
  2. Pick Add to favorites. A star marks the entry.
  3. Close the Q menu. The favorite now appears under the Favorites category.
  4. To remove it, right-click it again and pick Remove from favorites.

The right-click menu also has Open. An entry that already had its own right-click menu keeps it under More....

Read the in-game README
  1. Open Q menu > KGX's Admin Toolbox > Settings > Patch Notes & README.
  2. Click Patch notes for what changed in each version, or README (everything) for every tool, setting and test.
  3. Use the Search box on the left of the window to filter the sections.

Settings and commands

Server settings (Settings > Server Settings, superadmins):

Setting What it does Default Range
kgxat_superadmin_only 1 = only superadmins can use the toolbox 0 0-1
kgxat_immunity 1 = admins cannot target superadmins; non-admins are never targeted above their rank 1 0-1
kgxat_immunity_same 1 = players of the same rank may target each other 1 0-1
kgxat_superadmin_override 1 = superadmins skip immunity, click-twice confirmations, protected things, pocket lists and limits 0 0-1
kgxat_notify_admins 1 = every toolbox action is shown to all admins in chat 1 0-1
kgxat_notify_target 1 = players are told when a toolbox action is used on them 1 0-1
kgxat_log_file 1 = also write every action to data/kgx_admin_toolbox/logs/ (one file per day) 1 0-1
kgxat_credit_message 1 = players see the toolbox version in chat when their game has loaded 1 0-1

Client settings and commands:

Command What it does
kgxat_tool_tips 1 = hovering a tool in the tool list shows what it does (Settings > Display (themes)); default 1
kgxat_new_badges 1 = NEW tags on recently added tools and panels and UPDATE tags on recently changed ones; default 1
kgxat_readme Opens the README window
kgxat_patchnotes Opens the patch notes window

Tips and limits

  • Server data is saved in garrysmod/data/kgx_admin_toolbox/ on the server. Back it up from Settings > Backup / Restore.
  • A data file that cannot be read is moved to _broken/, and the last good copy in _bak/ is used instead.
  • Favorites and seen NEW / UPDATE tags are saved on your own computer, in data/kgx_admin_toolbox/favorites.json and seen_new.json.
  • New favorites show in the Favorites category only after you close the Q menu or click Update the Favorites list now.
  • A favorite panel that no longer exists shows "This panel is not available any more. Remove it with Find a tool."
  • Every action is always written to the server console and log as [KGX's Admin Toolbox] Name [SteamID] action target [SteamID].
  • Every tool panel with sliders or values has a Reset to defaults button.

Back to Basics

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