Takaro module library
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.
/fund <amount> to contribute their own currency toward the active goal./fundstatus shows the current total, target, progress percentage, and round count./fundhistory shows total completions and the last player who pushed the fund over the line.koji-paper-1. For this capture the game-server command prefix was temporarily set to ! so Mineflayer sends normal chat messages instead of Minecraft slash commands. On a normal server the same module commands use whatever command prefix the server has configured.Bot1_fund90dj runs !fundstatus and sees 0/50.Bot1_fund90dj contributes 20 currency with !fund 20.Bot1_pool90dj runs !fundstatus and sees 20/50 (40%).Bot1_pool90dj contributes 35 currency with !fund 35.50 threshold, broadcasts the unlock message, executes the configured completion command, and starts round #1.!fundhistory confirms 1 completion total and records Bot1_pool90dj as the player who completed the round.
| Command | Purpose |
|---|---|
/fund <amount> | Contribute currency to the active community fund. |
/fundstatus | Show current total, target, progress, and round count. |
/fundhistory | Show completion count and the last completed round. |
| Permission | Purpose |
|---|---|
COMMUNITY_FUND_CONTRIBUTE | Allows a player to contribute currency with /fund <amount>. |
COMMUNITY_FUND_VIEW_HISTORY | Allows a player to view /fundhistory. |
/fundstatus is intentionally public and does not require a permission.fundThreshold: target amount that completes a round.minimumContribution: minimum currency amount a player can contribute per command.completionMessage: broadcast message sent when the threshold is reached. Supports {threshold}.completionCommands: raw game-server commands executed after completion, for rewards or server events.broadcastContributions: whether each contribution is announced globally.koji-paper-1) with real Mineflayer players and live Takaro chat events. The run imported and installed the module, assigned the contribution/history permissions, granted test currency, sent the commands through real bot chat, and verified persisted variables after completion.fundThreshold: 50minimumContribution: 5completionMessage: Community Fund reached {threshold}! Server-wide bonus unlocked!completionCommands: say Community Fund complete: reward unlockedbroadcastContributions: true20 currency from Bot1_fund90dj35 currency from Bot1_pool90dj5051#1, 2026-04-27, by Bot1_pool90dj
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.
Target amount that triggers fund completion and reset
1000000Minimum amount a player must contribute per command
1Broadcast message when threshold is reached. Supports {threshold} placeholder.
The community fund has reached {threshold}! Thank you everyone!Raw game server commands executed on fund completion. E.g. Minecraft: 'effect give @a luck 3600'
[] (empty array)Whether to broadcast each contribution to all players
trueNo UI schema defined. Configuration form will use default rendering.
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.
These commands can be executed by players in-game. Each command has a trigger word, optional arguments, and executes JavaScript code on the server.
NoneCommands 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.
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.
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.
These permissions control who can access different features of this module. Administrators can assign these permissions to roles, allowing fine-grained access control.
COMMUNITY_FUND_CONTRIBUTEPermission KeyAllows a player to contribute currency to the community fund
COMMUNITY_FUND_CONTRIBUTECOMMUNITY_FUND_VIEW_HISTORYPermission KeyAllows a player to view the community fund completion history
COMMUNITY_FUND_VIEW_HISTORYPermissions 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.