mirror of
https://github.com/pacnpal/Pac-cogs.git
synced 2025-12-20 02:41:06 -05:00
adding Overseerr cog to README and give its own README
This commit is contained in:
@@ -7,6 +7,7 @@ Welcome to **Pac-cogs**, a collection of custom cogs for [Red](https://github.co
|
|||||||
| Cog Name | Description |
|
| 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. |
|
| **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. |
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,59 @@
|
|||||||
|
|
||||||
This cog 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.
|
This cog 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.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To install this cog, follow these steps:
|
||||||
|
|
||||||
|
1. Ensure you have Red-DiscordBot V3 installed.
|
||||||
|
2. Add the repository to your bot:
|
||||||
|
|
||||||
|
```
|
||||||
|
[p]repo add Pac-cogs https://github.com/pacnpal/Pac-cogs
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Install the Overseerr cog:
|
||||||
|
|
||||||
|
```
|
||||||
|
[p]cog install Pac-cogs overseerr
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Load the cog:
|
||||||
|
|
||||||
|
```
|
||||||
|
[p]load overseerr
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace `[p]` with your bot's prefix.
|
||||||
|
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Before using the cog, you'll need to configure it:
|
||||||
|
|
||||||
|
1. Set the Overseerr URL and API key:
|
||||||
|
```
|
||||||
|
[p]setoverseerr https://your.overseerr.instance/api/v3 your_api_key
|
||||||
|
```
|
||||||
|
2. Set the admin role allowed to approve requests:
|
||||||
|
```
|
||||||
|
[p]setadminrole @OverseerrAdmins
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Users can request movies or TV shows using the following command:
|
||||||
|
|
||||||
|
```
|
||||||
|
[p]request Movie/TV Show Name
|
||||||
|
```
|
||||||
|
|
||||||
|
Admins can approve requests using:
|
||||||
|
|
||||||
|
```
|
||||||
|
[p]approve request_id
|
||||||
|
```
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
- **Set Overseerr URL and API key**: Admins can configure the Overseerr URL and API key for API interactions.
|
- **Set Overseerr URL and API key**: Admins can configure the Overseerr URL and API key for API interactions.
|
||||||
- **Search and request media**: Users can search for movies or TV shows and request them directly in Discord.
|
- **Search and request media**: Users can search for movies or TV shows and request them directly in Discord.
|
||||||
@@ -28,8 +81,7 @@ This cog allows interaction with [Overseerr](https://overseerr.dev/) directly fr
|
|||||||
- Approve a media request by its request ID (requires the admin role).
|
- Approve a media request by its request ID (requires the admin role).
|
||||||
- Example: `[p]approve 123`
|
- Example: `[p]approve 123`
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
1. Add the cog to your Red instance:
|
## Support
|
||||||
```bash
|
|
||||||
[p]load overseerr
|
If you encounter any issues or have questions, please open an issue on the [GitHub repository](https://github.com/pacnpal/Pac-cogs).
|
||||||
|
|||||||
Reference in New Issue
Block a user