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.

Whitelisting

by Limon
Control game server access with a configurable whitelist workflow in Takaro. This module helps community managers restrict entry, coordinate approved players, and keep access rules visible through permissions and commands.
Use this module to:
  • Allow or deny access based on configured whitelist data.
  • Give staff tools for managing approved players.
  • Support private, application-based, or event-limited server communities.
communityTakaro main
(2 versions available)

Components Overview

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

New Module: Whitelisting

NEW
August 6, 2025
Updated to version 0.0.1. Added 1 hook: whitelisting (player-connected). New permission: WHITELIST_ACCESS. New configuration option: kickMessage.

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)

kickMessagestring
kickMessage

Message to display to players who are kicked for not having the required role.

Default: You do not have permission to join this server.

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.

Hooks (1)

These hooks respond to various game events automatically. Each hook executes JavaScript code when its specific event type occurs, allowing modules to react to player actions, system changes, and more.

Real-time Events

1 hook

whitelisting

player-connectedEvent Type
Description
checkPlayerRole
Function Implementation

whitelisting Hook Function

JAVASCRIPT
Event Details
Event Type:player-connected
Trigger:Automatic
Category:Real-time Events

About Module Hooks

Hooks allow your module to respond automatically to game events like player actions, server status changes, and chat messages. Each hook has an event type that determines when it triggers, optional regex patterns for filtering specific events, and a JavaScript function that executes when the conditions are met. Hooks are grouped by category for better organization.

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

Whitelist Access

WHITELIST_ACCESSPermission Key
Description

Players with this permission can join the whitelisted server.

Permission Details
Full Key:WHITELIST_ACCESS
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.