Takaro module library

Takaro Modules

Takaro is a game server management platform for running, automating, and moderating multiplayer communities. These modules install into Takaro to add server automation, Discord workflows, economy systems, and moderation tools.

timedShutdown

Automatically shut down the server at a specific time.
builtinTakaro >=0.0.1

Components Overview

1
config
0
commands
0
hooks
2
Cron Jobs
0
functions
0
permissions

Configuration

Configure this module using the schemas below. The JSON schema defines the data structure, while the UI schema customizes how the configuration form is displayed.

Configuration Schema

Configuration Properties (1)

warningMessage*string
Warning message

Message to send to players before the server shuts down.

Default: Server is shutting down in 5 minutes!
Constraints: minLength: 1, maxLength: 1024

UI Schema

No UI schema defined. Configuration form will use default rendering.

About Configuration Schemas

The Configuration Schema defines the structure and validation rules for module settings. The UI Schema customizes how the configuration form is displayed in the Takaro interface, including field ordering, labels, and input types.

Scheduled Jobs (2)

These jobs run automatically on a schedule defined by cron expressions. Each job executes JavaScript code at specific times or intervals.

Shutdown

30 3 * * *Schedule

Schedule Details

Cron Expression
30 3 * * *
Human-Readable Schedule

At minute 30 at 3 AM on every day of the month in every month on every day of the week

Function Implementation

Shutdown Function

JAVASCRIPT

Cron Expression Format

minute hour day-of-month month day-of-week

Each field can contain numbers, ranges (1-5), lists (1,3,5), or wildcards (*). Use */n for intervals (e.g., */5 for every 5 units).

warning

25 3 * * *Schedule

Schedule Details

Cron Expression
25 3 * * *
Human-Readable Schedule

At minute 25 at 3 AM on every day of the month in every month on every day of the week

Function Implementation

warning Function

JAVASCRIPT

Cron Expression Format

minute hour day-of-month month day-of-week

Each field can contain numbers, ranges (1-5), lists (1,3,5), or wildcards (*). Use */n for intervals (e.g., */5 for every 5 units).

About Scheduled Jobs

Cron jobs allow your module to execute code automatically on a schedule. Each job has a cron expression that defines when it runs, and a JavaScript function that executes at those times. Jobs run server-side and can perform maintenance tasks, send notifications, or update game state automatically.