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.

geoBlock

Block players from certain countries from joining the server.
builtinTakaro >=0.0.1

Components Overview

1
config
0
commands
1
hooks
0
Cron Jobs
0
functions
1
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 (5)

modeenum
Mode

If set to allow, only players from the specified countries will be allowed to join. If set to deny, players from the specified countries will be banned from the server.

Default: deny
Allowed values (2):
allowdeny
countries*arraycountry
Countries

List of countries

Constraints: uniqueItems
banboolean
Ban

Ban players from the server when they are detected. When false, players will be kicked instead.

Default: true
banDurationnumberduration
Ban duration

Duration of the ban.

Default: 86400000
Constraints: min: 0
messagestring
Message

Message to send to the player when they are kicked or banned.

Default: Your IP address is banned.

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.

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.

Player Events

1 hook

IPDetected

player-new-ip-detectedEvent Type
Description
Hook for player-new-ip-detected events
Function Implementation

IPDetected Hook Function

JAVASCRIPT
Event Details
Event Type:player-new-ip-detected
Trigger:Automatic
Category:Player 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

GeoBlock immunity

GEOBLOCK_IMMUNITYPermission Key
Description

Players with this permission will not be kicked or banned by GeoBlock.

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