GMusicBot/README.md

42 lines
3.4 KiB
Markdown
Raw Normal View History

2017-10-13 05:41:16 +02:00
<img align="right" src="https://i.imgur.com/zrE80HY.png" height="200" width="200">
2019-01-13 21:51:26 +01:00
# JMusicBot
2017-10-13 05:35:35 +02:00
[![Downloads](https://img.shields.io/github/downloads/jagrosh/MusicBot/total.svg)](https://github.com/jagrosh/MusicBot/releases/latest)
2018-11-27 21:04:21 +01:00
[![Stars](https://img.shields.io/github/stars/jagrosh/MusicBot.svg)](https://github.com/jagrosh/MusicBot/stargazers)
2017-10-13 05:35:35 +02:00
[![Release](https://img.shields.io/github/release/jagrosh/MusicBot.svg)](https://github.com/jagrosh/MusicBot/releases/latest)
[![License](https://img.shields.io/github/license/jagrosh/MusicBot.svg)](https://github.com/jagrosh/MusicBot/blob/master/LICENSE)
2018-11-27 15:25:50 +01:00
[![Discord](https://discordapp.com/api/guilds/147698382092238848/widget.png)](https://discord.gg/0p9LSGoRLu6Pet0k)<br>
2018-11-27 15:25:30 +01:00
[![CircleCI](https://img.shields.io/circleci/project/github/jagrosh/MusicBot/master.svg)](https://circleci.com/gh/jagrosh/MusicBot)
2018-11-27 16:01:04 +01:00
[![AppVeyor](https://ci.appveyor.com/api/projects/status/gdu6nyte5psj6xfk/branch/master?svg=true)](https://ci.appveyor.com/project/jagrosh/musicbot/branch/master)
2019-01-13 21:51:26 +01:00
[![CodeFactor](https://www.codefactor.io/repository/github/jagrosh/musicbot/badge)](https://www.codefactor.io/repository/github/jagrosh/musicbot)
2017-10-13 05:35:35 +02:00
2019-01-13 21:53:19 +01:00
A cross-platform 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)
2018-12-05 05:37:45 +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
* Supports many sites, including Youtube, Soundcloud, and more
* Supports many online radio/streams
* Supports local files
* Playlist support (both web/youtube, and local)
2019-01-13 21:51:26 +01:00
## Example
2019-01-13 21:53:19 +01:00
![Loading Example...](https://i.imgur.com/kVtTKvS.gif)
2019-01-13 21:51:26 +01:00
2018-12-05 05:37:45 +01:00
## Setup
2017-01-05 17:45:02 +01:00
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
2018-12-05 05:37:45 +01:00
## Questions/Suggestions/Bug Reports
2017-10-19 05:54:55 +02:00
**Please read the [Suggested/Planned Features List](https://github.com/jagrosh/MusicBot/projects/1) before suggesting a feature**. 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). (Note: I will not accept any feature requests that will require additional API keys, nor any non-music features). 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
2018-12-05 05:37:45 +01:00
## Editing
2019-06-07 20:48:26 +02:00
This bot (and the source code here) might not be easy to edit for inexperienced programmers. The main purpose of having the source public is to show the capabilities of the libraries, to allow others to understand how the bot works, and to allow those knowledgeable about java, JDA, and Discord bot development to contribute. 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 choose to make edits, please do so in accordance with the Apache 2.0 License.