Birthdays
Wish your members Happy Birthday with ease!
BotGhost provides a birthday module for its users. This module will allow bot users to set and unset their birthdays, view users' birthdays, and receive automatically personalized birthday wishes. You can use and configure the module by heading to your dashboard, scrolling to the "Fun" category, and clicking on "Birthdays".
Note: The Custom Card section is only available to users with a Premium Subscription.
Module Variables
The Birthdays module collects information about all users who record their birthdays. This information can be referenced using variables in the text settings of the module page, or in the builders. You can use any of these variables to provide accurate information in birthday messages, cards, etc.:
| Variable | Description |
|---|---|
{target} | Returns an @mention for the target user |
{target_id} | |
{target_name} | Returns the name for the target user. |
👑 {card} | Returns the image URL of the birthday card for the target user. Will return nothing if you have the Enable Custom Card setting disabled. Recommended for use in a plain text message or the image in an embed. [PREMIUM] |
{age} | Returns the current age for the target user. |
{birthday_timestamp} | Returns the UNIX timestamp of the birthday for the target user. |
{day} | Returns the day of birth for the target user. |
{month} | Returns the month of birth for the target user. |
{year} | Returns the year of birth for the target user. |
{current_year} | Returns the current year. |
Note: These variables can only be used in the Birthdays module.
Module Settings
General Settings
In this area, you can setup and customize the general settings for the commands and events of this module.
Timezone: Here you may choose the timezone you'd like to set times in for this module. It is recommended that you select your local timezone.
Time: Here you may choose the time that birthday wishes will go off on a users' birthday. This will sync to the timezone you chose above.
Save Birth Year: Here you may choose whether the birth year of a user should be allowed to save, not be allowed to save, or be required to save.
Embeds Color: Here you may choose the color for the embeds of the Birthdays module. This will be used in all messages.
Birthday Card
In this area, you can setup and customize the custom card for the /birthday command and the birthday message.
👑 Enable Custom Card: Here you may toggle whether a custom card is displayed for /birthday and automatic birthday wishes. [PREMIUM]
👑 Background Image: Here you may set the background image on the custom card. Use an image URL from an image hosting platform such as Imgur, or empty this field to use a solid color. (Only shown is Enable Custom Card is toggled on) [PREMIUM]
👑 Background Color: Here you may choose the color for the background on the custom card. Will not be used if a valid image URL is specified in the Background Image field. [PREMIUM]
👑 Title Color: Here you may choose the font color for the "title" text on the custom card. [PREMIUM]
👑 Description Color: Here you may choose the font color for the "description" text on the custom card. [PREMIUM]
👑 Avatar Border Color: Here you may choose the color for the circular border around the user's avatar on the custom card. [PREMIUM]
👑 Card Title: Here you may set the "title" text on the custom card. [PREMIUM]
👑 Card Description: Here you may set the "description" text on the custom card. [PREMIUM]
Birthday Message
In this area, you can setup and customize a birthday message to display on a users' birthday.
Send message on Birthday: Here you may toggle whether a message is sent on a user's birthday.
Channel: Here you may choose the channel for the messages to be sent. (Only shown if Send message on Birthday is toggled on)
Message: Here you may set the message that is sent if a birth year is set. (Only shown if Send message on Birthday is toggled on)
Message Without Birth Year: Here you may set the message that is sent if a birth year is not set. (Only shown if Send message on Birthday is toggled on)
Reactions: Here you may choose up to 5 reactions to be added to the message sent. (Only shown if Send message on Birthday is toggled on)
Create Thread: Here you may toggle whether a thread is created on the message for users to leave their birthday wishes in. (Only shown if Send message on Birthday is toggled on)
Lock Thread: Here you may toggle whether the thread created on the message is locked after 24 hours. (Only shown if Send message on Birthday is toggled on)
Add Role on Birthday
In this area, you can setup and customize a function to add a role to the user on their birthday and remove it in 24 hours.
Add a Role on Birthday: Here you may toggle whether a role is added on a user's birthday for 24 hours.
Role: Here you may choose the role that is added to the user on their birthday for 24 hours.
/birthday Command
In this area, you can setup and customize the functions of the /birthday command.
Enable /birthday Command: Here you may toggle whether your bot's users can run the /birthday command.
Command Cooldown: Here you may set a cooldown in minutes for running the /birthday command. It cannot be higher than 1440 (24 hours).
Command Response: Here you may set a response for running the /birthday command.
Commands Permissions
In this area, you can setup and customize the permissions for running each command.
Admin Roles: Here you may choose the roles who can use the /birthday-user-manage command.
Channel Restrictions - Blacklist Type: Here you may choose whether all channels, only select channels, or all but select channels can run the Birthdays module commands.
Channel Restrictions - Select Channels: Here you may choose which channels to allow or disallow, based on whether you selected Disabled for these channels or Enabled for these channels above. (Only shown if No channel restrictions is NOT selected in Channel Restrictions - Blacklist Type)
Role Restrictions - Blacklist Type: Here you may choose whether all roles, only select roles, or all but select roles can run the Birthdays module commands.
Role Restrictions - Select Roles Here you may choose which roles to allow or disallow, based on whether you selected Disabled for these roles or Enabled for these roles above. (Only shown if No role restrictions is NOT selected in Role Restrictions - Blacklist Type)
Module Builders
Commands
In this area, you can view and modify the commands of the Birthdays module.
/birthday-set: This command will allow your bot's users to set their birthday.
/birthday-remove: This command will allow your bot's users to remove their birthday from the system.
/birthday-view: This command will allow your bot's users to view the birthday of a user. You can also change your personal settings.
/next-birthdays: This command will allow your bot's users to view the next birthdays in a server.
/birthday: This command will allow your bot's users to see the message you setup for this command.
/birthday-user-manage: This command will allow this module's Admin Roles to set, remove, and blacklist user birthdays. You can also change someone else's birthday unless the user itself disabled this option.
Events
In this area, you can view and modify the events of the Birthdays module.
Birthdays Handler: This event manages birthday messages and runs every hour.
Leaves Handler: This event manages removing birthday setups for users who leave the bot's server.
Warning: It's advised that you do not edit the events & commands unless you have a good understanding of BotGhost and the Custom Event Builder/Command Builder. You can always reset the module to default if you should happen to make a mistake while editing the event or commands.
Last updated
