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.

AFKChecker

by Limon
Detect players who appear inactive and remove them from the server when configured rules are met. This module helps admins keep slots available and reduce idle-player friction in active communities.
Use this module to:
  • Check whether players are AFK.
  • Kick inactive players after configured conditions.
  • Support healthier server capacity during busy periods.
communityTakaro main
(2 versions available)

Components Overview

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

New Module: AFKChecker

NEW
August 6, 2025
Updated to version 1.0.0. Added 1 scheduled task: afkChecker. New permission: AFK_IMMUNITY. New configuration options: minutesBeforeKick, maxAfkChecks, kickMessage, sendWarning, warningMessage, globalAnnouncement.

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 (6)

minutesBeforeKick*number
Minutes Between Checks

Time in minutes between each AFK check. This should match your cronjob schedule (for example, if your cronjob runs every 5 minutes, set this to 5). Total AFK time before kick will be (Minutes Between Checks × Maximum AFK Checks).

Default: 5
Constraints: min: 1
maxAfkChecks*number
Maximum AFK Checks

Number of consecutive AFK checks before a player is kicked. Total AFK time will be (Minutes Between Checks × Maximum AFK Checks). For example, with 5 minutes between checks and 3 max checks, players will be kicked after 15 minutes of being AFK.

Default: 3
Constraints: min: 1
kickMessage*string
Kick Message

Message shown to the player when they are kicked for being AFK. You can use {minutesAfk} and {minutesUntilKick} placeholders.

Default: You have been kicked for being AFK for {minutesAfk} minutes
sendWarningboolean
Send Warning

Whether to send a warning to players before kicking them for being AFK

Default: true
warningMessage*string
Warning Message

Message sent to warn players before they are kicked for being AFK. You can use {minutesAfk} and {minutesUntilKick} placeholders.

Default: Warning: You have been AFK for {minutesAfk} minutes. You will be kicked in {minutesUntilKick} minute...
globalAnnouncementboolean
Global Announcement

Whether to announce AFK warnings and kicks to all players on the server

Default: false

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 (1)

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

afkChecker

*/5 * * * *Schedule

Description

checks for afk

Schedule Details

Cron Expression
*/5 * * * *
Human-Readable Schedule

Every 5 minutes

Function Implementation

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

Permissions (1)

These permissions control who can access different features of this module. Administrators can assign these permissions to roles, allowing fine-grained access control.

General Permissions

1 permission

AFK Kick Immunity

AFK_IMMUNITYPermission Key
Description

Players with this permission will not be kicked for being AFK.

Permission Details
Full Key:AFK_IMMUNITY
Can Have Count:No
Category:General

About Module Permissions

Permissions control access to module features and functionality. Each permission has a unique key for identification, a friendly name for display, and a description explaining what it allows. Some permissions are countable, meaning they can have numeric values or limits assigned. Administrators assign these permissions to user roles to control who can use different module features.