daily
/dailyTrigger Command
Description
Claim your daily reward
Function Implementation
daily Function
JAVASCRIPTUsage Example
Player types: /daily
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.
dailyRewards
Provides daily login rewards with streak tracking
builtinTakaro >=0.0.1
Components Overview
1
config
3
commands
1
hooks
0
Cron Jobs
1
functions
2
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 (3)
baseReward*number
Base Reward
Base amount of currency given for daily rewards. This is multiplied by streak level.
Default:
100Constraints: min: 1
maxStreak*number
Maximum Streak
Maximum streak level a player can reach
Default:
365Constraints: min: 1
milestoneRewards*array
Milestone Rewards
Additional rewards for reaching certain streak milestones
Default:Array of 5 items
days:7
reward:1000
message:"You did it! 7 days in a row!"
days:30
reward:5000
message:"A whole month! You're on fire!"
... and 3 more items
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 (3)
These commands can be executed by players in-game. Each command has a trigger word, optional arguments, and executes JavaScript code on the server.
streak
/streakTrigger Command
Description
Check your current daily reward streak and next claim time
Function Implementation
streak Function
JAVASCRIPTUsage Example
Player types: /streak
topstreak
/topstreakTrigger Command
Description
Shows the players with highest daily reward streaks
Arguments (1)
count
numberPosition 0Help: Number of players to show (max 25)
Default:
"5"Function Implementation
topstreak Function
JAVASCRIPTUsage Example
Player types: /topstreak <count>
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.
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.
Real-time Events
dailyLoginCheck
player-connectedEvent Type
Description
Hook for player-connected events
Function Implementation
dailyLoginCheck Hook Function
JAVASCRIPTEvent Details
Event Type:player-connected
Trigger:Automatic
Category:Real-time 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.
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
functionReusable Component
Function Implementation
utils Function
JAVASCRIPTImport Usage
Import: import { utils } 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 (2)
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
Claim Daily Rewards
DAILY_CLAIMPermission KeyDescription
Allows the player to claim daily rewards
Permission Details
Full Key:
DAILY_CLAIMCan Have Count:No
Category:General
Multiplier
DAILY_REWARD_MULTIPLIERPermission KeyCountableDescription
Control the multiplier per role. This is useful to give your donors a little extra. Count is an integer multiplier.
Permission Details
Full Key:
DAILY_REWARD_MULTIPLIERCan Have Count:Yes
Category:General
Countable Permission
This permission supports numeric values/levels. For example, you could grant someone "10" of this permission to limit their usage or set permission levels.
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.