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.

playerOnboarding

Collection of functions that are executed when a player joins the server. Helps with onboarding new players, like sending a welcome message. Fixed issue with starterkit item identifiers.
builtinTakaro >=0.0.1

Components Overview

1
config
1
commands
1
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 (2)

messagestring
Message

The message to send to the player when they join the server.

Default: Welcome {player} to the server!
Constraints: minLength: 1, maxLength: 256
starterKitItemsarrayitem
Starter kit items

List of items a player will receive when they execute the starterkit command for the first time.

Constraints: uniqueItems

UI Schema

No configuration properties defined. This module uses default settings.

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.

Commands (1)

These commands can be executed by players in-game. Each command has a trigger word, optional arguments, and executes JavaScript code on the server.

starterkit

/starterkitTrigger Command

Description

Get a starter kit, you can only execute this once on a server!

Function Implementation

starterkit Function

JAVASCRIPT

Usage Example

Player types: /starterkit

About Module Commands

Commands allow players to interact with your module through chat. Each command has a trigger word that players type (prefixed with /), optional arguments for parameters, and a JavaScript function that executes when the command is used. Arguments are automatically validated and passed to the function.

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

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

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.