Tutorial / Settings

Setup Wizard

Set 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.

What it does

The Setup Wizard (v3.6.18) sets the toolbox up for the kind of server you run. You pick one of five server types. The wizard then sets the server mode, Game Modes and their rotation, the spawn menu, the HUD & Hub, and safe Player Access tools for all players.

Nothing changes until you press Apply. Before that, the wizard lists every change it will make, with the value now and the value after. Apply makes a backup first, so Settings > Backup / Restore can put everything back.

You can run it again at any time, for example to switch a test server from Arena to Survival.

Where to find it

Q menu > KGX's Admin Toolbox > Settings > Setup Wizard, then Open the setup wizard. Console: kgxat_setup. v3.6.18.1: it is also in the owner's Favorites by default (once; if you remove it, it stays removed).

Only the server owner can run it (owners are set with kgxat_owner in the server console), or superadmins while no owner is set.

First start: on a new install (no toolbox data yet), the wizard opens by itself for the owner a few seconds after they join. Later (Settings > Setup Wizard) closes it for good. On a server that already used the toolbox, in single player, or with Open it for the owner on a new install off (kgxat_setup_prompt 0), the owner gets one chat line about the wizard instead.

The window

The top line says what the server looks like now (for example "Build / PvP", the default) and when the wizard last ran, and who ran it.

The server types
Type What it sets HUD & Hub Game Modes rotation Player Access (all players)
Sandbox Server mode Sandbox, no next match, spawn menu open Default setup (only if ticked) - Building tools for their own props
Build / PvP Server mode Build / PvP (players pick Build or PvP), no next match, spawn menu open Default setup (only if ticked) - Building tools for their own props
Roleplay (RP) Server mode RP, jobs, property and keys on, no next match, spawn menu open Default setup (only if ticked) - Doors, buttons, keypads, seats, signs, notes and cameras on their own props
Arena (PVP) Server mode Sandbox, Game Modes on, players vote on the next match, spawn menu blocked for players, Toolbox HUD always Built-in preset PVP (arena) Every mode but Waves None (players do not build)
Survival (PVE) Server mode Sandbox, Game Modes on, next match from the rotation, spawn menu blocked for players, Toolbox HUD always Built-in preset PVE (waves) Only Waves modes (Survival) None (players do not build)

The building tools only ever work on a player's own props (Settings > Player Access shows what each tool lets players do). The RP set leaves out Unbreakable, Hard Freeze, Scale, Mirror and Stack, so props cannot be made raid-proof or copied. Server setup tools (Mode Spots, Buy Stations, Generate Loot and the like) are never given to players.

Options
Option What it does Default
Server settings (server mode, Game Modes, spawn menu, HUD) Applies the type's settings from the table above. On
HUD & Hub Loads the type's HUD & Hub preset, or puts the default setup back. A built-in preset also sets the Toolbox HUD to Always. Not listed when the HUD & Hub is already the type's. On when your HUD & Hub is the default or another built-in preset; off when it is your own setup (ticking it replaces yours)
Game Modes rotation Puts the type's modes in the next-match rotation and takes the others out. Only Arena and Survival. On
Player Access Leave Player Access as it is; Tick this type's safe tools for all players (keeps the other ticks); or All players get exactly this type's tools (other ticks for all players are removed; ticks for ranks stay). The line below names the tools. Tick the tools (Sandbox, Build / PvP, RP); leave it (Arena, Survival)
What Apply changes

A list of every change: Change, Now and After. It updates as you pick a type or change an option; the Apply button waits until the list is up to date, so Apply only ever makes the changes shown. "Nothing to change" means the server is already set up like this. A row marked (note) changes nothing; for example, Survival without any Waves mode leaves the rotation as it is instead of emptying it.

Apply N changes (a backup is made first) asks once more, then applies. A message names the backup file. While a restored backup waits for a map change, the wizard applies nothing.

Next steps on this map

What the type still needs on this map, with what is there now:

  • Arena and Survival: Hub spots and spawn spots (World > Mode Spots).
  • Survival: Enemy spawns (needed for the Survival mode) and buy stations (World > Buy Stations).
  • RP: how many jobs there are (Settings > Jobs).
  • Then the type's own steps, such as Player Loadouts and the Armory for an arena.

How to use it

Set up a new arena server
  1. Open Settings > Setup Wizard > Open the setup wizard (or wait for it on a fresh install).
  2. Click Arena (PVP). Read the list of changes.
  3. Press Apply and confirm.
  4. Follow Next steps on this map: place Hub spots and team spawns with World > Mode Spots.
Switch a server to Survival
  1. Open the wizard and click Survival (PVE).
  2. Leave Game Modes rotation ticked so only Survival runs.
  3. Apply. Then place Enemy spawns and buy stations on each map.
Undo a run

Open Settings > Backup / Restore and restore the backup the wizard named (backup_<date>_<time>.json).

Settings and commands

Command / file What it does
kgxat_setup Opens the wizard (owner).
kgxat_setup_prompt 1 = the wizard opens for the owner on a new install (default). 0 = only the chat line (for servers that wipe their data on purpose). Superadmins tick it in Settings > Setup Wizard.
data/kgx_admin_toolbox/setup.json Remembers that the wizard ran: the type, who, when. Deleting it (or a full wipe) lets the wizard open by itself again on a fresh install.

Tips and limits

  • The wizard does not place anything on the map. Hub spots, team spawns, Enemy spawns and buy stations are placed per map with the World tools.
  • With DarkRP, the RP type keeps DarkRP's own jobs, doors and money (the toolbox's jobs and property stay off). Arena and Survival cannot be applied while DarkRP runs (they show "not with DarkRP"): run those servers without DarkRP.
  • Ticks for ranks in Player Access are never changed.
  • The run is written to the Action Log with the number of changes and the backup name.

Back to Settings

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