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.
Hangman
- Let players create Hangman games with secret words or phrases.
- Allow multiple players to join and guess.
- Track progress, wrong guesses, and game status.
- Connect participation or wins to the server economy.
- Give admins controls for hosting and moderation.
Components Overview
New Module: Hangman
NEWhangmanStart, hangmanJoin, hangmanGuess, hangmanStatus, hangmanReveal, hangmanCancel. Added 1 function: utils. New permissions: HANGMAN_HOST, HANGMAN_PLAY, HANGMAN_ADMIN. New configuration options: maxWrongGuesses, winReward, hostReward, gameTimeout, minWordLength, maxWordLength, entryFee, guessPrice, hostingFee.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 (9)
maxWrongGuesses
Maximum number of wrong guesses allowed before the game ends.
6winReward
Amount of currency to reward the player who guesses the word correctly.
100hostReward
Amount of currency to reward the player who hosts the game if nobody guesses the word.
50gameTimeout
Maximum time a game can run before automatically ending.
60000minWordLength
Minimum length of words that can be used in the game.
4maxWordLength
Maximum length of words that can be used in the game.
15entryFee
Cost to join a Hangman game
10guessPrice
Cost per letter guess
0hostingFee
Cost to create and host a new Hangman game
20UI 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 (6)
These commands can be executed by players in-game. Each command has a trigger word, optional arguments, and executes JavaScript code on the server.
hangmanStatus
Description
Function Implementation
hangmanStatus Function
JAVASCRIPTUsage Example
hangmanCancel
Description
Function Implementation
hangmanCancel Function
JAVASCRIPTUsage Example
hangmanStart
Description
Arguments (1)
word
stringPosition 0""Function Implementation
hangmanStart Function
JAVASCRIPTUsage Example
hangmanJoin
Description
Function Implementation
hangmanJoin Function
JAVASCRIPTUsage Example
hangmanGuess
Description
Arguments (1)
letter
stringPosition 0""Function Implementation
hangmanGuess Function
JAVASCRIPTUsage Example
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.
utils
Function Implementation
utils Function
JAVASCRIPTImport Usage
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 (3)
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
Hangman Admin
HANGMAN_ADMINPermission KeyDescription
Allows the player to manage and control running Hangman games.
Permission Details
HANGMAN_ADMINHost Hangman Game
HANGMAN_HOSTPermission KeyDescription
Allows the player to start and host Hangman games.
Permission Details
HANGMAN_HOSTPlay Hangman
HANGMAN_PLAYPermission KeyDescription
Allows the player to join and make guesses in Hangman games.
Permission Details
HANGMAN_PLAYAbout 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.







































