mirror of
https://github.com/pacnpal/Pac-cogs.git
synced 2025-12-20 02:41:06 -05:00
Add slash command support for all cogs
This commit is contained in:
pacnpal
@@ -1,6 +1,6 @@
|
||||
# Overseerr Cog for Red Discord Bot
|
||||
|
||||
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. Supports both traditional prefix commands and slash commands.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -30,62 +30,89 @@ Replace `[p]` with your bot's prefix.
|
||||
|
||||
## Setup
|
||||
|
||||
Before using the cog, you'll need to configure it:
|
||||
Before using the cog, you'll need to configure it. You can use either prefix commands or slash commands:
|
||||
|
||||
1. Set the Overseerr URL and API key:
|
||||
1. Set the Overseerr URL:
|
||||
```
|
||||
[p]overseerr url https://your.overseerr.instance
|
||||
```
|
||||
or
|
||||
```
|
||||
/overseerr url https://your.overseerr.instance
|
||||
```
|
||||
|
||||
2. Set the Overseerr API key:
|
||||
```
|
||||
[p]overseerr apikey your_api_key
|
||||
```
|
||||
4. Set the admin role allowed to approve requests:
|
||||
or
|
||||
```
|
||||
[p]adminrole @OverseerrAdmins
|
||||
/overseerr apikey your_api_key
|
||||
```
|
||||
|
||||
3. Set the admin role allowed to approve requests:
|
||||
```
|
||||
[p]overseerr adminrole @OverseerrAdmins
|
||||
```
|
||||
or
|
||||
```
|
||||
/overseerr adminrole @OverseerrAdmins
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Users can request movies or TV shows using the following command:
|
||||
Users can request movies or TV shows using:
|
||||
|
||||
```
|
||||
[p]request Movie/TV Show Name
|
||||
```
|
||||
or
|
||||
```
|
||||
/request Movie/TV Show Name
|
||||
```
|
||||
|
||||
Admins can approve requests using:
|
||||
|
||||
```
|
||||
[p]approve request_id
|
||||
```
|
||||
or
|
||||
```
|
||||
/approve request_id
|
||||
```
|
||||
|
||||
## Features
|
||||
- **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.
|
||||
- **Media availability status**: The cog checks if media is already available or has been requested before making new requests.
|
||||
- **Approve requests**: Admins with the appropriate role can approve Overseerr requests within Discord.
|
||||
- **Full slash command support**: All commands can be used as both traditional prefix commands and Discord slash commands.
|
||||
|
||||
## Commands
|
||||
|
||||
All commands support both prefix and slash command syntax:
|
||||
|
||||
### Admin Commands
|
||||
- **`[p]overseerr url <url>`**
|
||||
- **`[p]overseerr url <url>`** or **`/overseerr url <url>`**
|
||||
- Set the Overseerr URL for the bot to communicate with Overseerr.
|
||||
- Example: `[p]overseerr https://your-overseerr-url`
|
||||
- **`[p]overseerr apikey <apikey>`**
|
||||
- Set the Overseerr API Key. retrieved from `https://your-overseerr-url/settings`.
|
||||
- Example: `[p]overseerr apikey 4OK6WLU8Fv2TrZfcOskLZb2PK5WA3547Jz2fEfJqfkLiT34xUP0D48Z7jwC9lC8xU9`
|
||||
- **`[p]overseerr adminrole <role_name>`**
|
||||
- Example: `[p]overseerr url https://your-overseerr-url` or `/overseerr url https://your-overseerr-url`
|
||||
|
||||
- **`[p]overseerr apikey <apikey>`** or **`/overseerr apikey <apikey>`**
|
||||
- Set the Overseerr API Key, retrieved from `https://your-overseerr-url/settings`.
|
||||
- Example: `[p]overseerr apikey 4OK6WLU8Fv2T...` or `/overseerr apikey 4OK6WLU8Fv2T...`
|
||||
|
||||
- **`[p]overseerr adminrole <role_name>`** or **`/overseerr adminrole <role_name>`**
|
||||
- Set the name of the admin role that is allowed to approve Overseerr requests.
|
||||
- Example: `[p]overseerr adminrole @Overseerr Admin`
|
||||
- Example: `[p]overseerr adminrole @Overseerr Admin` or `/overseerr adminrole @Overseerr Admin`
|
||||
|
||||
### User Commands
|
||||
- **`[p]request <media name>`**
|
||||
- **`[p]request <media name>`** or **`/request <media name>`**
|
||||
- Search for a movie or TV show and request it if it's not already available or requested.
|
||||
- Example: `[p]request The Matrix`
|
||||
- Example: `[p]request The Matrix` or `/request The Matrix`
|
||||
|
||||
- **`[p]approve <request_id>`**
|
||||
- **`[p]approve <request_id>`** or **`/approve <request_id>`**
|
||||
- Approve a media request by its request ID (requires the admin role).
|
||||
- Example: `[p]approve 123`
|
||||
- Example: `[p]approve 123` or `/approve 123`
|
||||
|
||||
|
||||
## Support
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import aiohttp
|
||||
from redbot.core import commands, Config
|
||||
from redbot.core.bot import Red
|
||||
import asyncio # Import asyncio
|
||||
import asyncio
|
||||
import json
|
||||
import urllib.parse # Import for encoding URLs
|
||||
import urllib.parse
|
||||
|
||||
class Overseerr(commands.Cog):
|
||||
def __init__(self, bot: Red):
|
||||
@@ -18,11 +18,12 @@ class Overseerr(commands.Cog):
|
||||
|
||||
### GROUP: SETTINGS COMMANDS ###
|
||||
|
||||
@commands.group()
|
||||
@commands.hybrid_group()
|
||||
@commands.admin()
|
||||
async def overseerr(self, ctx: commands.Context):
|
||||
"""Base command group for Overseerr configuration."""
|
||||
pass
|
||||
if ctx.invoked_subcommand is None:
|
||||
await ctx.send_help()
|
||||
|
||||
@overseerr.command()
|
||||
async def url(self, ctx: commands.Context, url: str):
|
||||
@@ -45,14 +46,14 @@ class Overseerr(commands.Cog):
|
||||
|
||||
### REQUEST & APPROVAL COMMANDS ###
|
||||
|
||||
@commands.command()
|
||||
@commands.hybrid_command()
|
||||
async def request(self, ctx: commands.Context, *, query: str):
|
||||
"""Search and request a movie or TV show on Overseerr."""
|
||||
overseerr_url = await self.config.overseerr_url()
|
||||
overseerr_api_key = await self.config.overseerr_api_key()
|
||||
|
||||
if not overseerr_url or not overseerr_api_key:
|
||||
await ctx.send("Overseerr is not configured. Please ask an admin to set it up.")
|
||||
await ctx.send("Overseerr is not configured. Please ask an admin to set it up using `/overseerr url` and `/overseerr apikey`.")
|
||||
return
|
||||
|
||||
search_url = f"{overseerr_url}/api/v1/search"
|
||||
@@ -135,7 +136,7 @@ class Overseerr(commands.Cog):
|
||||
else:
|
||||
await ctx.send(f"Failed to request {media_type} '{selected_result['title']}'. Please try again later.")
|
||||
|
||||
@commands.command()
|
||||
@commands.hybrid_command()
|
||||
async def approve(self, ctx: commands.Context, request_id: int):
|
||||
"""Approve a request on Overseerr."""
|
||||
admin_role_name = await self.config.admin_role_name()
|
||||
@@ -147,7 +148,7 @@ class Overseerr(commands.Cog):
|
||||
overseerr_api_key = await self.config.overseerr_api_key()
|
||||
|
||||
if not overseerr_url or not overseerr_api_key:
|
||||
await ctx.send("Overseerr is not configured. Please ask an admin to set it up.")
|
||||
await ctx.send("Overseerr is not configured. Please ask an admin to set it up using `/overseerr url` and `/overseerr apikey`.")
|
||||
return
|
||||
|
||||
approve_url = f"{overseerr_url}/api/v1/request/{request_id}/approve"
|
||||
@@ -181,5 +182,5 @@ class Overseerr(commands.Cog):
|
||||
return status
|
||||
return "Status Unknown"
|
||||
|
||||
def setup(bot: Red):
|
||||
bot.add_cog(Overseerr(bot))
|
||||
async def setup(bot: Red):
|
||||
await bot.add_cog(Overseerr(bot))
|
||||
|
||||
Reference in New Issue
Block a user