You can configure Cakey bot to announce birthdays for your users. All birthdays are retricted to the server you set them in. this means you must manually set your birthday in every server that you would like it announced in. Before you can use any birthday commands, a server admin must enable the feature by selecting a birthday announcement channel.
The birthday announcement channel is where all of the birthday announcements will be sent in your server. You MUST set a birthday channel before any of the birthday commands can be used. If you do not set an announcement channel then birthdays will not be announced. The birthday channel can be set on the Bot Settings page of the web dashboard or by using the /birthday channel <channel> command.
Note: Due to a Discord limitation you can't disable the birthday announcement channel by using the
/birthday channelcommand. You will have to set it to "None" in the web dashboard.
You can set your own birthday by running the /birthday set command. You can also change or update your birthday by running this command again and using the updated date.
Server moderators can manually set/update other user's birthdays.
The
yearparameter is optional and defaults to2016if not provided. It must be between 1900 and 2100, and any year greater than the current year will be rejected.
You can view upcoming birthdays with the /birthday next command. By default it will show the next 5 birthdays though you can specify a limit between 1 and 10.
You can remove your birthday by running the /birthday remove command.
In addition to this you can remove another user's birthday by running /birthday remove <user>, however you must have Manage Server permission to remove the birthday of another user.
Helpful Tip: You can also view and delete birthdays on the dashboard!
You can also have Cakey Bot assign a temporary birthday role to users on the day of their birthday! This role will be added to the user when the announcement for their birthday is sent, and it'll be removed when the birthdays for the next day are checked. In order to set a birthday role you can either use the /birthday role <role> command or you can configure it on the birthday page of the web dashboard.
A birthday role is NOT required for birthday announcements to be made. Announcements will be sent regardless if a role is set or not.
Note: Due to a Discord limitation you can't disable the birthday auto role by using the
/birthday rolecommand. You will have to set it to "None" in the web dashboard.
Note: In order to prevent abuse, Cakey Bot will prevent selecting roles that contain
Administrator,Manage ServerorManage Rolespermissions. In addition, if these roles gain this permission after being set, the bot will no longer assign them.
By default, Cakey Bot announces birthdays with a generic message. You can customize this on the "Custom Birthday Messages" field of the birthday page of the web dashboard.
You can enter multiple messages separated by a semicolon (;) — a random message from the list will be chosen each time a birthday is announced.
You can also use a few placeholders in your message(s):
{user.mention} - Mentions the user whose birthday it is.{user.username} / {user.nickname} / {user.globalname} - The user's username, nickname, or global display name.{server.name} - Your server's name.The custom birthday message is capped at 5,000 characters.
Usage Key: <required> / [optional]
| Command | Description | Usage | Permission |
|---|---|---|---|
| /birthday channel | Sets or updates the birthday announcement channel. | <channel> | ManageServer or Administrator |
| /birthday next | View any upcoming birthdays. | [limit] | None |
| /birthday remove | Remove your birthday. (Or another user's birthday) | [user] | None (Manage Server required to remove another user's birthday) |
| /birthday role | Sets or updates the birthday auto role. | <role> | ManageServer or Administrator |
| /birthday set | Sets or updates your birthday. | <month> <day> [year] [user] | None |
| /birthday view | View a user's birthday. (If they have one set) | <user> | None |
| /setup clear-all-birthdays | Remove ALL birthdays for the server. | <confirm> | ManageServer or Administrator |
| /setup clear-missing-birthdays | Remove birthdays for users who have left the server. | <confirm> | ManageServer or Administrator |