GMusicBot/README.md

30 lines
1.8 KiB
Markdown
Raw Normal View History

2017-01-05 17:45:02 +01:00
# JMusicBot
2016-08-14 20:46:29 +02:00
A Discord music bot with a clean interface, and that is easy to set up and run yourself
2016-08-14 20:47:23 +02:00
2017-04-26 18:42:39 +02:00
[![Setup](http://i.imgur.com/VvXYp5j.png)](https://github.com/jagrosh/MusicBot/wiki/Setup)
2017-01-05 17:45:02 +01:00
# Features
* Easy to run (just make sure Java is installed, and run!)
* Fast loading of songs
* No external keys needed (besides a Discord Bot token)
* Smooth playback
* Server-specific setup for the "DJ" role that can moderate the music
* Clean and beautiful menus
* Channel-topic playback bar
2017-01-27 06:09:36 +01:00
* Supports many sites, including Youtube, Soundcloud, and more
* Supports many online radio/streams
* Supports local files
* Playlist support (both web/youtube, and local)
2017-01-05 17:45:02 +01:00
# Setup
Please see the [Setup Page](https://github.com/jagrosh/MusicBot/wiki/Setup) in the wiki to run this bot yourself!
2017-01-14 17:11:29 +01:00
# Questions/Suggestions/Bug Reports
2017-01-27 06:09:36 +01:00
If you'd like to suggest changes to how the bot functions, recommend more customization options, or report bugs, feel free to either open an [Issue](https://github.com/jagrosh/MusicBot/issues) on this repository, or join [my Discord server](https://discord.gg/0p9LSGoRLu6Pet0k). If you like this bot, be sure to add a star to the libraries that make this possible: [**JDA**](https://github.com/DV8FromTheWorld/JDA) and [**lavaplayer**](https://github.com/sedmelluq/lavaplayer)
2017-01-14 17:11:29 +01:00
2017-07-04 08:32:26 +02:00
# Editing
This bot (and the source code here) is not meant to be edited. The main purpose of having the source public is to show the capabilities of the libraries, and to allow others to understand how the bot works. There are many requirements and dependencies required to edit and compile it, and there will not be support provided for people looking to make changes on their own. Instead, consider making a feature request (see the above section). If you still choose to make edits, please do so in accordance with the Apache 2.0 License.
2017-01-14 17:11:29 +01:00
# Example
![Example](http://i.imgur.com/gxDdlRL.png)