mirror of https://github.com/pacnpal/Pac-cogs.git synced 2025-12-20 02:41:06 -05:00

Files

pacnpal a16b1ea7a4 fix: Change URL extraction in processor to use regex

- Replaced extractor.suitable() with direct regex pattern matching
- Added check for _VALID_URL attribute
- Improved error handling in URL extraction
- Maintains compatibility with video_downloader.py changes

2024-11-15 02:13:37 +00:00

__init__.py

Add context menu command for birthday role assignment. Users with allowed roles can now give birthday roles via right-click menu.

2024-11-15 01:22:10 +00:00

.gitignore

change to birthday

2024-09-28 17:12:25 -04:00

birthday.py

fix: Change URL extraction in processor to use regex

2024-11-15 02:13:37 +00:00

LICENSE

change to birthday

2024-09-28 17:12:25 -04:00

README.md

Update READMEs

2024-11-15 01:28:06 +00:00

README.md

Birthday Cog for Red-DiscordBot

This cog allows you to assign a special role to users on their birthday and send them a celebratory message with cake (or pie) emojis! Supports both traditional prefix commands, slash commands, and context menu commands.

Installation

To install this cog, follow these steps:

Ensure you have Red-DiscordBot V3 installed.

Add the repository to your bot:

[p]repo add Pac-cogs https://github.com/pacnpal/Pac-cogs

Install the Birthday cog:
```
[p]cog install Pac-cogs birthday
```
Load the cog:
```
[p]load birthday
```

Replace [p] with your bot's prefix.

Setup

Before using the cog, you need to set it up. You can use either prefix commands or slash commands:

Set the birthday role:
```
[p]setrole @Birthday
```
or
```
/setrole @Birthday
```
Note: The bot's role must be above the birthday role in the server's role hierarchy, but users assigning the birthday role do not need to have a role above it.
Add roles that can use the birthday command:
```
[p]addrole @Moderator
```
or
```
/addrole @Moderator
```

(Optional) Set the timezone for role expiration:

[p]settimezone America/New_York

/settimezone America/New_York

(Optional) Set a specific channel for birthday announcements:
```
[p]setchannel #birthdays
```
or
```
/setchannel #birthdays
```
If not set, the birthday message will be sent in the channel where the command is used.

Usage

To assign the birthday role to a user, you can use any of these methods:

Command:
```
[p]birthday @User
```
or
```
/birthday @User
```
Context Menu: Right-click on a user and select "Apps > Give Birthday Role"

This will assign the birthday role to the user and send a celebratory message with random cake (or pie) emojis. The role will be automatically removed at midnight in the specified timezone.

Features

Assigns a special birthday role to users
Sends a celebratory message with random cake (or pie) emojis
Automatically removes the birthday role at midnight
Configurable timezone for role expiration
Option to set a specific channel for birthday announcements (defaults to the channel where the command is used)
Restricts usage of the birthday command to specified roles
Users can assign the birthday role without needing a role higher than it in the hierarchy
Full slash command and context menu support
Persistent birthday role removal scheduling (survives bot restarts)
Birthday role removal task checking

Commands

All commands support both prefix and slash command syntax:

Admin Commands

[p]setrole or /setrole: Set the birthday role
[p]addrole or /addrole: Add a role that can use the birthday command
[p]removerole or /removerole: Remove a role from using the birthday command
[p]settimezone or /settimezone: Set the timezone for the birthday role expiration
[p]setchannel or /setchannel: Set the channel for birthday announcements

User Commands

[p]birthday or /birthday: Assign the birthday role to a user
Context Menu > "Give Birthday Role": Right-click a user to assign the birthday role
[p]bdaycheck or /bdaycheck: Check upcoming birthday role removal tasks

Support

If you encounter any issues or have questions, please open an issue on the GitHub repository.