streamlined logging & updated readme

Author: Dainternetdude

README.md

@@ -1,6 +1,5 @@
 # What is this?
 This is a Discord bot written in Java that can link the chat of Minecraft servers with Discord channels.
-<img width="1440" alt="Screenshot of the program running on a blank desktop" src="https://user-images.githubusercontent.com/53956237/136717891-a6233941-3776-4acb-9a66-50c6ec680d4d.png">
 
 # Why should I use this one instead of countless others?
 Here's what makes this implementation unique:

build.gradle

@@ -4,7 +4,7 @@ plugins {
 }
 
 group 'org.example'
-version '1.7'
+version '1.7.1'
 
 repositories {
     mavenCentral()

src/main/java/dain/Bot.java

@@ -1,15 +1,11 @@
 package dain;
 
-import dain.events.DiscordMessageReceiver;
+import dain.events.*;
 import net.dv8tion.jda.api.*;
-import net.dv8tion.jda.api.entities.Activity;
-import net.dv8tion.jda.api.entities.TextChannel;
-import javax.security.auth.login.LoginException;
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.util.Locale;
-import java.util.Scanner;
+import net.dv8tion.jda.api.entities.*;
+
+import javax.security.auth.login.*;
+import java.util.*;
 
 public class Bot {
 
@@ -45,7 +41,7 @@ public void startChatBridge() {
         TextChannel [] channels = new TextChannel[Settings.DISCORD_CHANNEL_IDS.length];
         for(int i = 0; i < Settings.DISCORD_CHANNEL_IDS.length; i++) {
             channels[i] = jda.getTextChannelById(Settings.DISCORD_CHANNEL_IDS[i]);
-            Logger.log("Chat Bridge active.", Logger.LoggingLevel.INFO);
+            Logger.info("Chat Bridge active.");
             channels[i].sendMessage("Chat bridge active.").queue();
         }
 

src/main/java/dain/DiscordBotFrame.java

@@ -2,9 +2,7 @@
 
 import javax.swing.*;
 import java.awt.*;
-import java.awt.event.ActionListener;
-import java.awt.event.ActionEvent;
-import java.util.Objects;
+import java.util.*;
 
 public class DiscordBotFrame extends JFrame {
 
@@ -26,11 +24,9 @@ public DiscordBotFrame() {
         addComponent(settingsLabel, layout, 1, 0, 1, 1, GridBagConstraints.NONE);
 
         JButton settingsButton = new JButton(); // no text on settings button just gear icon
-        settingsButton.addActionListener(new ActionListener() {
-            public void actionPerformed(ActionEvent event) {
-                if(event.getSource() == settingsButton) {
-                    new SettingsFrame();
-                }
+        settingsButton.addActionListener(event -> {
+            if(event.getSource() == settingsButton) {
+                new SettingsFrame();
             }
         });
         ImageIcon settingsIcon = new ImageIcon(Objects.requireNonNull(getClass().getClassLoader().getResource("settings-icon.png")));
@@ -47,8 +43,8 @@ public void actionPerformed(ActionEvent event) {
         logTextArea.setEnabled(false);
         JScrollPane logScrollPane = new JScrollPane(logTextArea);
         logScrollPane.setWheelScrollingEnabled(false); // do not allow scrolling with mouse scroll wheel
-        logScrollPane.setHorizontalScrollBarPolicy(31); // 31 = never show horizontal scroll bar
-        logScrollPane.setVerticalScrollBarPolicy(21); // 21 = never show vertical scroll bar
+        logScrollPane.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
+        logScrollPane.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER);
         addComponent(logScrollPane, layout, 0, 3, 2, 1, GridBagConstraints.NONE);
         Logger.setTextArea(logTextArea);
 
@@ -71,7 +67,7 @@ private static void sleap(int ms) {
         try {
             Thread.sleep(ms);
         } catch(InterruptedException exception) {
-            Logger.log("thread interrupted exception", Logger.LoggingLevel.ERROR);
+            Logger.error("thread interrupted exception");
         }
     }
 

src/main/java/dain/FTPHandler.java

@@ -39,7 +39,7 @@ public static void grabFile(String file, int serverId) {
             ftpClient.disconnect();
 
         } catch (IOException e) {
-            Logger.log("I/O Exception during FTP handling", Logger.LoggingLevel.ERROR);
+            Logger.error("I/O Exception during FTP handling");
         }
     }
 }

src/main/java/dain/Logger.java

@@ -6,15 +6,15 @@ public class Logger {
 
 	private static JTextArea textArea;
 
-	public enum LoggingLevel {
+	private enum LoggingLevel {
 		INFO, WARN, ERROR, FATAL
 	}
 
 	public static void setTextArea(JTextArea textAreaIn) {
 		textArea = textAreaIn;
 	}
 
-	public static void log(String message, LoggingLevel level) {
+	private static void log(String message, LoggingLevel level) {
 		String string = "[" + level;
 		string = string + " @ " + java.time.LocalTime.now() + "]: ";
 		string = string + message;
@@ -27,4 +27,20 @@ public static void log(String message, LoggingLevel level) {
 
 		System.out.print(string);
 	}
+	
+	public static void info(String message) {
+		log(message, LoggingLevel.INFO);
+	}
+	
+	public static void warn(String message) {
+		log(message, LoggingLevel.WARN);
+	}
+	
+	public static void error(String message) {
+		log(message, LoggingLevel.ERROR);
+	}
+	
+	public static void fatal(String message) {
+		log(message, LoggingLevel.FATAL);
+	}
 }

src/main/java/dain/MinecraftChatBridge.java

@@ -5,7 +5,6 @@
 import net.dv8tion.jda.api.entities.TextChannel;
 import net.kronos.rkon.core.Rcon;
 import net.kronos.rkon.core.ex.AuthenticationException;
-
 import java.io.*;
 import java.util.*;
 
@@ -40,7 +39,7 @@ public void run() {
             try {
                 Thread.sleep(100);
             } catch (InterruptedException e) {
-                Logger.log("thread interrupted while sleeping", Logger.LoggingLevel.FATAL);
+                Logger.fatal("thread interrupted while sleeping");
                 System.exit(-1);
             }
         }
@@ -61,7 +60,7 @@ public boolean sendNewMessage() {
 
             scanner.close();
         } catch (FileNotFoundException e) {
-            Logger.log("File not found. Where is latest.log?", Logger.LoggingLevel.ERROR);
+            Logger.error("File not found. Where is latest.log?");
             e.printStackTrace();
         }
 
@@ -79,13 +78,13 @@ public boolean sendNewMessage() {
         if (line.matches("Done \\(\\d+\\.\\d*s\\)!.*")) serverInitIsDone = true;
         if (!serverInitIsDone) return true;
 
-        Logger.log("Message received from Minecraft: " + line, Logger.LoggingLevel.INFO);
+        Logger.info("Message received from Minecraft: " + line);
 
         String processedLine = processLine(line);
 
         sendMessageAllChannels(processedLine);
 
-        Logger.log("Message sent to Discord: " + processedLine, Logger.LoggingLevel.INFO);
+        Logger.info("Message sent to Discord: " + processedLine);
 
         return true;
     }
@@ -195,7 +194,7 @@ public static void sendMessageToMc(Message message) {
         for (int id = 0; id < Settings.SERVER_IPS.length; id++) {
             sendCommandToServer(command, id);
         }
-        Logger.log("Message sent to Minecraft: " + message, Logger.LoggingLevel.INFO);
+        Logger.info("Message sent to Minecraft: " + message);
     }
 
     public static void sendMessageToServer(String author, String message, int serverId) {

src/main/java/dain/Settings.java

@@ -1,8 +1,7 @@
 package dain;
 
 import java.io.*;
-import java.nio.channels.SeekableByteChannel;
-import java.util.Scanner;
+import java.util.*;
 
 public class Settings {
 
@@ -50,7 +49,7 @@ public static void initialize() {
         }
 
         if (isLocal) {
-            Logger.log("Bot is running in local mode. Server IPs & FTP login details will be overridden.", Logger.LoggingLevel.WARN);
+            Logger.warn("Bot is running in local mode. Server IPs & FTP login details will be overridden.");
             SERVER_IPS = new String[] {"127.0.0.1"};
             FTP_USERNAMES = new String[0];
             FTP_PASSWORDS = new String[0];

src/main/java/dain/events/DiscordMessageReceiver.java

@@ -9,17 +9,17 @@
 
 public class DiscordMessageReceiver extends ListenerAdapter {
 
-    private enum Commands { // todo maybe better as an enum?
+    private enum Commands {
             KILL("kill"),
             SCORE("score"),
             HELP("help");
 
-            private String value;
+            private final String value;
 
-        private Commands(String valueIn) {
+        Commands(String valueIn) {
             this.value = valueIn;
         }
-    };
+    }
 
     @Override
     public void onMessageReceived(MessageReceivedEvent event) {
@@ -44,10 +44,9 @@ public void onMessageReceived(MessageReceivedEvent event) {
 
         for (int id = 0; id < Settings.DISCORD_CHANNEL_IDS.length; id++) { // for all Discord channels ids in config
             if (event.getChannel() == event.getJDA().getTextChannelById(Settings.DISCORD_CHANNEL_IDS[id])) { // if the channel id from the config matches one of the channel id that the message was sent from //todo need to optimize this
-                Logger.log("Message received from Discord: " + messageSent, Logger.LoggingLevel.INFO);
+                Logger.info("Message received from Discord: " + messageSent);
                 MinecraftChatBridge.sendMessageToMc(event.getMessage()); // send message to mc
             }
         }
-        return;
     }
 }