From 43398449c7e752ccf2d8457dd2deddfc2ca07b12 Mon Sep 17 00:00:00 2001 From: John Grosh Date: Sun, 13 Jan 2019 15:51:26 -0500 Subject: [PATCH] more cleanup and update readme --- README.md | 12 ++++++++---- src/main/java/com/jagrosh/jmusicbot/JMusicBot.java | 2 +- .../java/com/jagrosh/jmusicbot/utils/FormatUtil.java | 2 +- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1edb8df..dad765e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ +# JMusicBot + [![Downloads](https://img.shields.io/github/downloads/jagrosh/MusicBot/total.svg)](https://github.com/jagrosh/MusicBot/releases/latest) [![Stars](https://img.shields.io/github/stars/jagrosh/MusicBot.svg)](https://github.com/jagrosh/MusicBot/stargazers) [![Release](https://img.shields.io/github/release/jagrosh/MusicBot.svg)](https://github.com/jagrosh/MusicBot/releases/latest) @@ -8,9 +10,9 @@ [![CircleCI](https://img.shields.io/circleci/project/github/jagrosh/MusicBot/master.svg)](https://circleci.com/gh/jagrosh/MusicBot) [![Travis-CI](https://travis-ci.com/jagrosh/MusicBot.svg?branch=master)](https://travis-ci.com/jagrosh/MusicBot) [![AppVeyor](https://ci.appveyor.com/api/projects/status/gdu6nyte5psj6xfk/branch/master?svg=true)](https://ci.appveyor.com/project/jagrosh/musicbot/branch/master) +[![CodeFactor](https://www.codefactor.io/repository/github/jagrosh/musicbot/badge)](https://www.codefactor.io/repository/github/jagrosh/musicbot) -## JMusicBot -A Discord music bot with a clean interface, and that is easy to set up and run yourself +A cross-platform Discord music bot with a clean interface, and that is easy to set up and run yourself [![Setup](http://i.imgur.com/VvXYp5j.png)](https://github.com/jagrosh/MusicBot/wiki/Setup) @@ -27,14 +29,16 @@ A Discord music bot with a clean interface, and that is easy to set up and run y * Supports local files * Playlist support (both web/youtube, and local) +## Example +![Example](https://i.imgur.com/kVtTKvS.gifv) + ## Setup Please see the [Setup Page](https://github.com/jagrosh/MusicBot/wiki/Setup) in the wiki to run this bot yourself! ## Questions/Suggestions/Bug Reports **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) -## Example -![Example](https://i.imgur.com/tevrtKt.png) + ## 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. diff --git a/src/main/java/com/jagrosh/jmusicbot/JMusicBot.java b/src/main/java/com/jagrosh/jmusicbot/JMusicBot.java index f7dcea6..3f445af 100644 --- a/src/main/java/com/jagrosh/jmusicbot/JMusicBot.java +++ b/src/main/java/com/jagrosh/jmusicbot/JMusicBot.java @@ -87,7 +87,7 @@ public class JMusicBot new String[]{"High-quality music playback", "FairQueue™ Technology", "Easy to host yourself"}, RECOMMENDED_PERMS); aboutCommand.setIsAuthor(false); - aboutCommand.setReplacementCharacter("\uD83C\uDFB6"); + aboutCommand.setReplacementCharacter("\uD83C\uDFB6"); // 🎶 // set up the command client CommandClientBuilder cb = new CommandClientBuilder() diff --git a/src/main/java/com/jagrosh/jmusicbot/utils/FormatUtil.java b/src/main/java/com/jagrosh/jmusicbot/utils/FormatUtil.java index ed0059c..d30e724 100644 --- a/src/main/java/com/jagrosh/jmusicbot/utils/FormatUtil.java +++ b/src/main/java/com/jagrosh/jmusicbot/utils/FormatUtil.java @@ -92,6 +92,6 @@ public class FormatUtil { public static String filter(String input) { - return input.replace("@everyone", "@\u0435veryone").replace("@here", "@h\u0435re").trim(); + return input.replace("@everyone", "@\u0435veryone").replace("@here", "@h\u0435re").trim(); // cyrillic letter e } }