# Getting Started

Welcome to the Birthday Bot Documentation!

**Now that you have invited the bot to your discord server, you can begin!**

Birthday Bot comes with a few main commands to make the job of setting up the bot and getting it operational very quick and easy!

### Bot Features:

* The bot now supports slash commands which means that user input is done through the use of the **/** key and the user interface of Discord rather than using a pre-defined prefix and message.
* The bot lets users input their time zone which is stored into the database alongside the date which will allow for their birthday to be announced at 12 am in the time zone they have provided.
* Premium features are also available which allows for customisation which can be set to your liking such as specific birthday messages, user ages etc.
* The bot has a very good uptime but does have maintenance outages from time to time but you'd be notified of these through our [Support Server](https://discord.gg/T3sRn8f) where you can also get information on updates and request any help with the bot that you might need.

### Support:

Birthday Bot is associated developed by UtiliBots, if you require any support, wish to forward feedback or suggestions then you can do so by visiting the the support server [here](https://discord.gg/T3sRn8f).


# Commands

All of the bot commands within their sections.

## Admins Commands:

* `/announcement-channel` - Manage the channel where birthdays are announced.
* `/birthday-role` - Manage the role that is given alongside birthday announcements.
* `/force-birthday` - Set up someone else's birthday on the server.
* `/purge-birthday` - Purge a user's configured birthday on this server.
* `/purge-birthdays` - Purge configured birthdays for members no longer on this server.
* `/birthday-ping` - Manage the ping for birthday announcements.
* `/force-announce` - Force announce a member's birthday.

## Premium Commands:

* `/set-age` - Set your age to display in your birthday announcement.
* `/remove-age` - Remove your age from being in your birthday announcement.
* `/set-thumbnail` - Set the thumbnail displayed in birthday announcements.
* `/remove-thumbnail` - Remove the thumbnail displayed in birthday announcements.
* `/set-message` - Set a message used on birthday announcements.
* `/remove-message` - Remove a message used on birthday announcements.
* `/redeem-premium` - Redeem your premium subscription for this server.

## User Commands:

* `/set-birthday` - Set up your birthday on the server.
* `/remove-birthday` - Remove your birthday setup from this server.
* `/view-birthday` - View your birthday or someone else's setup on this server.
* `/view-birthdays` - View the birthdays set up on this server.
* `/view-server` - View the server configuration and statistics.
* `/preview-announcement` - View how your birthday announcement will look.

## Miscellaneous Commands:

* `/debug` - Debug the bots required permissions.
* `/help` - View all bot commands.
* `/invite` - A link to invite the bot.
* `/privacy` - Privacy policy of the bot.
* `/rate` - Rate the bot on various bot lists.
* `/report-bug` - Report a bug.
* `/reviews` - View user reviews from Void Bots.
* `/suggest` - Suggest a feature for the bot.
* `/vote` - Links to vote for the bot.
* `/voted` - Check when you or others last voted.
* `/votes` - View all of the bot voters.
* `/ping` - View the latency of the bot and API.
* `/info` - View bot information.
* `/stats` - View the statistics of the bot.