Help
Help and tutorials.
A tutorial for every tool, setting and panel, admin ones included, and where to go when something goes wrong.
New here? Start with Getting Started. Pick a category, or search every tutorial at once.
8 guidesBasics Start here: installing, who can use what, the keys and menus, the C menu, every chat and console command, match stats and progression, the Phone Book, and the KGX menu.OPEN95 toolsTools Every tool in the Q menu, by its category: what it does, its controls and options, and how to use it.OPEN45 panelsSettings Every panel under Settings: server options, permissions, ranks, limits, jobs, economy and more.OPEN32 panelsAdmin panels The other panels: Player Manager, bans, logs, reports, game modes, events, voting, AI and storage.OPEN
Help inside the game
The README and the patch notes ship with the addon: Q menu > KGX’s Admin Toolbox > Settings > Patch Notes & README, or the console commands kgxat_readme and kgxat_patchnotes.
KGX Core
The shared library the KGX addons run on, and its API for addon developers: KGX Core (v1.3.3).
Ask or report
Found a bug? Report it on GitHub (a short form: version, gamemode, what happened). Questions: the FAQ, or a comment on the Steam Workshop page with your toolbox version.
Getting StartedGuideInstall KGX's Admin Toolbox, find its Q menu tab, learn who counts as an admin, and give players tools.Basics / GuideTutorial Keys and MenusGuideEvery key and menu the toolbox adds for players: backpack, third person, voice wheel, F3 hub, F4 jobs, Alt + E and more.Basics / GuideTutorial C Menu and the ATB WindowGuideHold C for the ATB window of quick admin functions, and right-click anything in the C menu for the toolbox's ATB options.Basics / GuideTutorial Chat CommandsGuideEvery chat command the toolbox adds, for players and for admins, with what each does and who can use it.Basics / GuideTutorial Console CommandsGuideEvery kgxat_ console command in the toolbox, grouped by who can run it, with what each one does.Basics / GuideTutorial Match Stats and ProgressionGuideXP, levels, achievements, leaderboards, the match history and the name colors, badges and trails you unlock by playing Game Modes matches.Basics / GuideTutorial Phone BookGuideCall and text other players, keep buddies, and talk in groups with their own chat and voice channel.Basics / GuideTutorial KGX MenuGuideThe toolbox's page under Q menu > Utilities > KGX, and with KGX Core 1.3.3 one theme and one translation editor for every KGX addon.Basics / GuideTutorial AI PathsToolGive one NPC its own path, with things to do at points.Tools / AITutorial CommanderToolSelect NPCs and order them around: move, attack, follow, hold, wander.Tools / AITutorial NPC EditorToolEdit everything about an NPC on one page: loadout, model, look, combat, death & loot, type options and AI.Tools / AITutorial NPC RelationshipsToolMake NPCs friendly, hostile, neutral or afraid toward players, and save rules for this map.Tools / AITutorial Patrol & GuardToolMake patrol routes and guard posts and give NPCs to them.Tools / AITutorial ReanimateToolBring dead NPCs back: they follow you and take orders.Tools / AITutorial AlignToolCopy rotation and/or position lines from a reference prop.Tools / BuildingTutorial BillboardToolBig boards with a title and text, saved for this map (at most 10).Tools / BuildingTutorial Bulk ConstraintsToolWeld or no-collide every prop in an area at once, or clear them.Tools / BuildingTutorial ButtonToolButtons that open and close linked doors.Tools / BuildingTutorial CamerasToolPlace cameras and TVs that show them; watch them in an on-screen viewport.Tools / BuildingTutorial Create ChairsToolMake seats on anything, draw rows of seats, seat talking NPCs.Tools / BuildingTutorial Door MakerToolTurn any prop into a sliding, hinged or phasing door.Tools / BuildingTutorial Eye ScannerToolEye scanners that open linked doors for the players, jobs and ranks you pick.Tools / BuildingTutorial KeypadToolCode-locked keypads that open linked doors.Tools / BuildingTutorial LightsToolGlowing shapes in any size and color that light the world. Move them with the physgun.Tools / BuildingTutorial Media PlayerToolScreens that play YouTube, videos and web pages; others tune in to their channel.Tools / BuildingTutorial MirrorToolMake mirrored copies of props across a plane.Tools / BuildingTutorial Mover / ElevatorToolMake a prop move between two points: elevators, lifts, sliding platforms. Players standing on it ride along.Tools / BuildingTutorial Precision MoveToolMove props in exact steps along one direction.Tools / BuildingTutorial Precision RotateToolRotate props in exact steps around their center.Tools / BuildingTutorial PrefabsToolCopy builds (with welds), paste them anywhere, save them by name.Tools / BuildingTutorial Prop ResetToolStraighten props, snap angles, or snap position to a grid.Tools / BuildingTutorial Prop ScaleToolResize props, including their collisions.Tools / BuildingTutorial RadioToolRadios that play streams, YouTube and Spotify; others tune in.Tools / BuildingTutorial SignToolFloating text signs, saved for this map.Tools / BuildingTutorial StackerToolStack frozen copies of a prop in any direction.Tools / BuildingTutorial TeleportersToolPads or zones that teleport players who walk into them.Tools / BuildingTutorial CloakToolMake players invisible and ignored by NPCs.Tools / CheatsTutorial Give WeaponToolGive or take any weapon.Tools / CheatsTutorial God ModeToolMake players invulnerable.Tools / CheatsTutorial Health & ArmorToolSet health and armor on players, NPCs and entities with health.Tools / CheatsTutorial Infinite AmmoToolKeep a player's magazine and reserve ammo full.Tools / CheatsTutorial MovementToolChange walk speed, run speed, jump power and gravity.Tools / CheatsTutorial NoclipToolLet players fly through walls, even where noclip is disabled.Tools / CheatsTutorial Player ModelToolChange any player's model.Tools / CheatsTutorial Player SizeToolShrink or grow players, including their collisions and eye height.Tools / CheatsTutorial Refill AmmoToolGive players reserve ammo for every weapon they carry.Tools / CheatsTutorial ReviveToolBring dead players back where they died, with their weapons.Tools / CheatsTutorial MoneyToolGive or take money, check balances, or drop cash.Tools / EconomyTutorial Money GeneratorToolMake the aimed thing a money source: it fills up with money and can be robbed.Tools / EconomyTutorial Money PrinterToolMake money printers and upgrades, set the printer that is sold, and look after every printer.Tools / EconomyTutorial Store MakerToolTurn NPCs and props into stores, banks or ATMs, or place new ones (with a preset).Tools / EconomyTutorial Treasury NodeToolPlace the server treasury in the world: robbing it takes treasury money.Tools / EconomyTutorial Vehicle PadToolPads that give players a vehicle, free or for a price. Players press E on the pad.Tools / EconomyTutorial ExplosionToolSet off explosions with adjustable type, radius and damage.Tools / FunTutorial FireworksToolRockets that burst into colors, spark fountains and firework shows. They hurt nobody.Tools / FunTutorial LaunchToolFling players, NPCs and props.Tools / FunTutorial Player EffectsToolGive players a trail, a glow or sparkles.Tools / FunTutorial RagdollToolTurn players into ragdolls; they get back up where the ragdoll lies.Tools / FunTutorial RocketToolSend players and props up with a smoke trail, then blow them up.Tools / FunTutorial SmiteToolStrike players, NPCs, props or the ground with lightning.Tools / FunTutorial Admin RemoverToolRemove anything the right way: props, NPCs, vehicles, map props, permanent things and every toolbox thing.Tools / FunctionsTutorial FreezeToolFreeze anything: players, props, vehicles, NPCs, doors and every toolbox thing.Tools / FunctionsTutorial JailToolLock players in a cell where they stand, or take them to a jail location.Tools / FunctionsTutorial KeysToolLock and unlock any door, and set who owns a door and who has keys.Tools / FunctionsTutorial ModerationToolSlay, kick, strip, respawn, ignite, extinguish, slap, blind or break.Tools / FunctionsTutorial RanksToolMake ranks, give them to players and set the rank of new players and the auto-rank hours.Tools / FunctionsTutorial SpectateToolWatch a player with a following camera.Tools / FunctionsTutorial TeleportToolMove players and entities anywhere.Tools / FunctionsTutorial Vehicle ControlToolLock, unlock, eject, flip and enter vehicles and seats.Tools / FunctionsTutorial Warp PointsToolNamed teleport spots, saved per map.Tools / FunctionsTutorial AppearanceToolChange color, transparency and material of any entity or player.Tools / PropertiesTutorial Better FreezeToolReally freeze anything: nothing moves or breaks it (not players or NPCs).Tools / PropertiesTutorial DecalsToolBlood, scorch marks, paint splats, graffiti and any decal material; size and color.Tools / PropertiesTutorial Entity PropertiesToolChange mass, gravity and collisions on any entity.Tools / PropertiesTutorial InspectorToolShow details about players and entities.Tools / PropertiesTutorial OwnershipToolTransfer props to another player (needs prop protection with CPPI).Tools / PropertiesTutorial Paint BrushToolHold the mouse to paint color and/or material onto props under the brush.Tools / PropertiesTutorial Physgun BlockToolBlock the physics gun on anything, map props too: for everyone, players only, admins only or certain ranks. Saved for the map.Tools / PropertiesTutorial Spray PaintToolPaint on walls and floors; everyone sees it.Tools / PropertiesTutorial UnbreakableToolMake props, doors, NPCs and vehicles immune to damage; saved for the map.Tools / PropertiesTutorial Area CleanupToolRemove props, ragdolls, NPCs and dropped weapons in an area.Tools / UtilitiesTutorial Test DummyToolSpawn a test dummy that counts as a player: T-pose or A-pose, follow, wander, take damage with damage numbers, die, respawn, explode.Tools / UtilitiesTutorial Buy StationsToolWall weapons, a mystery box, perk machines, door buys and switches for Waves (PVE) matches.Tools / WorldTutorial Create BuffsToolFood, drink, poison and status effects from props, items, stores, zones and scripts.Tools / WorldTutorial Create StorageToolTurn props into storage or loot containers (crates, lockers, cabinets).Tools / WorldTutorial Generate LootToolLoot containers or item spawners all over the map (nav mesh).Tools / WorldTutorial Generate Map PropsToolProps all over the map (nav mesh): junk, crates, street things, debris...Tools / WorldTutorial Item SpawnerToolPlace markers that keep a weapon, ammo, health kit or any entity in place and bring it back after it is picked up.Tools / WorldTutorial LogicToolTriggers and logic for RP and PVP: buttons, switches, plates, trigger boxes, timers, counters, gates... wired to doors, messages, sounds, teleports, spawners and each other.Tools / WorldTutorial Make TrashcanToolPlace a trashcan, or make any prop one: players throw things away in it.Tools / WorldTutorial Map GateToolGates that take players to another map (or another server).Tools / WorldTutorial Mode SpotsToolTeam spawns, lobby and spectator spots for Game Modes matches, per mode and map.Tools / WorldTutorial NotesToolAdmin notes on any surface (kept for the map); remove anyone's note.Tools / WorldTutorial NPC SpawnerToolPlace markers that keep spawning any NPC: how many, how often, weapon and faction. Saved for this map.Tools / WorldTutorial Permanent EntitiesToolMake anything permanent (props, ragdolls, NPCs and animals, vehicles, weapons, addon entities): saved with the map, back after every cleanup and restart.Tools / WorldTutorial Phone BoothToolPhone booths: E opens the phone book (no Phone License needed). A pay phone or an invisible node.Tools / WorldTutorial PropertyToolGroup doors into houses, shops or offices that players buy or rent.Tools / WorldTutorial Remove Map PropsToolRemove the props that came with the map (not doors), one or all of them.Tools / WorldTutorial SoundsToolSound emitters: a sound at a spot, on a loop, now and then, or when logic plays it. Pick from every sound of the mounted games.Tools / WorldTutorial Spawn PointsToolCustom player spawn locations, saved for this map.Tools / WorldTutorial Storage VaultToolServer vaults: everyone opens their own personal vault at them.Tools / WorldTutorial Talking NPCToolCharacters that talk to players: pages of text and choices that can warp, give items, money or a job.Tools / WorldTutorial ZonesToolSafe, heal, no-build, spawn, hurt, instakill, forcefield (factions, props, bullets) and sound/music areas: preset shapes or drawn with nodes, saved for this map.Tools / WorldTutorial Anti-CheatPanelServer-side checks for speed, flying, noclip, teleports, aim snaps and net spam, with strikes, a live list, scans and optional kicks.Settings / SettingsTutorial ArmoryPanelWeapons and perks players build custom classes from, unlocked for free, by level or with match credits earned in Game Modes matches.Settings / SettingsTutorial Backpack & StoragePanelSet up every player's backpack, the hotbar, Hands and storage containers: slots, what fits, and what happens on death.Settings / SettingsTutorial Backup / RestorePanelSave every toolbox setting and data file in one backup, restore it later, and move backups between servers.Settings / SettingsTutorial Carrying (E & Hands)PanelLet players hold E to carry props and shipments, and set how heavy things may be with and without Hands.Settings / SettingsTutorial Chat Tags & TitlesPanelGive each rank a chat tag and name color, such as [VIP] in gold, and show player titles or rank tags above heads.Settings / SettingsTutorial Citizen LooksPanelChoose the models citizens wear and let new players pick their own look and player and weapon colors.Settings / SettingsTutorial DebugPanelDebug options for every toolbox tool: an overlay, aim drawing, call times and errors, a debug console, net counts and a debug report.Settings / SettingsTutorial Discord LogsPanelPost toolbox logs (bans, kicks, warnings, jails, reports and more) to a Discord channel through a webhook.Settings / SettingsTutorial Display (themes)PanelYour dark mode, theme, language and tool tips. With KGX Core 1.3.3 the theme and dark menus are set for every KGX addon on the KGX Core page.Settings / SettingsTutorial DrugsPanelMake and edit RP drugs: what each one does to health, speed, jumps and damage, and the high's screen effect.Settings / SettingsTutorial EconomyPanelServer money settings: economy on/off, currency, cents, starting money, bank interest, cash dropping, player store limits and money lost on death.Settings / SettingsTutorial Furniture & BuffsPanelServer settings for trashcans, chairs players buy in stores, and buffs such as food, drink, poison and status effects.Settings / SettingsTutorial GameplayPanelPick the server mode (Sandbox, Build / PvP or RP) and set the RP rules, movement, poop by a timer, citizens, Build/PvP, anti prop-kill and death screen.Settings / SettingsTutorial HUD & HubPanelSet up the toolbox HUD, the header bar, look-at details and the F3 server hub, with text tokens and presets.Settings / SettingsTutorial JobsPanelMake the jobs players pick in RP mode: pay, model, weapons, slots, ranks, abilities, staff jobs, licenses and elected jobs.Settings / SettingsTutorial Join Whitelist / BlacklistPanelControl who may join the server: a blacklist of SteamIDs that can never join, and an optional whitelist that only lets listed players in.Settings / SettingsTutorial KeybindsPanelSet every toolbox key in one place: backpack, third person, cameras, Admin Vision, dark mode and four quick tool keys.Settings / SettingsTutorial LicensesPanelSet the license rules (property, guns, driving, jobs), pick the Tool License's tools, and make your own custom licenses.Settings / SettingsTutorial LightsPanelSafety limits for lights (size, brightness, reach, flashing, how many light the world) and each player's own view.Settings / SettingsTutorial LimitsPanelSet how many toolbox things each player may have at once, and cap how strong a limited player's tools can be.Settings / SettingsTutorial Lockpick & HackingPanelSet how long the Lockpick and Keypad Hacker take, how often they work, which doors and keypads they open, and who may use them.Settings / SettingsTutorial Mayor & LawsPanelThe Mayor's commands: laws and the law board, lockdowns, wanted players and search warrants; the server's own laws.Settings / SettingsTutorial Money PrintersPanelServer settings for money printers: print amount and speed, wear, upgrade tiers, the Repair Tool, the Printer Hacker and black market prices.Settings / SettingsTutorial Paint, Notes & MailPanelServer settings for the Spray Paint and Sponge, notes players stick on walls, and the player mail system.Settings / SettingsTutorial Patch Notes & READMEPanelRead the patch notes and the full README in game, and set up the hover preview and the map prop scanner.Settings / SettingsTutorial PaychecksPanelPay online players every few minutes: interval, normal amount, amounts per rank, who gets paid, and a Pay everyone now button.Settings / SettingsTutorial Permission ReportPanelWhat every rank can really do with the toolbox, where each grant comes from, warnings for risky grants, and the server owners.Settings / SettingsTutorial Phone BookPanelPhone Book settings: the Phone License, voice calls, costs, ring time, groups; admins open every group and call.Settings / SettingsTutorial Player AccessPanelPick which toolbox tools and panels non-admin players may use, for all players or for one rank such as VIP.Settings / SettingsTutorial Player LoadoutsPanelDecide what players spawn with outside RP mode: weapons, ammo, model, health, armor, speeds, gravity and size, per rank.Settings / SettingsTutorial Playtime & Auto-RanksPanelCount every player's playtime, promote players to ranks after a number of hours, and see the 100 most-played players.Settings / SettingsTutorial PocketsPanelSet how many things fit in every player's Pockets, how heavy and big they may be, and which things always or never fit.Settings / SettingsTutorial Police & CrimePanelServer settings for the police batons, handcuffs, security cameras, pickpocketing, the Door Explosive, Poop and cigarettes.Settings / SettingsTutorial RobberyPanelServer rules for robbing money sources: robbing on/off, police and admin alerts, the robbery marker, minimum police online and signs.Settings / SettingsTutorial SchedulerPanelRun announcements, chat messages, console commands, cleanups, backups and map restarts every N minutes or at a time of day.Settings / SettingsTutorial Server SettingsPanelThe toolbox's main server options: who may use it, immunity, logging, spawn rules, cooldowns, AFK, daily restart, incognito and resets.Settings / SettingsTutorial Setup WizardPanelSet the toolbox up for your kind of server (Sandbox, Build / PvP, RP, Arena PVP, Survival PVE) in one step, with every change shown first and a backup made.Settings / SettingsTutorial ShipmentsPanelSet up shipments that store-owner jobs buy in the F3 hub and resell, plus the store types that decide which job sells what.Settings / SettingsTutorial Spawn WhitelistPanelPlayers spawn from the spawn menu only what is on the list: single items, whole folders or categories, whole games, for everyone or chosen ranks and jobs.Settings / SettingsTutorial Taxes & TreasuryPanelIncome tax on paychecks, sales tax on store and shipment prices, transfer fees and property tax, collected into a server treasury that admins and Treasury jobs (a Mayor) pay players out of.Settings / SettingsTutorial Tool VisibilityPanelHide toolbox tools, panels and C menu entries, or show them only to chosen ranks, jobs or license holders.Settings / SettingsTutorial TranslationsPanelThe toolbox's player screens in six languages (English, Español, Deutsch, Français, Русский, Português (Brasil)); the server's default language, each player's own pick, and the owner's edits.Settings / SettingsTutorial Voice LinesPanelLet players say voice lines from a wheel, make your own voice line sets, and give sets to jobs or everyone.Settings / SettingsTutorial Warning LadderPanelAutomatic punishments (gag, mute, jail, kick or ban) when a player reaches a set number of warnings.Settings / SettingsTutorial AI BrainPanelServer-wide settings for smarter NPCs: nav mesh walking, fleeing, calling for help, hearing gunfire, doors, pickups, surrender, jobs and the look-at card.Admin panels / AITutorial NPC AIPanelSee every NPC on the map, switch NPC AI on or off, edit, heal, freeze or remove NPCs, and set profiles for NPC tags.Admin panels / AITutorial EconomyPanelThe live money overview: every player's wallet and bank, give/take/set money, and every store, bank and ATM on the map.Admin panels / EconomyTutorial Action LogPanelRead the most recent toolbox actions, newest first, with a filter box. Full daily log files are kept on the server.Admin panels / UtilitiesTutorial Admin NotesPanelKeep private staff notes about players by SteamID, also for players who left, and see them when that player joins.Admin panels / UtilitiesTutorial Admin VisionPanelSee players, NPCs, vehicles, props, weapons and entities through walls with outlines and labels, plus every zone, spawn point and spawner.Admin panels / UtilitiesTutorial AnnouncementsPanelShow a large message in the middle of every player's screen, or privately on one player's screen.Admin panels / UtilitiesTutorial Auto MessagesPanelPost your own chat messages one after another every few minutes, such as rules reminders, a Discord link or tips.Admin panels / UtilitiesTutorial BansPanelSee every ban made with the toolbox, unban players, and ban any SteamID, including players who are offline.Admin panels / UtilitiesTutorial CamerasPanelWatch placed security cameras in a live viewport on your screen, switch between them, and turn them with the remote control.Admin panels / UtilitiesTutorial Chat FilterPanelBlock words and phrases in player chat: star them out or drop the whole message, with optional automatic warnings.Admin panels / UtilitiesTutorial Damage LogPanelSee who hurt or killed whom, with which weapon, how much damage and from how far, and review any recent kill.Admin panels / UtilitiesTutorial Day/Night & WeatherPanelRun a day and night cycle with weather for everyone, set the time and weather, and choose your own rain, sound and clock options.Admin panels / UtilitiesTutorial DiagnosticsPanelFind problems with other addons, the server and the toolbox: a compatibility scan, a list of toolbox things on the map, and a player scan.Admin panels / UtilitiesTutorial EntitiesPanelCount every entity on the server by class and by owner, and freeze or remove them in bulk.Admin panels / UtilitiesTutorial Event CountdownPanelShow a big countdown timer with your own title at the top of every player's screen, for events, restarts or rounds.Admin panels / UtilitiesTutorial EventsPanelSplit players into colored teams, send them to an arena or lobby warp, and run last one standing rounds.Admin panels / UtilitiesTutorial Game ModesPanelRun matches with teams, roles, rounds and win rules: 21 built-in modes from Team Deathmatch to Gun Game, Race, Prop Hunt and Survival (PVE waves), plus your own.Admin panels / UtilitiesTutorial MapsPanelSearch the maps installed on the server and change or restart the map after a countdown that warns every player.Admin panels / UtilitiesTutorial Media & RadioPanelSet your own volume for screens and radios, mute or hide them, and (superadmins) set Internet to Full or Restricted, control what screens and radios may play, and set up the TV Remote.Admin panels / UtilitiesTutorial Money LogPanelEvery wallet and bank change with where the money came from, a per-player day summary that makes dupes stand out, money alerts, and rollbacks that undo changes or put a player's money back to a time.Admin panels / UtilitiesTutorial PerformancePanelLive server load (FPS, entities, moving props, memory) and the players who own the most props, with freeze and remove actions.Admin panels / UtilitiesTutorial Player ManagerPanelA live list of every player with a right-click menu of all toolbox actions: teleport, freeze, jail, gag, warn, kick, ban and more.Admin panels / UtilitiesTutorial Prop ProtectionPanelBuilt-in prop protection so players cannot move or tool each other's props, plus your buddy list and a cleanup button.Admin panels / UtilitiesTutorial ReportsPanelRead and handle player reports sent with !report: go to the reporter, review their last death, start a sit, resolve or delete.Admin panels / UtilitiesTutorial RulesPanelWrite the server rules players read with !rules, show them on join or to everyone, and place rules signs in the world.Admin panels / UtilitiesTutorial Server ToolsPanelOne-click map-wide actions: clean up the map, freeze props, remove NPCs, bring or freeze all players, lock the server, and set time scale and gravity.Admin panels / UtilitiesTutorial Sit RoomPanelTake players aside to talk in a sit room, then send everyone back to where they were.Admin panels / UtilitiesTutorial Third PersonPanelToggle an over-the-shoulder third person camera with a key, hold the key to look all around yourself, and set its distance, offsets, aiming dot and use in seats.Admin panels / UtilitiesTutorial VotingPanelStart polls, map votes and server mode votes, manage the map pool, and set rock the vote, nominations, kick and mute votes and elections.Admin panels / UtilitiesTutorial Loot TablesPanelMake the weighted lists of weapons, ammo, items and money that loot containers fill themselves from, shared by every map.Admin panels / WorldTutorial StoragePanelList every storage and loot container on the map to edit, visit, refill, empty, move or remove it.Admin panels / WorldTutorial
No matching tutorials.
Try another name or word.