mirror of
https://github.com/informaticker/discord-jellyfin-bot.git
synced 2024-11-23 18:21:55 +01:00
146 lines
5.4 KiB
Markdown
146 lines
5.4 KiB
Markdown
<p align="center">
|
|
<img src="https://cdn.jsdelivr.net/gh/walkxhub/dashboard-icons/png/jellyfin.png" alt="Jellyfin Logo" width="80" height="80">
|
|
<h1 align="center">Jellyfin Discord Music Bot</h1>
|
|
<div align="center">
|
|
<span>A fork of the <a href="https://github.com/KGT1/jellyfin-discord-music-bot">original project</a> with improved readability and stability, compatible with Jellyfin 10.8.x</span>
|
|
</div>
|
|
</p>
|
|
|
|
# ✨ 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.
|
|
|
|
<br/><br/><br/><br/><br/><br/><hr/><br/>
|
|
|
|
## 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
|
|
|
|
#### Play to
|
|
|
|
Just `summon` the Bot into your Channel, than choose the Bot in Jellyfin as the Device you want to cast to
|
|
|
|
|
|
|
|
and start playing you favourite Music
|
|
|
|
#### Interactive Play Message
|
|
|
|
When you start playing something you can easily controll the Bot with just clicking on the Buttons under the Play Message
|
|
|
|
|
|
|
|
#### Commands
|
|
|
|
Beware that you'll always need to add your prefix(default: ?) in front of the command.
|
|
|
|
Command | Description
|
|
------------ | -------------
|
|
summon | Join the channel the author of the message(now you can cast to the Bot from within Jellyfin)
|
|
disconnect | Disconnect from all current Voice Channels
|
|
play | Play the following item(can be the name of the song or the Stream URL)
|
|
add | Add the following item to the current playlist
|
|
pause/resume | Pause/Resume audio
|
|
seek | Where to Seek to in seconds or MM:SS
|
|
skip | Skip this Song
|
|
spawn | Spawns an Interactive Play Controller
|
|
help | Display the help message
|
|
|
|
#### 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
|
|
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/).
|
|
|
|
Click New Application.
|
|
|
|
|
|
|
|
The Name of the application will be the bot's name.
|
|
|
|
|
|
|
|
Go to the Bot tab.
|
|
|
|
|
|
|
|
Generate the bot, and grab the token. Also, recommend making the bot private.
|
|
|
|
|
|
|
|
Go to the OAuth2 page, click Bot Scope to get the url authorization link.
|
|
|
|
|
|
|
|
Authorize your room!
|
|
|
|
|
|
|
|
Next, join a voice channel and connect your bot with ?summon. This will connect your bot to the voice channel you're in and will create the device profile in Jellyfin.
|
|
|
|
|
|
|
|
From within Jellyfin, start playing content or from within Discord, use the bot commands to start enjoying music!
|
|
|
|
For official documentation to creating a bot.
|
|
|
|
[How to retrieve your token](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot)
|
|
|
|
[How to invite the Bot to your server](https://discordjs.guide/preparations/adding-your-bot-to-servers.html#bot-invite-links)
|
|
|
|
### The simplest way to get started is using Docker:
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name jellyfin-discord-music-bot \
|
|
-e DISCORD_PREFIX="?" \
|
|
-e DISCORD_TOKEN="yourtokengoeshere" \
|
|
-e JELLYFIN_SERVER_ADDRESS="https://jellyfin.DOMAIN" \
|
|
-e JELLYFIN_USERNAME="" \
|
|
-e JELLYFIN_PASSWORD="" \
|
|
-e JELLYFIN_APP_NAME="Jellyfin Discord Music Bot" \
|
|
-e MESSAGE_UPDATE_INTERVAL="2000" \
|
|
--restart unless-stopped \
|
|
kgt1/jellyfin-discord-music-bot
|
|
```
|
|
|
|
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:
|
|
|
|
Dependencies:
|
|
|
|
- npm 6.14.6
|
|
- NodeJS v12.18.3
|
|
- ffmpeg 4.2.4
|
|
```bash
|
|
git clone https://github.com/kgt1/jellyfin-discord-music-bot.git
|
|
cd jellyfin-discord-music-bot
|
|
npm install
|
|
```
|
|
edit config.json and add your token,server-address etc.
|
|
```bash
|
|
npm run start
|
|
```
|
|
|
|
|
|
### How to build
|
|
```
|
|
git clone https://github.com/kgt1/jellyfin-discord-music-bot.git
|
|
cd jellyfin-discord-music-bot
|
|
docker build -t YOUR_IMAGE_NAME .
|
|
```
|