Birthdays

Wish your members a Happy Birthday!

Some of the features of this module require a Premium Subscription to function. You can however use the module with a free subscription.

The Birthdays module allows users to set their birthdays, view users' birthdays, and receive automatically personalized birthday wishes.

Common Issues

Experiencing issues with the module? Check out the common issues below. If your issue is not listed in this page, make sure your module is updated to the latest version. If you are still experiencing issues with the module, join our support server to ask for further help.

Birthdays are not being detected

If no birthday message gets sent on an user's birthday, they don't receive their birthday role or they aren't able to use the /birthday showcase command, please try the steps below.

Ensure the module is updated to the latest version. You can update it by clicking the "Update Module" button at the top of the settings page of the module.
Ensure that the "Default Server" option in your Timed Events page is set to the server your birthday module runs in.

If you're still experiencing issues, join our support server to ask for further help, we'll do our best to solve your issue!

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.

If you want to know more about timezones, the following links may be helpful:

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 a custom card that can be used across all messages of the module using the {card} variable.

Features in this section are limited to Premium users.

[👑] Enable Custom card

This toggle option allows you to enable the {card} variable

[👑] Background

This setting allows you to set the background type for your card. Below you may find some information on each background type.

By selecting this option, the default background image will be used. Cards generated with the default background will look like this:

[👑] Title Color

Here you may choose the font color for the "title" text on the custom card.

[👑] Description Color

Here you may choose the font color for the "description" text on the custom card.

[👑] Avatar Border Color

Here you may choose the color for the circular border around the user's avatar on the custom card.

[👑] Card Title

Here you may set the "title" text on the custom card. All default variables can be used, as well as some additional variables that can be found here.

[👑] Card Description

Here you may set the "description" text on the custom card. All default variables can be used, as well as some additional variables that can be found here.

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

This menu allows you to select the channel where the birthday message will be sent. If you don't see your channel, make sure to click on the refresh button next to the "Channel" text.

Message

Here you may set the message that is sent on birthday. This message will be sent only if the user has set a birth year. All default variables can be used, as well as some additional variables that can be found here.

Message Without Birth Year

Here you may set the message that is sent on birthday. This message will be sent only if the user did not set a birth year. All default variables can be used, as well as some additional variables that can be found here.

Reactions

Here you may choose up to 5 custom reactions to be added to the message sent.

Create Thread

Here you may toggle whether a thread is created on the message for users to leave their birthday wishes in.

Lock Thread

Here you may toggle whether the thread created on the message is locked after 24 hours. The create thread setting must be enabled. This setting is only visible with Create Thread enabled.

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 after 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. If you don't see your channel, make sure to click on the refresh button next to the "Channel" text.

/birthday showcase Command

In this area, you can setup and customize the functions of the /birthday command.

Enable /birthday showcase Command

Here you may enable and allow the usage of the /birthday showcase command.

Command Cooldown

This input allows you to set a cooldown for the command in minutes. Users won't be able to use this command twice wiithin this time range. It cannot be higher than 1440 minutes (24 hours).

Command Response

This field allows you to setup the response the bot will return when the command is ran. All default variables can be used, as well as some additional variables that can be found here.

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. They will be able to set, update, remove birthdays or blacklist users from adding their own birthday.

Channel Restrictions

You can setup channel restrictions to allow the usage of the module's commands only in certain channels.

Blacklist Type	Information
No channel restrictions	Users will be able to use the command everywhere.
Disable for these channels...	Set this blacklist type if you want the commands to work in all channels except the channels provided in the menu below.
Enable for these channels...	Set this blacklist type if you want the commands to work only in the channels provided in the menu below.

Blacklist Type

Information

No channel restrictions

Users will be able to use the command everywhere.

Disable for these channels...

Set this blacklist type if you want the commands to work in all channels except the channels provided in the menu below.

Enable for these channels...

Set this blacklist type if you want the commands to work only in the channels provided in the menu below.

Role Restrictions

You can setup role restrictions to allow the usage of the module's commands only to certain roles.

Blacklist Type	Information
No role restrictions	Everyone will be able to use the commands of the module.
Disable for these channels...	Set this blacklist type if you want the commands to work for all users, except users with at least one of the roles provided in the menu below.
Enable for these channels...	Set this blacklist type if you want the commands to work only for users with at least one of the roles provided in the menu below.

Blacklist Type

Information

No role restrictions

Everyone will be able to use the commands of the module.

Disable for these channels...

Set this blacklist type if you want the commands to work for all users, except users with at least one of the roles provided in the menu below.

Enable for these channels...

Set this blacklist type if you want the commands to work only for users with at least one of the roles provided in the menu below.

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.:

These variables can only be used in the Birthdays module.

Variable Description

Variable	Description
`{target}`	Returns an @mention for the target user
`{target_id}`	Returns the user ID for the target user. Can be used in other default variables or to return the ID in general.
`{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. This variable requires a premium subscription to work.
`{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.

{target}

Returns an @mention for the target user

{target_id}

Returns the user ID for the target user. Can be used in other default variables or to return the ID in general.

{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. This variable requires a premium subscription to work.

{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.

Commands

In this area, you can view and modify the commands of the Birthdays module. Below you may find some information on each command of the module.

/birthday set

The birthday set command allows you to set your own birthday to a given date. The date must be provided in DD/MM/YYYY format. You can choose whether you want the birth year to be required in the Save Birth Year setting. You cannot use this command if you're currently celebreating your birthday.

/birthday remove

This command allows users to remove their birthday from the system. They can always add it back using .

/birthday view

This command allows users to view their own or someone's else birthday. They can also update their personal settings by selecting themselves when running the command.

/birthday upcoming

This command allows users to get a list of all upcoming birthdays.

/birthday showcase

Users who are currently celebrating their birthday can use this command. You can configure it from the /birthday showcase Command section.

/birthday user-manage

This command can only be used by server's admins and allows them to update / edit certain information of the selected user. The list of available settings depends on the current birthday status of the user.

Events

In this area, you can view and modify the events of the Birthdays module. Below you may find some information on each event of the module.

Birthdays Handler

This event is the core of the module: it triggers every 30 minutes and ensures to wish your members a happy birthday. Make sure to not delete the associated timed event in the timed events module.

Leaves Handler

This event automatically resets birthday data of users who left the server.

It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended.

Additionally, a copy of the edited commands / events will be created if you update the module.

PreviousCounting NextEconomy & Minigames

Last updated 3 months ago