Initial Push

2025-09-05 11:08:00 -05:00
parent a36453f2a9
commit 00a9b09fc6
4 changed files with 486 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,53 @@
 # Jellyfin-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!
+
+This is a very simple and lightweight Jellyfin Discord bot for managing users. It allows for creation of accounts, password recovery, account deletion, ect.
+
+Fill out values in the .env and you're good to go!
+
+# Features
+
+- Automatic Account Cleanup
+- Creating Accounts
+- Recovering Passwords
+- Searching accounts by Discord User, or Jellyfin User
+- Run Library Scanning
+- Manual Account Linking (For previously made Jellyfin accounts)
+- Change bot prefix live
+
+# Command Overview
+
+**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)**
+
+![image](https://cdn.pengucc.com/images/projects/jellyfin-bot/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.**
+
+![image](https://cdn.pengucc.com/images/projects/jellyfin-bot/account-deny.png)
+
+**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)
+
+**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)
+
+***User Commands***
+- !createaccount <username> <password> - Create your Jellyfin account
+- !recoveraccount <username> <newpassword> - Reset your password
+- !deleteaccount <username> - Delete your Jellyfin account
+
+***Admin Commands***
+- !syncaccounts - Remove Jellyfin accounts from users without roles
+- !searchaccount <jellyfin_username> - Find linked Discord user
+- !searchdiscord @user - Find linked Jellyfin account
+- !scanlibraries - Scan all Jellyfin libraries
+- !assignaccount <jellyfin_username> @user - Manually link accounts
+
+***Admin Bot Commands***
+- !setprefix - Change the bots command prefix