diff --git a/README.md b/README.md index fd19021..90418ac 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,9 @@ Welcome to **Pac-cogs**, a collection of custom cogs for [Red](https://github.co | Cog Name | Description | |------------|--------------------------------------------------| -| **Birthday** | Assigns a special birthday role to users and sends a celebratory message with random cake or pie emojis. Automatically removes the birthday role at midnight, with a configurable timezone. Offers the option to set a specific announcement channel and restricts usage to specified roles. Users can assign the role without needing a higher role in the hierarchy. | -| **Overseerr** | Allows interaction with [Overseerr](https://overseerr.dev/) directly from Discord. Users can search for movies or TV shows, request them, and have admins approve requests. It's designed for servers with Overseerr set up for managing media requests. | +| **Birthday** | Assigns a special birthday role to users and sends a celebratory message with random cake or pie emojis. Features include: automatic role removal at midnight in configurable timezone, custom announcement channels, role-based command permissions, random cake/pie emoji generation, task persistence across bot restarts, and no hierarchy requirements for role assignment. Perfect for automated birthday celebrations! | +| **Overseerr** | Allows interaction with [Overseerr](https://overseerr.dev/) directly from Discord. Users can search for movies or TV shows, request them, and have admins approve requests. Features include: media availability checking, request status tracking, admin role configuration, and direct integration with Overseerr's API. Requires a running Overseerr instance and API key. | +| **VideoArchiver** | A powerful video archiving cog that automatically downloads and reposts videos from monitored channels. Features hardware-accelerated compression (NVIDIA, AMD, Intel, ARM), multi-video processing, role-based permissions, and support for multiple video platforms via yt-dlp. Automatically compresses videos to meet Discord's file size limits while maintaining quality. | ## Installation @@ -20,16 +21,44 @@ To install the cogs in this repository, follow these steps: [p]repo add Pac-cogs https://github.com/pacnpal/Pac-cogs ``` -3. Install a cog: +3. Install the desired cog: ```bash - [p]cog install Pac-cogs + # For Birthday cog: + [p]cog install Pac-cogs birthday + + # For Overseerr cog: + [p]cog install Pac-cogs overseerr + + # For VideoArchiver cog: + [p]cog install Pac-cogs videoarchiver ``` 4. Load the installed cog: ```bash - [p]load + # For Birthday cog: + [p]load birthday + + # For Overseerr cog: + [p]load overseerr + + # For VideoArchiver cog: + [p]load videoarchiver ``` +Replace `[p]` with your bot's prefix. + +### Additional Requirements + +- **Birthday**: No additional requirements. Just configure the birthday role, timezone, and allowed roles after installation. + +- **Overseerr**: Requires a running [Overseerr](https://overseerr.dev/) instance and API key. You'll need to configure the Overseerr URL and API key after installation using: + ```bash + [p]overseerr url + [p]overseerr apikey + ``` + +- **VideoArchiver**: The cog requires FFmpeg for video processing. The cog will attempt to download and manage FFmpeg automatically if it's not found on your system. The required Python packages (yt-dlp, ffmpeg-python, requests) will be installed automatically during cog installation. + For more details on setting up and managing Red, visit the [Red documentation](https://docs.discord.red).