# Birthdays

URL: https://zerodev.ca/docs/medusa/modules/birthdays

> Birthday announcements with a role for the day, ages, a server time zone and an upcoming list.



Members save their birthday once and the server celebrates it every year.

## How It Works

1. A member runs `/birthday set month:4 day:12`. Adding `year` is optional and only used to show their age.
2. At the **Announcement Hour** in your server's time zone, Medusa posts one announcement for everyone with a birthday that day, pings the optional role and can DM each member.
3. Members get the **Birthday Role for the Day**, which is removed the next day.

February 29 birthdays are celebrated on February 28 in other years. Set **Server UTC Offset in Hours** to match your community, for example `-5` for New York in winter.

## Settings

**Schedule**

| Setting                    | Default | What it does                               |
| -------------------------- | ------- | ------------------------------------------ |
| Announce Birthdays         | On      | Turns announcements on or off.             |
| Announcement Channel       | None    | Where birthdays are announced.             |
| Announcement Hour          | 9       | Hour of the day to announce, from 0 to 23. |
| Server UTC Offset in Hours | 0       | Your server's time zone.                   |
| Birthday Role for the Day  | None    | Role given for the day.                    |
| Role to Mention            | None    | Role pinged in the announcement.           |

**Announcement**

| Setting                       | Default                                        | What it does                                     |
| ----------------------------- | ---------------------------------------------- | ------------------------------------------------ |
| Announcement Title            | Happy Birthday!                                | Title of the announcement.                       |
| Announcement Message          | Everyone wish %user% a happy birthday!         | Used when the age is unknown or hidden.          |
| Announcement Message with Age | Everyone wish %user% a happy %age%th birthday! | Used when the age is known.                      |
| Show Ages When Known          | On                                             | Uses the message with age when a year was saved. |
| Announcement Image URL        | None                                           | Image shown on the announcement.                 |
| Announcement Color            | `#ec4899`                                      | Card color.                                      |
| Also Send a Birthday DM       | Off                                            | DMs each member on their birthday.               |

Messages can use `%user%` (mention), `%name%` (display name), `%age%` and `%count%` (birthdays that day).

## Commands

| Command                                     | What it does                                                                        |
| ------------------------------------------- | ----------------------------------------------------------------------------------- |
| `/birthday set <month> <day> [year] [user]` | Save a birthday. Members with &#x2A;*Birthdays ( Manage )** can set someone else's. |
| `/birthday remove [user]`                   | Remove a birthday.                                                                  |
| `/birthday view [user]`                     | Show a birthday and how long until the next one.                                    |
| `/birthday upcoming`                        | List the next 15 birthdays.                                                         |

The **Birthdays** dashboard page lists every saved birthday, soonest first.
