Add help command and command categories

src/main/java/wtf/beatrice/hidekobot/HidekoBot.java

@@ -136,6 +136,7 @@ public class HidekoBot
         messageCommandListener.registerCommand(new wtf.beatrice.hidekobot.commands.message.CoinFlipCommand());
         messageCommandListener.registerCommand(new wtf.beatrice.hidekobot.commands.message.ClearCommand());
         messageCommandListener.registerCommand(new wtf.beatrice.hidekobot.commands.message.DiceRollCommand());
+        messageCommandListener.registerCommand(new wtf.beatrice.hidekobot.commands.message.HelpCommand());
         messageCommandListener.registerCommand(new wtf.beatrice.hidekobot.commands.message.InviteCommand());
         messageCommandListener.registerCommand(new wtf.beatrice.hidekobot.commands.message.LoveCalculatorCommand());
         messageCommandListener.registerCommand(new wtf.beatrice.hidekobot.commands.message.MagicBallCommand());

src/main/java/wtf/beatrice/hidekobot/commands/message/AvatarCommand.java

@@ -9,6 +9,7 @@ import org.jetbrains.annotations.Nullable;
 import wtf.beatrice.hidekobot.Cache;
 import wtf.beatrice.hidekobot.HidekoBot;
 import wtf.beatrice.hidekobot.commands.base.Avatar;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.util.Collections;
@@ -34,6 +35,11 @@ public class AvatarCommand  implements MessageCommand
         return false;
     }
 
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.TOOLS;
+    }
+
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args)
     {

src/main/java/wtf/beatrice/hidekobot/commands/message/BotInfoCommand.java

@@ -6,6 +6,7 @@ import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import org.jetbrains.annotations.Nullable;
 import wtf.beatrice.hidekobot.Cache;
 import wtf.beatrice.hidekobot.commands.base.BotInfo;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.util.Collections;
@@ -31,6 +32,11 @@ public class BotInfoCommand implements MessageCommand
         return false;
     }
 
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.TOOLS;
+    }
+
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args) {
 

src/main/java/wtf/beatrice/hidekobot/commands/message/ClearCommand.java

@@ -6,6 +6,7 @@ import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
 import wtf.beatrice.hidekobot.Cache;
 import wtf.beatrice.hidekobot.commands.base.ClearChat;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.util.Collections;
@@ -27,6 +28,10 @@ public class ClearCommand implements MessageCommand
     public boolean passRawArgs() {
         return false;
     }
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.MODERATION;
+    }
 
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args)

src/main/java/wtf/beatrice/hidekobot/commands/message/CoinFlipCommand.java

@@ -4,6 +4,7 @@ import net.dv8tion.jda.api.Permission;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import org.jetbrains.annotations.Nullable;
 import wtf.beatrice.hidekobot.commands.base.CoinFlip;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.util.Arrays;
@@ -29,6 +30,11 @@ public class CoinFlipCommand implements MessageCommand
         return false;
     }
 
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.FUN;
+    }
+
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args) {
 

src/main/java/wtf/beatrice/hidekobot/commands/message/DiceRollCommand.java

@@ -6,6 +6,7 @@ import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import org.jetbrains.annotations.Nullable;
 import wtf.beatrice.hidekobot.Cache;
 import wtf.beatrice.hidekobot.objects.Dice;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.util.*;
@@ -28,6 +29,11 @@ public class DiceRollCommand implements MessageCommand
         return false;
     }
 
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.FUN;
+    }
+
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args)
     {

src/main/java/wtf/beatrice/hidekobot/commands/message/HelloCommand.java

@@ -2,6 +2,7 @@ package wtf.beatrice.hidekobot.commands.message;
 
 import net.dv8tion.jda.api.Permission;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.util.Arrays;
@@ -24,6 +25,11 @@ public class HelloCommand implements MessageCommand
         return false;
     }
 
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.FUN;
+    }
+
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args)
     {

src/main/java/wtf/beatrice/hidekobot/commands/message/HelpCommand.java

@@ -0,0 +1,95 @@
+package wtf.beatrice.hidekobot.commands.message;
+
+import net.dv8tion.jda.api.EmbedBuilder;
+import net.dv8tion.jda.api.Permission;
+import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
+import org.apache.commons.text.WordUtils;
+import org.jetbrains.annotations.Nullable;
+import wtf.beatrice.hidekobot.Cache;
+import wtf.beatrice.hidekobot.commands.base.Say;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
+import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
+
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.LinkedList;
+import java.util.List;
+
+public class HelpCommand implements MessageCommand
+{
+
+
+    @Override
+    public LinkedList<String> getCommandLabels() {
+        return new LinkedList<>(Collections.singletonList("help"));
+    }
+
+    @Nullable
+    @Override
+    public List<Permission> getPermissions() { return null; }
+
+    @Override
+    public boolean passRawArgs() {
+        return false;
+    }
+
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.TOOLS;
+    }
+
+    @Override
+    public void runCommand(MessageReceivedEvent event, String label, String[] args)
+    {
+        LinkedHashMap<CommandCategory, LinkedList<MessageCommand>> commandCategories = new LinkedHashMap<>();
+
+        if(args.length == 0)
+        {
+            for(CommandCategory category : CommandCategory.values())
+            {
+                LinkedList<MessageCommand> commandsOfThisCategory = new LinkedList<>();
+                for (MessageCommand command : Cache.getMessageCommandListener().getRegisteredCommands())
+                {
+                    if(command.getCategory().equals(category))
+                    {
+                        commandsOfThisCategory.add(command);
+                    }
+                }
+
+                commandCategories.put(category, commandsOfThisCategory);
+            }
+
+            EmbedBuilder embedBuilder = new EmbedBuilder();
+            embedBuilder.setColor(Cache.getBotColor());
+            embedBuilder.setTitle("Bot Help");
+
+            embedBuilder.addField("General Help",
+                    "Type `" + Cache.getBotPrefix() + " help [command]` to get help on a specific command." +
+                            "\nYou will find a list of commands organized in categories below.",
+                    false);
+
+            for(CommandCategory category : commandCategories.keySet())
+            {
+                StringBuilder commandsList = new StringBuilder();
+                LinkedList<MessageCommand> commandsOfThisCategory = commandCategories.get(category);
+
+                for(int pos = 0; pos < commandsOfThisCategory.size(); pos++)
+                {
+                    MessageCommand command = commandsOfThisCategory.get(pos);
+                    commandsList.append("`").append(command.getCommandLabels().get(0)).append("`");
+
+                    if(pos + 1 != commandsOfThisCategory.size())
+                        commandsList.append(", "); // separate with comma except on last run
+                }
+
+                String niceCategoryName = category.name().replace("_", " ");
+                niceCategoryName = WordUtils.capitalizeFully(niceCategoryName);
+                niceCategoryName = category.getEmoji() + " " + niceCategoryName;
+
+                embedBuilder.addField(niceCategoryName, commandsList.toString(), false);
+            }
+
+            event.getMessage().replyEmbeds(embedBuilder.build()).queue();
+        }
+    }
+}

src/main/java/wtf/beatrice/hidekobot/commands/message/InviteCommand.java

@@ -7,6 +7,7 @@ import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
 import org.jetbrains.annotations.Nullable;
 import wtf.beatrice.hidekobot.commands.base.Invite;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.util.Collections;
@@ -32,6 +33,11 @@ public class InviteCommand implements MessageCommand
         return false;
     }
 
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.FUN;
+    }
+
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args)
     {

src/main/java/wtf/beatrice/hidekobot/commands/message/LoveCalculatorCommand.java

@@ -9,6 +9,7 @@ import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import org.jetbrains.annotations.Nullable;
 import wtf.beatrice.hidekobot.Cache;
 import wtf.beatrice.hidekobot.HidekoBot;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 import wtf.beatrice.hidekobot.util.RandomUtil;
 
@@ -37,6 +38,11 @@ public class LoveCalculatorCommand implements MessageCommand
         return false;
     }
 
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.FUN;
+    }
+
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args)
     {

src/main/java/wtf/beatrice/hidekobot/commands/message/MagicBallCommand.java

@@ -4,6 +4,7 @@ import net.dv8tion.jda.api.Permission;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import org.jetbrains.annotations.Nullable;
 import wtf.beatrice.hidekobot.commands.base.MagicBall;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.util.LinkedList;
@@ -28,6 +29,11 @@ public class MagicBallCommand implements MessageCommand
         return false;
     }
 
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.FUN;
+    }
+
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args)
     {

src/main/java/wtf/beatrice/hidekobot/commands/message/SayCommand.java

@@ -4,6 +4,7 @@ import net.dv8tion.jda.api.Permission;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import org.jetbrains.annotations.Nullable;
 import wtf.beatrice.hidekobot.commands.base.Say;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.util.Collections;
@@ -28,6 +29,11 @@ public class SayCommand implements MessageCommand
         return true;
     }
 
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.TOOLS;
+    }
+
     @Override
     public void runCommand(MessageReceivedEvent event, String label, String[] args)
     {

src/main/java/wtf/beatrice/hidekobot/commands/message/UrbanDictionaryCommand.java

@@ -9,6 +9,7 @@ import org.jsoup.Jsoup;
 import org.jsoup.nodes.Document;
 import org.jsoup.select.Elements;
 import wtf.beatrice.hidekobot.commands.base.UrbanDictionary;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 
 import java.io.IOException;
@@ -34,7 +35,10 @@ public class UrbanDictionaryCommand implements MessageCommand
         return false;
     }
 
-
+    @Override
+    public CommandCategory getCategory() {
+        return CommandCategory.FUN;
+    }
 
 
     @Override

src/main/java/wtf/beatrice/hidekobot/listeners/MessageCommandListener.java

@@ -7,14 +7,12 @@ import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
 import org.jetbrains.annotations.NotNull;
+import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
 import wtf.beatrice.hidekobot.objects.comparators.MessageCommandAliasesComparator;
 import wtf.beatrice.hidekobot.util.Logger;
 
-import java.util.Arrays;
+import java.util.*;
-import java.util.LinkedList;
-import java.util.List;
-import java.util.TreeMap;
 
 public class MessageCommandListener extends ListenerAdapter
 {
@@ -23,6 +21,10 @@ public class MessageCommandListener extends ListenerAdapter
     private final TreeMap<LinkedList<String>, MessageCommand> registeredCommands =
             new TreeMap<LinkedList<String>, MessageCommand>(new MessageCommandAliasesComparator());
 
+    // map commands and their categories.
+    // this is not strictly needed but it's better to have it so we avoid looping every time we need to check the cat.
+    LinkedHashMap<CommandCategory, LinkedList<MessageCommand>> commandCategories = new LinkedHashMap<>();
+
     private final String commandRegex = "(?i)^(hideko|hde)\\b";
     // (?i) -> case insensitive flag
     // ^ -> start of string (not in middle of a sentence)

src/main/java/wtf/beatrice/hidekobot/objects/commands/CommandCategory.java

@@ -0,0 +1,18 @@
+package wtf.beatrice.hidekobot.objects.commands;
+
+public enum CommandCategory
+{
+    MODERATION("️\uD83D\uDC40"),
+    FUN("\uD83C\uDFB2"),
+    TOOLS("\uD83D\uDEE0"),
+
+    ;
+
+    private String emoji;
+    CommandCategory(String emoji)
+    {
+        this.emoji = emoji;
+    }
+
+    public String getEmoji() { return emoji; }
+}

src/main/java/wtf/beatrice/hidekobot/objects/commands/MessageCommand.java

@@ -39,6 +39,13 @@ public interface MessageCommand
      */
     boolean passRawArgs();
 
+    /**
+     * Say what category this command belongs to.
+     *
+     * @return the command category.
+     */
+    CommandCategory getCategory();
+
     /**
      * Run the command logic by parsing the event and replying accordingly.
      *