discord-jellyfin-bot/README.md

63 lines
2.9 KiB
Markdown
Raw Normal View History

2022-08-07 21:53:30 +02:00
<p align="center">
2022-12-15 23:57:55 +01:00
<a href="http://nestjs.com/" target="blank"><img src="https://github.com/walkxcode/dashboard-icons/blob/main/png/jellyfin.png?raw=true" width="200" alt="Nest Logo" /></a>
2022-08-07 21:53:30 +02:00
</p>
2022-12-18 14:10:24 +01:00
<br/>
<h1 align="center">Jellyfin Discord Bot</h1>
2022-08-07 21:53:30 +02:00
2022-12-18 19:58:14 +01:00
<p align="center">A simple <a href="https://discord.com" target="_blank">Discord</a> bot that enables you to broadcast<br/>your <a href="https://jellyfin.org/" target="_blank">Jellyfin Media Server</a> music collection to voice channels.<br/>It's Open Source and can easily be hosted by yourself!</p>
2022-08-07 21:53:30 +02:00
2022-12-15 23:57:55 +01:00
<p align="center">
2022-12-18 19:58:14 +01:00
<small>Thanky you <a href="https://github.com/KGT1/jellyfin-discord-music-bot/">KGT1</a> for starting this project!<br/>This is a fork of their original repository and re-uses some of their code.</small>
2022-12-15 23:57:55 +01:00
</p>
2020-10-26 13:06:34 +01:00
2022-12-19 00:20:18 +01:00
<p align="center">
<a href="https://github.com/manuel-rw/jellyfin-discord-music-bot/wiki/%F0%9F%9A%80-Installation"><img src="https://img.shields.io/badge/-Installation%20Guide-grey?style=for-the-badge&logo=discord" alt="badge" /></a>
</p>
2020-10-26 13:06:34 +01:00
2022-12-15 23:57:55 +01:00
<br/>
<hr/>
<br/>
2020-10-26 13:06:34 +01:00
2020-10-26 13:00:40 +01:00
2022-12-15 23:57:55 +01:00
## ✨ Features
2020-10-26 13:00:40 +01:00
2022-12-15 23:57:55 +01:00
- Leighweight and extendable using the [Nest](https://github.com/nestjs/nest) framework
- Easy usage with Discord command system (eg. ``/play``, ``/pause``, ...)
2022-12-18 19:58:14 +01:00
- Fast and validated configuration using environment variables
- Typesafe code for quicker development and less bugs
- Supports ``Music``, ``Playlists`` and ``Albums`` from your Jellyfin instance
2020-10-26 13:00:40 +01:00
2022-12-18 19:58:14 +01:00
## 📌 About this project
This project was originally started by [KGT1 on Github](https://github.com/KGT1/jellyfin-discord-music-bot/) in 2020. I came accross this project in late 2021, when wanted to enjoy my music on Discord. I never got it to run as I wanted it to. Since the original project was created under the MIT license, I decided to make a fork in 2022 with my own version. Although this project re-uses some code of the original project, it has been completly rewritten in other parts using NestJs and features now a module-based approach.
2022-12-18 19:58:14 +01:00
## ⛔ Limitations
2020-09-25 13:54:28 +02:00
2022-12-18 19:58:14 +01:00
- Bot does not support shards. This means, you cannot use it in multiple servers concurrently.
- Displaying media covers or images in Discord (Jellyfin is self hosted, and other users woudln't be able to see those images)
- Streaming any video content in voice channels (See [this issue](https://github.com/discordjs/discord.js/issues/4116))
2020-10-05 23:39:59 +02:00
2022-12-18 19:58:14 +01:00
## 🚀 Installation
2020-09-25 13:54:28 +02:00
2022-12-18 19:58:14 +01:00
Please check out the Wiki section in the repository for installation instructions:
2020-09-25 13:54:28 +02:00
2022-12-18 19:58:14 +01:00
https://github.com/manuel-rw/jellyfin-discord-music-bot/wiki
2022-12-15 23:57:55 +01:00
2022-12-18 19:58:14 +01:00
> Docker container comming soon
2020-09-25 13:54:28 +02:00
2022-12-18 19:58:14 +01:00
## 💻 Development
2020-09-25 13:54:28 +02:00
2022-12-18 19:58:14 +01:00
I'm open to any contributions to this project. You can start contributing using the following commands, after executing the installation commands:
2022-12-16 21:21:26 +01:00
## 👤 Credits
2022-12-18 23:27:49 +01:00
- https://tabler-icons.io/
- https://docs.nestjs.com/
- https://discord.js.org/
- https://github.com/fjodor-rybakov/discord-nestjs
- https://github.com/jellyfin/jellyfin-sdk-typescript
- https://jellyfin.org/
- https://github.com/KGT1/jellyfin-discord-music-bot
- https://gitmoji.dev/