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.

serverWipe

by Mad
Reset selected server data through configurable Takaro wipe actions. This module helps admins prepare for wipes, seasons, events, or testing by choosing which player and server records should be cleared.
Use this module to:
  • Wipe selected player currency, locations, or related server data.
  • Run controlled reset operations from Takaro.
  • Support seasonal or event-based server management workflows.
communityTakaro main
(2 versions available)

Components Overview

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

Command Update: wipe

August 12, 2025
Updated 1 command implementation.

New Module: serverWipe

NEW
August 6, 2025
Updated to version latest. Added 2 commands: wipecontinue, wipe. Added 1 function: wipeHelpers.js. New permission: SERVER_WIPE. New configuration options: wipeCurrency, wipeTeleports, wipeStarterKitClaims, globalAnnouncement.

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

wipeCurrencyboolean
wipeCurrency

Whether to reset all player currency during wipe

Default: false
wipeTeleportsboolean
wipeTeleports

Whether to delete all teleport locations during wipe.

Default: false
wipeStarterKitClaimsboolean
wipeStarterKitClaims

wipeStarterKitClaims

Default: false
globalAnnouncementstring
globalAnnouncement

Message to broadcast to all players after the wipe

Default:

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.

Commands (2)

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

wipecontinue

/wipecontinueTrigger Command

Description

No help text available

Arguments (2)

type
stringPosition 0
Help: help
Default: ""
confirm
booleanPosition 1
Help: help
Default: "false"

Function Implementation

wipecontinue Function

JAVASCRIPT

Usage Example

Player types: /wipecontinue <type> <confirm>

wipe

/wipeTrigger Command

Description

Wipe server data according to configuration

Arguments (2)

target
stringPosition 0
Help: What to wipe: all, currency, teleports, waypoints, or starterkits
Default: "all"
confirm
booleanPosition 1
Help: Confirm wipe operation (must be true to execute)
Default: "false"

Function Implementation

wipe Function

JAVASCRIPT

Usage Example

Player types: /wipe <target> <confirm>

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.

Functions (1)

Reusable JavaScript functions that can be imported and used by other module components like commands, hooks, and cron jobs. These promote code reuse and modularity.

wipeHelpers.js

functionReusable Component

Function Implementation

wipeHelpers.js Function

JAVASCRIPT

Import Usage

Import: import { wipeHelpers.js } from './utils';

About Module Functions

Functions are reusable JavaScript components that can be imported and used by commands, hooks, and cron jobs within your module. They promote code reuse, improve maintainability, and allow you to organize complex logic into modular pieces. Functions must be exported with proper ES6/CommonJS syntax to be importable by other components.

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

SERVER_WIPE

SERVER_WIPEPermission Key
Description

Permission to wipe server

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