Skip to main content

Modules

The core of Takaro is built around Modules. Modules are a very powerful and flexible way of creating features..

Takaro comes with a set of built-in modules. When you enable these on a Gameserver, you will be able to change the configuration of the module to customize it but you cannot edit the code. This allows Takaro to automatically keep the built-in modules up-to-date.

Each module consists of one or more of the following components:

  • Hooks
  • Cronjobs
  • Commands

Hooks​

Hooks are triggered when a certain event happens on a Gameserver. Think of it as a callback function that is executed when a certain event happens. For example, when a player joins a server, a Hook can be triggered that will send a message to the player.

You can optionally add a string filter to hooks, allowing you more control over when it fires exactly. For advanced users, regex filtering is also supported.

Cronjobs​

Cronjobs are triggered based on time. This can be a simple repeating pattern like "Every 5 minutes" or "Every day" or you can use raw Cron syntax to define more complex patterns like "Every Monday, Wednesday and Friday at 2 PM";

Commands​

Commands are triggered by a user. They are triggered when a player sends a chat message starting with the configured command prefix. Note that this means that commands are a manual action, unlike Hooks and Cronjobs which are triggered with any user-intervention.

Arguments​

Commands support arguments, allowing you to pass data to the Function. For example, you can create a command that allows players to teleport to a specific location. The command could look like /teleport homeBase.

Arguments can have different types, such as string, number, boolean and player. Each of these types gets validated before the command is executed. If the validation fails, the user will get an error message. So if you set an argument to be a number, but the user passes a string like test, the command will not be executed, and the user will get an error message.

The player type is a special type that allows you to pass a player as an argument. This is useful for commands that require a player to be passed, such as /kick John Doe. The player type can be a partial name, so /kick John would also work. It also supports case insensitivity, so /kick john would also work. You can also pass IDs to be most precise. If multiple players match the name, the user will get an error message.

Configuration

Every Module can have a certain configuration which can be created using configuration fields. Configuration fields enable the creation of more versatile and reusable modules by providing a way to dynamically customize certain parts of a module. These fields offer the flexibility to adjust module functionalities according to specific needs.

For instance:

  • The Geo block module includes a configuration field named countryList. This field allows you to specify which countries should be blocked form accessing. By making the country list a configuration field you can dynamically adjust the list for each server you install the module on.

  • The gimme module features an itemList configuration field. This enables the creation of a customizable list of items that can be awarded to players. This means the item module remains game agnostic as the module itself has no static list.

Example​

The configuration fields are accessible in the module's code to customize the behavior of the hooks, cronjobs, and commands. As a contrived example, a config like the following exists:

{
  "extraMessage": "Don't forget to read the rules :)"
}

And a Hook on the event playerConnected, which fires whenever a Player connects to the Gameserver. The Function code:


import { getTakaro } from '@takaro/helpers';

async function main() {
    await takaro.gameserver.gameServerControllerSendMessage(data.gameServerId, {
      message: `Welcome to the server, ${data.player.name}. ${data.module.userConfig.extraMessage}`,
  });
}

main();

Would result in a message in-game saying Welcome to the server, John Doe! Don't forget to read the rules :)