Tutorial / Settings
Scheduler
Run announcements, chat messages, console commands, cleanups, backups and map restarts every N minutes or at a time of day.
What it does
The Scheduler runs tasks on a timer (every N minutes) or at a time of day on the server clock. A task can be an announcement, a chat message, a console command, a map cleanup, clearing decals, a backup, or a map restart.
Each task can be turned off without removing it, and run at once from its right-click menu. Every run is written to the server log.
Where to find it
Q menu > KGX's Admin Toolbox > Settings > Scheduler.
Superadmins only (it runs console commands). Everyone else sees "Only superadmins can use the scheduler." With a server owner set (v3.6.12, kgxat_owner add <SteamID> in the server console), only owners can; see Settings > Permission Report.
The panel
| Option | What it does | Default |
|---|---|---|
| Server time: ... | The server clock (HH:MM) when the list was loaded. Daily tasks use this clock. | |
| List: Task, When | Every task. Off tasks start with [OFF]. When reads "every N min" or "daily HH:MM"; timer tasks also show the minutes left. | |
| Name, e.g. Discord reminder | The task's name. Empty = the kind's id. | empty |
| What | The kind of task (see below). | Announcement on screen (text) |
| Text (announcement, chat message or console command): | The text, for the three kinds that need one. | empty |
| When | Every N minutes, or Every day at a time (server clock). | Every N minutes |
| Every N minutes | Minutes between runs (1-1440). | 30 |
| Time of day (HH:MM, 24 h): | The time for daily tasks. | 04:00 |
| Add as a new task | Adds the form as a new task and saves. | |
| Update the selected task | Replaces the selected task with the form and saves. | |
| Refresh | Loads the list again. |
Right-click a task for Run now, Turn off / Turn on, and Remove.
The task kinds
| What | What happens |
|---|---|
| Announcement on screen (text) | Shows the text on everyone's screen as a server announcement. |
| Chat message (text) | Prints "[Server] <text>" in everyone's chat. |
| Server console command (text) | Runs the text as the server console, e.g. say Hello or sv_gravity 600. |
| Clean up the map (30 s warning) | Announces "Map cleanup in 30 seconds. Save your builds (they will be removed).", then cleans up the map. |
| Clear decals and corpses | Clears decals for everyone and removes ragdolls that no player owns and that the map did not make. |
| Make a backup of the toolbox data | Makes a backup (Settings > Backup lists it). |
| Restart the map (60 s warning) | Reloads the current map after a 60-second countdown. |
How to use it
Post a reminder every 30 minutes
- Open Q menu > KGX's Admin Toolbox > Settings > Scheduler as a superadmin.
- Type a name, for example
Discord reminder. - In What, pick Chat message (text), and type the message in the text box.
- Leave When on Every N minutes and set Every N minutes to 30.
- Press Add as a new task. It runs 30 minutes from now, then every 30 minutes.
Back up every night
- In What, pick Make a backup of the toolbox data.
- In When, pick Every day at a time (server clock).
- Type the time in Time of day (HH:MM, 24 h):, for example
04:00. Check Server time for the server's clock. - Press Add as a new task.
Change or pause a task
- Click the task: the form fills with its settings.
- Change them and press Update the selected task.
- To pause it, right-click it and choose Turn off. Choose Turn on to resume.
Tips and limits
- Announcement, chat and console command tasks need a text; without one you get "This kind of task needs a text."
- Up to 50 tasks. Text is cut to 250 characters and names to 40.
- Timer tasks first run N minutes after they are saved. Saving the list restarts every timer.
- The scheduler checks tasks every 10 seconds; a daily task runs once in its minute.
- A time that is not HH:MM becomes 04:00.
- For one fixed daily map restart, Server Settings also has a daily restart time (
kgxat_restart_hour,kgxat_restart_minute). - Tasks are saved in
schedule.jsonindata/kgx_admin_toolbox/.