Update Readme

This commit is contained in:
2025-09-06 19:41:58 -05:00
parent f1acaf529a
commit 2621fa45e5
2 changed files with 14 additions and 7 deletions

View File

@@ -1,4 +1,10 @@
# Jellyfin-Discord # Jellycord
![image](https://cdn.pengucc.com/images/projects/jellycord/readme/BannerRound.png)
[![Online Members](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscordapp.com%2Fapi%2Finvites%2FBkmEarDQxq%3Fwith_counts%3Dtrue&query=approximate_presence_count&style=for-the-badge&logo=discord&logoColor=white&label=ONLINE%20MEMBERS&labelColor=grey&color=239eda)](https://discord.gg/BkmEarDQxq)
![Latest Version:](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FPenguCCN%2FJellycord%2Fmain%2Fversion.json&query=%24.version&style=for-the-badge&logo=python&logoColor=white&color=239eda)
Allow the creation and management of Jellyfin users via Discord Allow the creation and management of Jellyfin users via Discord
Join my [Discord](https://discord.com/invite/zJMUNCPtPy) for help, and keeping an eye out for updates! Join my [Discord](https://discord.com/invite/zJMUNCPtPy) for help, and keeping an eye out for updates!
@@ -7,7 +13,7 @@ This is a very simple and lightweight Jellyfin Discord bot for managing users. I
Fill out values in the .env and you're good to go! Fill out values in the .env and you're good to go!
# Features ## Features
- Automatic Account Cleanup - Automatic Account Cleanup
- Creating Accounts - Creating Accounts
@@ -18,25 +24,25 @@ Fill out values in the .env and you're good to go!
- Change bot prefix live - Change bot prefix live
- Checks for new releases - Checks for new releases
# Command Overview ## Command Overview
**Pinging the bot will show you the necessary commands to create your account.** **Pinging the bot will show you the necessary commands to create your account.**
**PLEASE NOTE BEFORE USING. THIS BOT IS MEANT TO USE REQUIRED ROLES IN ORDER TO WHITELIST USERS FOR JELLYFIN. TAKING A USERS ROLE AWAY WILL DELETE THEIR JELLYFIN ACCOUNT WHEN THE BOT RUNS ITS CLEANUP (24 Hour Schedule or Admin Forced)** **PLEASE NOTE BEFORE USING. THIS BOT IS MEANT TO USE REQUIRED ROLES IN ORDER TO WHITELIST USERS FOR JELLYFIN. TAKING A USERS ROLE AWAY WILL DELETE THEIR JELLYFIN ACCOUNT WHEN THE BOT RUNS ITS CLEANUP (24 Hour Schedule or Admin Forced)**
![image](https://cdn.pengucc.com/images/projects/jellyfin-bot/ping.png) ![image](https://cdn.pengucc.com/images/projects/jellycord/readme/ping.png)
**There are protections in place to stop users from creating an account where people can see. If a user sends the account creation or reset in a guild, the bot will delete it.** **There are protections in place to stop users from creating an account where people can see. If a user sends the account creation or reset in a guild, the bot will delete it.**
![image](https://cdn.pengucc.com/images/projects/jellyfin-bot/account-deny.png) ![image](https://cdn.pengucc.com/images/projects/jellycord/readme/account-deny.png)
**If a user already has a linked Jellyfin account, the bot will not allow them to create another account.** **If a user already has a linked Jellyfin account, the bot will not allow them to create another account.**
![image](https://cdn.pengucc.com/images/projects/jellyfin-bot/account-limit.png) ![image](https://cdn.pengucc.com/images/projects/jellycord/readme/account-limit.png)
**In order to create an account, you must have the required roles specified in the .env** **In order to create an account, you must have the required roles specified in the .env**
![image](https://cdn.pengucc.com/images/projects/jellyfin-bot/role-required.png) ![image](https://cdn.pengucc.com/images/projects/jellycord/readme/role-required.png)
***User Commands*** ***User Commands***
- `!createaccount` <username> <password> - Create your Jellyfin account - `!createaccount` <username> <password> - Create your Jellyfin account

1
version.json Normal file
View File

@@ -0,0 +1 @@
{ "version": "1.0.2" }