Skip to content

Latest commit

 

History

History
158 lines (111 loc) · 13.7 KB

README.md

File metadata and controls

158 lines (111 loc) · 13.7 KB

Birthday Bot

Discord Bots Discord Bots License Stars Discord Shield Discord Bots

Important Note

For the most detailed and up-to-date information and guide please visit the Official Birthday Bot Documentation here!

Discord Bot - Celebrate Birthdays, Custom Events, Member Anniversaries and Server Anniversaries with the most customizable Birthday bot! Configure messages, roles, channels, and much more to your liking! Use /set to set your birthday and time zone, /setup to setup your server, and /help to see all commands as well as more information about the bot!

Join The Support Server | Donate with Paypal!

Features:

Free Features

  • Each user can set their birthday & time zone into the bot which stores that information into a database allowing the bot to know on what day and what time zone to celebrate the user's birthday
  • Birthday System: Celebrate birthdays in your server!
    • By default, birthdays are shown in all servers with Birthday Bot, and birthd years/ages are hidden. Users and server owners can customize this:
      • Users can use /user to edit their global settings and /user_server to edit their server specific settings. User Privacy Settings.
    • Server owners can set up a custom birthday blacklist to blacklist certain users and/or roles from having their birthday celebrated and shown in the server.
    • Server owners can set up the trusted role system in order to lock certain or all things related to the birthday system behind a specific role.
      • Customize if the trusted role prevents users from receiving the birthday role, birthday message, and/or appear in the /next and /list command.
    • Server owners can disable all ages in their server with the disable ages setting.
    • The birthday channel is the channel where the bot will post birthday messages and you can customize:
    • The birthday role is the role that will be given to users on their birthday and taken from those whose birthday it isn't.
  • Custom Event System: Create a custom event that will be celebrated in your server.
    • Each custom event has a date, time, and optional year. If given a year, the event will only happen once on that year otherwise, it will repeat annually.
    • Each event has a custom message associated with it.
    • Each has it's own ping setting.
  • Anniversary System: Celebrate member and server anniversaries in your server!
  • Configure many more settings such as:
  • View upcoming birthdays/anniversaries.
  • Clear your information from the database at any time.
  • Near 24/7 up-time!
  • Avoid having to vote to use some commands.
  • Priority message posting.
  • Custom Event System: Create up to 500 custom events that will be celebrated in your server!
    • Each custom event has a date, time, and optional year. If given a year, the event will only happen once on that year otherwise, it will repeat annually.
    • Each event has a custom message associated with it.
    • Each has it's own ping setting.
  • Setup member anniversary roles to celebrate how long members have been in your discord
    • For example, the 3-Year Veteran role can be set to be given on a member's 3 year anniversary in your discord.
  • Setup Multiple trusted roles
    • Use the RequireAllTrustedRoles setting to decide if users need all trusted roles or just one to have their birthday celebrated.
  • Set the trusted prevents ping setting to decide if the trusted role prevents users from receiving the birthday ping.
  • More control over the Custom Message(s).
    • Up to 500 custom birthday messages (vs 3 for free).
    • Up to 500 custom member anniversary messages (vs 3 for free).
    • Up to 500 custom server anniversary messages (vs 1 for free).
    • Fully customize embedded custom messages.
      • Custom color, image, title and footer. The message must be embedded for these settings to work.
    • Set user-specific custom messages for both birthdays and member anniversaries.
      • One custom message per user
      • Unlimited user-specific messages per server
  • Permanent Lists
    • Generates a list like the /list command, but the list is permanent and updated hourly by the bot.
    • Available able for both birthdays and member anniversaries.
    • Custom post modes for all celebration types! (Threads & Pins!)
  • Even more settings:
  • Support Development!
    • Since I started Birthday Bot, I have maintained development and server costs completely out of my own pocket, Birthday Bot Premium allows me to continue to maintain development as Birthday Bot continues to gain tens of thousands of servers each month.
    • Subscriptions to Birthday Bot Premium go straight to server costs.

Support and Troubleshooting

Birthday Bot is a part of the Arilyn Bot family, and any support, questions, or feedback are welcome in our support Discord. Please visit our FAQ and setup guide, as well as previous user questions, before contacting staff. Thanks!

Example Birthday Announcement (Fully customizable):

Example Birthday Announcement

In your Discord server Birthday Bot will track your users' birthdays and using their time zone celebrate their birthday through its customizable birthday role and message. Even if you have a large discord, use Birthday Bots trusted-role system to only celebrate the users you want to avoid the spam of tracking everyone. Similar messages can also be setup to celebrate the anniversary of members joining your discord server and the anniversary of the server itself!

Setting your birthday

Birthday Bot makes everything easy using an easy-to-follow process.

Start by using /set.

Default time zone prompt

If your server has a default time zone set, you will be asked if you would like to use that time zone. If you do, simply press the check mark; if not, choose the x.

Birthday Bot uses time zones to detect when to celebrate each user's birthday. If you are unsure of your time zone, you can find it here.

If you chose the x or your server does not have a default time zone set, you will receive another prompt asking for your time zone

Time zone input

Please press the "Enter Response" button and you will see a text input modal like the one below

Time zone input Modal

In the text box please enter your time zone and click submit.

Birthday Bot will now know your time zone and will use this to know what time to celebrate your birthday!

Now, Birthday Bot will prompt you to put your Birth Month & Date as well as the option to add your birth year.

Birthday prompt

Simply click the "Enter response" button as you did for adding your time zone.

Birthday input modal

In the text box enter your birth month and day along with your birth year if you want (it is not required) and click submit.

Finally, the confirmation menu will appear.

Confirmation

Ensure this is the correct information, then confirm by clicking the checkmark.

End

For users that is it! Server owners will have to do a bit more but Birthday Bot makes it easy with an interactive setup. For more information on server setup follow our guide here.

As the message states, birth years are hidden in all servers by default. Learn more about Birthday Bot's user privacy settings here.

Finding your time zone

Kevin Novak has created a handy map time zone picker!

Simply click your location on the map and copy the name of the selected time zone. You can then use it in the /set command.

Setting your time zone

Help

For additional help join the support server here.

License

Birthday Bot does not have a license. This means, while Birthday Bot's code is public to anyone, you do NOT have permission to modify or redistribute this code. Since there is no license, the default copyright laws apply, meaning that I retain all rights to the source code and no one may reproduce, distribute, or create derivative works from it. For more details please visit here.