Tutorial / Settings

Server Settings

The toolbox's main server options: who may use it, immunity, logging, spawn rules, cooldowns, AFK, daily restart, incognito and resets.

What it does

Server Settings holds the toolbox's main server-wide options. Every checkbox and slider here sets a server convar, so the change applies to all players and is kept after a restart.

The top of the panel shows the toolbox version. It also says how admin access works: with an admin mod installed, the toolbox uses the CAMI privilege "KGX Admin Toolbox"; without one, it uses the admin and superadmin ranks. Every action is written to the server console.

It also has the incognito buttons, a scan-and-update button, the ATB item pictures and the full reset window.

Where to find it

Q menu > KGX's Admin Toolbox > Settings > Server Settings.

Only superadmins can change these settings. Everyone else sees the controls greyed out, with the line "Only superadmins can change these settings."

The panel

On/off settings

Each checkbox applies as soon as you tick or untick it.

Option What it does / convar Default
Superadmins only Only superadmins can use the toolbox. kgxat_superadmin_only Off
Rank immunity (admins cannot target superadmins; with an admin mod, no rank targets a higher one) Protects higher ranks from lower ones. kgxat_immunity On
With rank immunity: players of the same rank may target each other Off: same-rank players cannot target each other. kgxat_immunity_same On
Superadmin override: superadmins skip the toolbox's safety checks (immunity, click-twice confirmations, protected things, pocket lists) Also skips limits. Never while incognito. kgxat_superadmin_override Off
Show every action to admins in chat kgxat_notify_admins On
Tell players when a tool is used on them kgxat_notify_target On
Write the action log to data/kgx_admin_toolbox/logs/ One file per day. kgxat_log_file On
Use custom spawn points (World > Spawn Points) Used only if any exist. kgxat_custom_spawns On
Admins can pick up players with the physgun kgxat_physgun_players Off
Every player can use third person (off = admins only) Utilities > Third Person. kgxat_thirdperson_all On
Third person also works while sitting in seats and chairs Cars keep their own view. kgxat_thirdperson_seats On
Block the spawn menu (Q) and spawning for non-admins Also refuses their props, entities, NPCs, vehicles and weapons. kgxat_block_spawnmenu Off
Blocked players also lose the context menu (C) kgxat_block_contextmenu Off
Players see the ATB spawn menu tab and ATB weapons (off = admins only) kgxat_atb_menu_players On
Tool cooldown applies to every tool (not just the toolbox) kgxat_tool_cooldown_all Off
Kick non-admins once they are AFK kgxat_afk_kick Off
Players sitting in a chair are not kicked for AFK Still marked AFK; for at most the minutes below. kgxat_afk_seats (v3.6.11.3) Off
Any seat or vehicle counts Off: only toolbox chairs (Seats tool and bought chairs). kgxat_afk_seats_any Off
New players are frozen until they accept the rules (Utilities > Rules) Again after the rules change. kgxat_rules_accept Off
Admin chat commands (!bring, !goto, !freeze... type !help) Turn off if your admin mod has its own. kgxat_chat_commands On
Show the toolbox version and copyright in chat when a player's game loads Also in the server console on map load. kgxat_credit_message On
Incognito

Shown to superadmins, toolbox admins, and players who are incognito.

Option What it does
Go incognito (play as a normal player) Opens a window where you pick the name and model others see (or keep yours). Your rank becomes "user" for the session.
Leave incognito Gives your rank, name and model back. Enabled only while you are incognito.
Numbers

Move a slider (or click its number and type a value), then press the button below it. Values are kept inside each setting's range.

Option What it does / convar Default Slider range
Public warp cooldown (s) + Apply cooldown Seconds between public warps (!warp). kgxat_warp_cooldown 5 0-120
Kick at warnings (0 = off) + Apply warning kick kgxat_warn_kick 0 0-20
Spawn protection (s, 0 = off) + Apply spawn protection No damage after respawning; attacking ends it. kgxat_spawn_protect 0 0-30
Tool cooldown for players (s, 0 = off) + Apply tool cooldown for players For limited players, 0.1 s steps. kgxat_tool_cooldown 0 0-10
Mark AFK after (minutes, 0 = off) + Apply mark afk after No keys, mouse look or chat. kgxat_afk_minutes 0 0-120
Seated players kept from the AFK kick for at most (minutes, 0 = no limit) Counted from when they sat down; still idle after that, they are kicked. kgxat_afk_seat_minutes 60 0-1440
Daily map restart: hour, server time (-1 = off) + Apply daily map restart: hour, server time kgxat_restart_hour -1 -1-23
Daily map restart: minute + Apply daily map restart: minute kgxat_restart_minute 0 0-59
Remove a leaving player's props after (minutes, 0 = off) + Apply remove a leaving player's props after Rejoining cancels it. kgxat_dc_cleanup 0 0-120
Reset to defaults Puts every checkbox and slider above back to its default.
Scan & update
Option What it does
Scan & update everything (ranks, jobs, warps, world data, logic, sounds, NPCs, licenses, access) Sends every toolbox list again, rebuilds toolbox things from their saved data, and reapplies licenses and access rules. Nothing saved is changed. One notice lists what was updated.

Use it when a rank, job or anything else made with the toolbox does not show up in a list or picker.

ATB item pictures
Option What it does Default
Pictures of ATB weapons and entities ATB: the toolbox's own pictures, Custom: your pictures (materials/kgxat_custom/<class>.png) or None: a plain icon. kgxat_atb_icons 0 / 1 / 2. ATB
Copy the list of ATB class names Copies every ATB class name to your clipboard.
Reset everything / wipe map data... Opens the reset window: settings back to default and / or saved data deleted for a blank start (see below).

How to use it

Change an on/off setting
  1. Open Q menu > KGX's Admin Toolbox > Settings > Server Settings as a superadmin.
  2. Tick or untick the checkbox. It applies at once and is logged as an action.
Schedule a daily map restart
  1. Set Daily map restart: hour, server time (-1 = off) to the hour (server clock), then press its Apply button.
  2. Set Daily map restart: minute, then press its Apply button.
  3. Players are warned 10 and 5 minutes before, then the normal map change countdown runs.
Play as a normal player
  1. Press Go incognito (play as a normal player).
  2. Pick the name and model others see, or keep yours.
  3. To come back, press Leave incognito, type !unincognito, run kgxat_unincognito, or rejoin.
Use your own ATB item pictures
  1. Make a square PNG (128x128 or 512x512) for each item, named after its class, e.g. kgxat_lockpick.png. Use Copy the list of ATB class names for the names.
  2. Put them in an addon folder: garrysmod/addons/my_atb_icons/materials/kgxat_custom/.
  3. On a server, add that folder to the server's Workshop collection, or add resource.AddFile("materials/kgxat_custom/kgxat_lockpick.png") lines in a server Lua file.
  4. Pick Custom in Pictures of ATB weapons and entities. Items without a picture keep the toolbox's.

The reset window

Reset everything / wipe map data... opens a window for the server owner (superadmins when no owner is set). It cannot be undone except by restoring a backup.

  1. Press Make a backup now (it changes to "Backup saved (check Settings > Backup)"). The server also saves a backup automatically right before it resets or wipes.
  2. Tick what to reset: Server settings, limits and caps (every page under Settings), Player Access (untick everything for players and ranks), Paycheck amounts per rank, My tool settings and display options (on this computer). All four start ticked.
  3. v3.6.13.1: pick what saved data to delete under Also delete saved data (for a blank start):
Choice What is deleted
Nothing - keep all saved data Nothing (the default). Only the ticked settings are reset.
This map's world data (map name) On the current map: warps, zones, signs, spawn points, spawners, teleporters, stores, containers, permanent props, map doors, server keypads, buttons and cameras, chairs, logic, sounds, notes, decals, properties, NPC paths and relations, media screens, robbery spots, vault spots and buy stations (v3.6.17). Other maps, money, players' things and bans stay. Picking it unticks the settings ticks.
World data of every map The same, for every map that has toolbox data.
Everything the toolbox saved (like a fresh install) Every toolbox data file: all map data, money and bank, backpacks, vaults, pockets, stats, XP, licenses, mail, jobs, stores, loot tables, prefabs, rules, reports and the rest. Picking it ticks the settings ticks.
  • Keep ranks and staff (ticked; only for Everything): ranks given in the toolbox, staff ranks, the auto-rank ladder and incognito stay. The owner list is always kept.
  • Keep bans, warnings and the join whitelist (ticked; only for Everything).
  • Also delete logs (unticked): action, kill and money logs. Backups never hold logs, so they cannot be restored. 4. Type RESET (or WIPE when something is deleted) in the box, then press Reset to defaults (or Back up, wipe and restart the map).

With a wipe, nothing is saved again until the map restarts (10 seconds), so nothing still in memory writes the old data back; the map then loads blank. Backups and your own favorites are never deleted. With DarkRP, DarkRP's own money is not the toolbox's and stays. From the server console: kgxat_wipedata map / allmaps / everything confirm.

Without a wipe, never touched: warps, zones, spawn points, teleporters, stores, containers, loot tables, spawners, money, bans, warnings, reports, logs, prefabs, permanent props, rules, favorites and backups.

Settings and commands

Each option's convar is shown in its row above. Commands:

Command What it does
kgxat_incognito / !incognito Go incognito (opens the name and model window).
kgxat_unincognito / !unincognito Leave incognito. From the server console, add a name or SteamID.
kgxat_scanall Scan & update everything (superadmins).

Tips and limits

  • The console ranges of kgxat_warp_cooldown (0-600) and kgxat_warn_kick (0-50) are wider than the sliders.
  • Reset to defaults on the panel does not change the ATB picture setting. The reset window's "Server settings" option resets every toolbox server setting.
  • kgxat_pp and kgxat_pp_world appear in the panel's console list but are set in Utilities > Prop Protection.
  • Superadmin override never applies while you are incognito.
  • Superadmins are never spawn-menu blocked.

Back to Settings

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