From 765a6fccc2ada689256d57301396a1a4167146d6 Mon Sep 17 00:00:00 2001
From: Manuel <30572287+manuel-rw@users.noreply.github.com>
Date: Sun, 7 Aug 2022 21:53:30 +0200
Subject: [PATCH] Add fork information in the Readme
---
README.md | 37 ++++++++++++++++++++++++++++---------
1 file changed, 28 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index d15399c..9c54057 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,29 @@
-# Jellyfin Discord Music Bot
+
+
+
Jellyfin Discord Music Bot
+
+
A fork of the original project with improved readability and stability, compatible with Jellyfin 10.8.x
+
+
+
+# ✨ Features
+- Simple Discord Bot that hooks into the [Jellyfin](http://github.com/jellyfin/jellyfin) API of your instance
+- Request, pause and play songs directly from your Discord Server
+- Interactive Media control message to control playback
+
+# 🦾 About this fork
+The original version is decent for Jellyfin 10.6.x and before. After the breaking changes of 10.7 and 10.8, users were unable to stream music from their Jellyfin.
+For this reason, I made this fork to address those changes to the API and improve the bot with my own ideas / features. Please check out the original project by [KGT1](https://github.com/KGT1).
+
+I will gradually update documentation & code of the bot. Please wait patiently.
+
+## Original README from https://github.com/KGT1/jellyfin-discord-music-bot
Jellyfin Discord Music Bot is a Discord Bot for the [Jellyfin Media Server!](http://github.com/jellyfin/jellyfin)
-## Capabilities
+### Capabilities
-### Play to
+#### Play to
Just `summon` the Bot into your Channel, than choose the Bot in Jellyfin as the Device you want to cast to
@@ -12,13 +31,13 @@ Just `summon` the Bot into your Channel, than choose the Bot in Jellyfin as the
and start playing you favourite Music
-### Interactive Play Message
+#### Interactive Play Message
When you start playing something you can easily controll the Bot with just clicking on the Buttons under the Play Message
![Image to Interactive Play Message](img/discordplaymessage.png)
-### Commands
+#### Commands
Beware that you'll always need to add your prefix(default: ?) in front of the command.
@@ -34,12 +53,12 @@ skip | Skip this Song
spawn | Spawns an Interactive Play Controller
help | Display the help message
-### Limitations
+#### Limitations
- No Playlist Repeat Mode.
- Multi Server support.
- [Playing Video Content](https://github.com/discordjs/discord.js/issues/4116) (if Discord ever adds this, I'll implement it into this Bot)
-## Getting Started
+### Getting Started
You'll need a Discord Application for this Bot to work, as you will host it yourself.
[Generate an Api and bot here](https://discord.com/developers/applications/).
@@ -98,7 +117,7 @@ docker run -d \
MESSAGE_UPDATE_INTERVAL is the amount of time in ms the play message gets updated with the current time
-### Alternatively you can run the Application natively with NodeJS:
+#### Alternatively you can run the Application natively with NodeJS:
Dependencies:
@@ -116,7 +135,7 @@ npm run start
```
-## How to build
+### How to build
```
git clone https://github.com/kgt1/jellyfin-discord-music-bot.git
cd jellyfin-discord-music-bot