KGX Core is the framework every KGX mod runs on. These guides cover installing KGX mods, the KGX Settings window, themes, the HUD tracker and the admin tools.
Get KGX mods running in single-player or on a server.
Download KGX Core (7DTD) and the KGX mods you want from Nexus Mods.
Open your game folder (Steam: right-click 7 Days to Die, Manage, Browse local files) and open the Mods folder. Create it if it is not there.
Extract each zip into Mods, so you get Mods\0_KGX_Core, Mods\KGX_ContractBoard and so on. Each mod is its own folder.
Start 7 Days to Die with EasyAntiCheat off (KGX mods are DLL mods and do not load with it on).
Load a world, press F1 and type kgx mods. Every KGX mod should be listed as running, with its version.
Multiplayer: put the same folders in the server's Mods folder and in every player's game. Use the same Core version everywhere.
Tip: A player whose KGX mods do not match the server is not kicked: the mismatched mods are switched off for that player. kgx mods shows why.
Tutorial 02
Use the KGX Settings window
One window with the settings of every KGX mod.
Press F2 in game (or type kgxc settings in the console).
Pick a mod. You see its server settings (only admins can change them) and your personal settings (stored on your PC).
Hover over any setting or button to read what it does.
Type a value and press Enter or Apply; < and > step through on/off and choice settings. Server settings are saved in the world's save folder, under KGX\config.
Each mod also has an on/off switch: it turns the mod off for this world from the next load and keeps its data.
Tip: Want a different key? Change settingsHotkey under KGX Core in the same window.
Tutorial 03
Change the colour theme
Give every KGX window the look you like.
Open the KGX Settings window (F2) and pick KGX Core.
Set uiTheme to KGX, Midnight, Forest, Desert, Steel or High Contrast. Every KGX window changes at once.
For your own colours, change any of themeBackground, themePanel, themeText, themeAccent, themeTooltipBackground or themeTooltipBorder. Each steps through a 20-colour palette and the theme switches to Custom.
Tip: The theme is personal: other players keep their own.
Tutorial 04
Use the HUD tracker and toasts
See your contracts and other KGX information on screen while you play.
KGX mods show short messages (toasts) on screen, for example when a contract is complete or a sale was made.
The HUD tracker shows one section per mod, for example your active contracts.
Press F5 to open the tracker or keep it open. When nothing changes it shrinks to a small tab after 15 seconds.
In the KGX Settings window, under KGX Core: trackerPosition moves it to the top left or the right, trackerMinimizeSeconds sets when it shrinks (0 = always open) and trackerHotkey changes the key.
Tutorial 05
Server admin: settings, permissions and mods
Change server settings and who may use admin commands.
Admins are players with permission level 0 in serveradmin.xml (in single-player you are always admin).
kgx config lists every mod's server settings; kgx config trade feePercent 5 changes one; kgx config trade feePercent default resets it.
kgx perms lists the permission nodes of every mod (for example trade.admin). kgx perms set trade.admin 1 lets level 1 use Trade Post admin commands; kgx perms reset trade.admin undoes it.
kgx disable <mod> and kgx enable <mod> switch a KGX mod off or on for this world from the next load. Its data is kept.
kgx help lists every KGX command; kgx <mod> help the commands of one mod, for example kgx bank help.
Tutorial 06
When something does not work
Find out what is wrong before you report it.
Type kgx mods: a mod that is not running shows the reason (for example it needs a newer KGX Core).
Type kgx core version to see the Core version, the game build and the run mode.
In multiplayer type kgx net (server) or kgxc net (player) to see the connection between the KGX mods.
As an admin, kgx diag file writes a report to %AppData%\7DaysToDie\KGX\diag.txt.
Report the problem in the Posts tab of the mod on Nexus Mods, with the report and your Player.log (in %AppData%\..\LocalLow\The Fun Pimps\7 Days To Die).
Tip: Most problems are a missing or different KGX Core version, or EasyAntiCheat left on.