extended README

This commit is contained in:
KGT1 2020-09-21 07:58:15 +02:00
parent 9d802099ff
commit 99b67ad9a9

View File

@ -2,7 +2,33 @@
Jellyfin Discord Music Bot is a Discord Bot for the [Jellyfin Media Server!](http://github.com/jellyfin/jellyfin)
## Capabilities
### 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)
pause/resume | Pause/Resume audio
help | Display the help message
### Limitations
- Playlist (soon)
- Seek to functionality (soon)
- [Playing Video Content](https://support.discord.com/hc/en-us/community/posts/360059238512-Add-Go-Live-support-for-API) (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.
[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: