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.

chatBridge

Connect chat to other services like Discord.
builtinTakaro >=0.0.1

Components Overview

1
config
0
commands
4
hooks
0
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 (3)

sendPlayerConnectedboolean
Send player connected

Send a message when a player connects.

Default: true
sendPlayerDisconnectedboolean
Send player disconnected

Send a message when a player disconnects.

Default: true
onlyGlobalChatboolean
Only global chat

Only relay messages from global chat. (no team chat or private messages)

Default: true

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

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

4 hooks

DiscordToGame

discord-messageEvent Type
Description
Hook for discord-message events
Function Implementation

DiscordToGame Hook Function

JAVASCRIPT
Event Details
Event Type:discord-message
Trigger:Automatic
Category:Real-time Events

GameToDiscord

chat-messageEvent Type
Description
Hook for chat-message events
Function Implementation

GameToDiscord Hook Function

JAVASCRIPT
Event Details
Event Type:chat-message
Trigger:Automatic
Category:Real-time Events

PlayerConnected

player-connectedEvent Type
Description
Hook for player-connected events
Function Implementation

PlayerConnected Hook Function

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

PlayerDisconnected

player-disconnectedEvent Type
Description
Hook for player-disconnected events
Function Implementation

PlayerDisconnected Hook Function

JAVASCRIPT
Event Details
Event Type:player-disconnected
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.