Merge origin/master

also minor edits
Conflicts:
	pom.xml

README.md

@@ -38,7 +38,5 @@ Please see the [Setup Page](https://github.com/jagrosh/MusicBot/wiki/Setup) in t
 ## 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)
 
-
-
 ## 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.
+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.

pom.xml

@@ -28,7 +28,7 @@
         <dependency>
             <groupId>com.sedmelluq</groupId>
             <artifactId>lavaplayer</artifactId>
-            <version>1.3.10</version>
+            <version>1.3.17</version>
         </dependency>
         <dependency>
             <groupId>com.jagrosh</groupId>

src/main/java/com/jagrosh/jmusicbot/BotConfig.java

@@ -24,15 +24,10 @@ import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.LinkedList;
-import java.util.List;
 import net.dv8tion.jda.core.OnlineStatus;
 import net.dv8tion.jda.core.entities.Game;
 
 /**
- * @author Your Name
- * Changes from original source:
- *  - Changed "searching" to "finding"
  * 
  * 
  * @author John Grosh (jagrosh)
@@ -41,6 +36,8 @@ public class BotConfig
 {
     private final Prompt prompt;
     private final static String CONTEXT = "Config";
+    private final static String START_TOKEN = "/// START OF JMUSICBOT CONFIG ///";
+    private final static String END_TOKEN = "/// END OF JMUSICBOT CONFIG ///";
     
     private Path path = null;
     private String token, prefix, altprefix, helpWord, playlistsFolder,
@@ -99,8 +96,8 @@ public class BotConfig
             playlistsFolder = config.getString("playlistsfolder");
             dbots = owner == 113156185389092864L;
             
-            // we may need to get some additional data and write a new config file
-            List<String> lines = new LinkedList<>();
+            // we may need to write a new config file
+            boolean write = false;
 
             // validate bot token
             if(token==null || token.isEmpty() || token.equalsIgnoreCase("BOT_TOKEN_HERE"))
@@ -116,7 +113,7 @@ public class BotConfig
                 }
                 else
                 {
-                    lines.add("token = "+token);
+                    write = true;
                 }
             }
             
@@ -142,17 +139,28 @@ public class BotConfig
                 }
                 else
                 {
-                    lines.add("owner = "+owner);
+                    write = true;
                 }
             }
             
-            if(!lines.isEmpty())
+            if(write)
             {
-                StringBuilder builder = new StringBuilder();
-                lines.stream().forEach(s -> builder.append(s).append("\r\n"));
+                String original = OtherUtil.loadResource(this, "/reference.conf");
+                byte[] bytes;
+                if(original==null)
+                {
+                    bytes = ("token = "+token+"\r\nowner = "+owner).getBytes();
+                }
+                else
+                {
+                    bytes = original.substring(original.indexOf(START_TOKEN)+START_TOKEN.length(), original.indexOf(END_TOKEN))
+                        .replace("BOT_TOKEN_HERE", token)
+                        .replace("0 // OWNER ID", Long.toString(owner))
+                        .trim().getBytes();
+                }
                 try 
                 {
-                    Files.write(path, builder.toString().trim().getBytes());
+                    Files.write(path, bytes);
                 }
                 catch(IOException ex) 
                 {

src/main/java/com/jagrosh/jmusicbot/JMusicBot.java

@@ -183,14 +183,15 @@ public class JMusicBot
         }
         catch (LoginException ex)
         {
-            log.error(ex+"\nPlease make sure you are "
+            prompt.alert(Prompt.Level.ERROR, "JMusicBot", ex + "\nPlease make sure you are "
                     + "editing the correct config.txt file, and that you have used the "
-                    + "correct token (not the 'secret'!)");
+                    + "correct token (not the 'secret'!)\nConfig Location: " + config.getConfigLocation());
             System.exit(1);
         }
         catch(IllegalArgumentException ex)
         {
-            log.error("Some aspect of the configuration is invalid: "+ex);
+            prompt.alert(Prompt.Level.ERROR, "JMusicBot", "Some aspect of the configuration is "
+                    + "invalid: " + ex + "\nConfig Location: " + config.getConfigLocation());
             System.exit(1);
         }
     }

src/main/java/com/jagrosh/jmusicbot/utils/OtherUtil.java

@@ -17,9 +17,7 @@ package com.jagrosh.jmusicbot.utils;
 
 import com.jagrosh.jmusicbot.JMusicBot;
 import com.jagrosh.jmusicbot.entities.Prompt;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.Reader;
+import java.io.*;
 import java.net.URL;
 import java.net.URLConnection;
 import net.dv8tion.jda.core.OnlineStatus;
@@ -40,6 +38,20 @@ public class OtherUtil
                     + "New Version: %s\n\n"
                     + "Please visit https://github.com/jagrosh/MusicBot/releases/latest to get the latest release.";
     
+    public static String loadResource(Object clazz, String name)
+    {
+        try(BufferedReader reader = new BufferedReader(new InputStreamReader(clazz.getClass().getResourceAsStream(name))))
+        {
+            StringBuilder sb = new StringBuilder();
+            reader.lines().forEach(line -> sb.append("\r\n").append(line));
+            return sb.toString().trim();
+        }
+        catch(IOException ex)
+        {
+            return null;
+        }
+    }
+    
     public static InputStream imageFromUrl(String url)
     {
         if(url==null)

src/main/resources/reference.conf

@@ -1,3 +1,4 @@
+/// START OF JMUSICBOT CONFIG ///
 /////////////////////////////////////////////////////////
 // Config for the JMusicBot                            //
 /////////////////////////////////////////////////////////
@@ -20,7 +21,7 @@ token = BOT_TOKEN_HERE
 // This needs to be the owner's ID (a 17-18 digit number)
 // https://github.com/jagrosh/MusicBot/wiki/Finding-Your-User-ID
 
-owner = 0
+owner = 0 // OWNER ID
 
 
 // This sets the prefix for the bot
@@ -119,7 +120,7 @@ updatealerts=true
 // If you are interested in contributing a provider, please see
 // https://github.com/jagrosh/JLyrics
 
-lyrics.default = "MusicMatch"
+lyrics.default = "A-Z Lyrics"
 
 
 // If you set this to true, it will enable the eval command for the bot owner. This command
@@ -134,3 +135,6 @@ lyrics.default = "MusicMatch"
 // IF SOMEONE ASKS YOU TO ENABLE THIS, THERE IS AN 11/10 CHANCE THEY ARE TRYING TO SCAM YOU
 
 eval=false
+
+
+/// END OF JMUSICBOT CONFIG ///