pacnpal/Pac-cogs
1
0
Fork 0
mirror of https://github.com/pacnpal/Pac-cogs.git synced 2025-12-20 10:51:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
pacnpal
2024-10-21 13:58:25 -04:00
committed by GitHub
parent b20c0cf766
commit 0aa570ef4b
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
overseerr/README.md
View File

@@ -34,15 +34,15 @@ Before using the cog, you'll need to configure it:
1. Set the Overseerr URL and API key: 1. Set the Overseerr URL and API key:
``` ```
[p]setoverseerr url https://your.overseerr.instance [p]overseerr url https://your.overseerr.instance
``` ```
2. Set the Overseerr API key: 2. Set the Overseerr API key:
``` ```
[p]setoverseerr apikey your_api_key [p]overseerr apikey your_api_key
``` ```
4. Set the admin role allowed to approve requests: 4. Set the admin role allowed to approve requests:
``` ```
[p]setadminrole @OverseerrAdmins [p]adminrole @OverseerrAdmins
``` ```
## Usage ## Usage
@@ -68,13 +68,15 @@ Admins can approve requests using:
## Commands ## Commands
### Admin Commands ### Admin Commands
- **`[p]setoverseerr <url> <api_key>`** - **`[p]overseerr url <url>`**
- Set the Overseerr URL and API key for the bot to communicate with Overseerr. - Set the Overseerr URL for the bot to communicate with Overseerr.
- Example: `[p]setoverseerr https://my.overseerr.url abcdefghijklmnop` - Example: `[p]overseerr https://my.overseerr.url`
- **`[p]overseerr apikey <apikey>`**
- **`[p]setadminrole <role_name>`** - Set the Overseerr API Key. retrieved from `https://your-overseerr-url/settings`.
- Example: `[p]overseerr apikey 4OK6WLU8Fv2TrZfcOskLZb2PK5WA3547Jz2fEfJqfkLiT34xUP0D48Z7jwC9lC8xU9`
- **`[p]overseerr adminrole <role_name>`**
- Set the name of the admin role that is allowed to approve Overseerr requests. - Set the name of the admin role that is allowed to approve Overseerr requests.
- Example: `[p]setadminrole Overseerr Admin` - Example: `[p]overseerr adminrole @Overseerr Admin`
### User Commands ### User Commands
- **`[p]request <media name>`** - **`[p]request <media name>`**