Tutorial / Settings
Patch Notes & README
Read the patch notes and the full README in game, and set up the hover preview and the map prop scanner.
What it does
Patch Notes & README opens the toolbox's documentation in game. Patch notes shows what changed in each version. README (everything) shows every tool, setting and test, split into sections with a search box.
The page also holds two list helpers. The hover preview shows a model, weapon, entity, NPC or vehicle at the cursor when you hover it in a list or the spawn menu. The map prop scanner lists every model the current map uses.
Where to find it
Q menu > KGX's Admin Toolbox > Settings > Patch Notes & README.
Everyone can open it. The options here are your own client settings.
Console: kgxat_patchnotes opens the patch notes, kgxat_readme opens the README.
The panel
The top line shows the toolbox name and version.
| Option | What it does | Default |
|---|---|---|
| Patch notes | Opens the window with only the version change sections. | - |
| README (everything) | Opens the window with every section. | - |
Lists
| Option | What it does | Default |
|---|---|---|
| Hover preview line | v3.6.17: the hover preview switch and its scan moved to Settings > Display (themes); its on/off key is in Settings > Keybinds (F7 recommended). | - |
| Map props of this map (scanner) | Opens the map prop scanner. | - |
The README window
The left side has a Search box and a list of sections. The right side shows the selected section.
- Each section is one
##heading of the README. The text before the first heading is "Introduction". - Typing in Search keeps only sections whose title or text contains the words.
- The patch notes window only lists sections whose title ends with "changes", such as "v3.5.29 changes".
- Bold lines and headings are shown in orange, numbered lines (the tests) in green.
How to use it
Read what changed in this version
- Open Settings > Patch Notes & README.
- Press Patch notes. The newest change sections are listed on the left.
- Click a section to read it.
Look up a setting or command
- Press README (everything).
- Type the name in Search, for example
kgxat_ac. - Click each section that is left to find the details.
Find a model the map already uses
- Press Map props of this map (scanner).
- Type words of the model name in the filter. Several words match any of them.
- Hover a row to preview the model.
- Select one or more rows and press Copy the selected to copy their paths.
Settings and commands
| Setting or command | What it does | Default |
|---|---|---|
kgxat_readme |
Opens the README window. | - |
kgxat_patchnotes |
Opens the patch notes window. | - |
kgxat_preview_scan |
Runs the hover preview scan. | - |
Tips and limits
- If the server does not have
lua/kgx_admin_toolbox/docs/, the window says "The README is not on this server". - The map prop scanner lists static props read from the map's
.bspfile and models of map entities. Scan again reads them again. - Tools with a model choice have their own Scan map props (pick one the map uses) button. There, the scanner button reads Use the selected and sets the tool's model.
- The hover preview also works in other addons' lists and spawn menu icons. Things without a model show their icon instead.