Birthday
This is the cog guide for the birthday cog. You will find detailed docs about usage and commands.
[p]
is considered as your prefix.
Usage
Birthdays
Set yours and get a message and role on your birthday!
Commands
bdset
Note
This command is locked to server admins.
Syntax
[p]bdset
Description
Birthday management commands for admins.
Looking to set your own birthday? Use [p]birthday set
or [p]bday set
.
bdset channel
Syntax
[p]bdset channel <channel>
Description
Set the channel where the birthday message will be sent.
- Example:
[p]bdset channel #birthdays
- set the channel to #birthdays
bdset force
Syntax
[p]bdset force <user> <birthday>
Description
Force-set a specific user’s birthday.
You can @ mention any user or type out their exact name. If you’re typing out a name with
spaces, make sure to put quotes around it ("
).
- Examples:
[p]bdset set @User 1-1-2000
- set the birthday of@User
to 1/1/2000[p]bdset set User 1/1
- set the birthday of@User
to 1/1/2000[p]bdset set "User with spaces" 1-1
- set the birthday of@User with spaces
to 1/1 -
[p]bdset set 354125157387344896 1/1/2000
- set the birthday of@User
to 1/1/2000
bdset interactive
Syntax
[p]bdset interactive
Description
Start interactive setup
bdset msgwithoutyear
Syntax
[p]bdset msgwithoutyear <message>
Description
Set the message to be send when the user did not provide a year.
If you would like to mention a role, you will need to run [p]bdset rolemention true
.
- Placeholders:
{name}
- the user’s name{mention}
- an @ mention of the user
All the placeholders are optional.
- Examples:
[p]bdset msgwithoutyear Happy birthday {mention}!
[p]bdset msgwithoutyear {mention}'s birthday is today! Happy birthday {name}.
bdset msgwithyear
Syntax
[p]bdset msgwithyear <message>
Description
Set the message to be send when the user did provide a year.
If you would like to mention a role, you will need to run [p]bdset rolemention true
- Placeholders:
{name}
- the user’s name{mention}
- an @ mention of the user{new_age}
- the user’s new age
All the placeholders are optional.
- Examples:
[p]bdset msgwithyear {mention} has turned {new_age}, happy birthday!
[p]bdset msgwithyear {name} is {new_age} today! Happy birthday {mention}!
bdset role
Syntax
[p]bdset role <role>
Description
Set the role that will be given to the user on their birthday.
You can give the exact name or a mention.
- Example:
[p]bdset role @Birthday
- set the role to @Birthday[p]bdset role Birthday
- set the role to @Birthday without a mention[p]bdset role 418058139913063657
- set the role with an ID
bdset rolemention
Syntax
[p]bdset rolemention <value>
Description
Choose whether or not to allow role mentions in birthday messages.
By default role mentions are suppressed.
To allow role mentions in the birthday message, run [p]bdset rolemention true
.
Disable them with [p]bdset rolemention true
bdset settings
Syntax
[p]bdset settings
Description
View your current settings
bdset stop
Syntax
[p]bdset stop
Description
Stop the cog from sending birthday messages and giving roles in the server.
bdset time
Syntax
[p]bdset time <time>
Description
Set the time of day for the birthday message.
Minutes are ignored.
- Examples:
[p]bdset time 7:00
- set the time to 7:45AM UTC[p]bdset time 12AM
- set the time to midnight UTC[p]bdset time 3PM
- set the time to 3:00PM UTC
bdset zemigrate
Note
This command is locked to the bot owner.
Syntax
[p]bdset zemigrate
Description
Import data from ZeCogs’/flare’s fork of Birthdays cog
birthday
Syntax
[p]birthday
Tip
Alias: bday
Description
Set and manage your birthday.
birthday remove
Syntax
[p]birthday remove
Tip
Aliases: birthday delete
, birthday del
Description
Remove your birthday.
birthday set
Syntax
[p]birthday set <birthday>
Tip
Alias: birthday add
Description
Set your birthday.
You can optionally add in the year, if you are happy to share this.
If you use a date in the format xx/xx/xx or xx-xx-xx MM-DD-YYYY is assumed.
- Examples:
[p]bday set 24th September
[p]bday set 24th Sept 2002
[p]bday set 9/24/2002
[p]bday set 9-24-2002
[p]bday set 9-24
birthday upcoming
Syntax
[p]birthday upcoming [days=7]
Description
View upcoming birthdays, defaults to 7 days.
- Examples:
[p]birthday upcoming
- default of 7 days[p]birthday upcoming 14
- 14 days
birthdaydebug upcoming
Syntax
[p]birthdaydebug upcoming