Update docs

core/src/main/java/ch/andre601/advancedserverlist/core/commands/CommandHandler.java

@@ -25,14 +25,26 @@
 
 package ch.andre601.advancedserverlist.core.commands;
 
+import ch.andre601.advancedserverlist.api.profiles.ProfileEntry;
 import ch.andre601.advancedserverlist.core.AdvancedServerList;
 import ch.andre601.advancedserverlist.core.interfaces.commands.CmdSender;
 import ch.andre601.advancedserverlist.core.interfaces.commands.PluginCommand;
 import ch.andre601.advancedserverlist.core.migration.minimotd.MiniMOTDConfigMigrator;
 import ch.andre601.advancedserverlist.core.migration.serverlistplus.SLPConfigMigrator;
+import ch.andre601.advancedserverlist.core.profiles.ServerListProfile;
+import ch.andre601.advancedserverlist.core.profiles.profile.ProfileSerializer;
+import org.spongepowered.configurate.ConfigurationNode;
+import org.spongepowered.configurate.serialize.SerializationException;
+import org.spongepowered.configurate.yaml.NodeStyle;
+import org.spongepowered.configurate.yaml.YamlConfigurationLoader;
 
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.Arrays;
+import java.util.Comparator;
 import java.util.List;
+import java.util.Locale;
 
 public class CommandHandler{
     
@@ -40,13 +52,18 @@ public class CommandHandler{
     
     public CommandHandler(AdvancedServerList<?> core){
         subCommands = List.of(
-            new Help(),
+            new Help(core),
             new Reload(core),
             new ClearCache(core),
-            new Migrate(core)
+            new Migrate(core),
+            new Profiles(core)
         );
     }
     
+    public List<PluginCommand> getSubCommands(){
+        return subCommands;
+    }
+    
     public void handle(CmdSender sender, String[] args){
         if(args.length == 0){
             sender.sendErrorMsg("<red>Too few arguments! Use <grey>/asl help</grey> for a list of commands.");
@@ -54,11 +71,11 @@ public class CommandHandler{
         }
         
         for(PluginCommand subCommand : subCommands){
-            if(subCommand.getArgument().equalsIgnoreCase(args[0])){
-                if(!sender.hasPermission(subCommand.getPermission())){
+            if(subCommand.name().equalsIgnoreCase(args[0])){
+                if(!sender.hasPermission(subCommand.permission())){
                     sender.sendErrorMsg(
                         "<red>You do not have the permission <grey>%s</grey> to execute this command.",
-                        subCommand.getPermission()
+                        subCommand.permission()
                     );
                     return;
                 }
@@ -73,21 +90,54 @@ public class CommandHandler{
     
     private static class Help extends PluginCommand{
         
-        public Help(){
+        private final AdvancedServerList<?> core;
+        
+        public Help(AdvancedServerList<?> core){
             super("help");
+            
+            this.core = core;
         }
     
         @Override
         public void handle(CmdSender sender, String[] args){
-            sender.sendPrefixedMsg("- Commands");
-            sender.sendMsg();
-            sender.sendMsg("<aqua>/asl <white>help <grey>- Shows this help");
-            sender.sendMsg();
-            sender.sendMsg("<aqua>/asl <white>reload <grey>- Reloads the config.yml and profiles");
-            sender.sendMsg();
-            sender.sendMsg("<aqua>/asl <white>clearCache <grey>- Clears the Player and Favicon cache");
-            sender.sendMsg();
-            sender.sendMsg("<aqua>/asl <white>migrate <grey><</grey>plugin<grey>> - Migrates configuration of another plugin");
+            sender.sendPrefixedMsg("- Commands. Hover for details.");
+            for(PluginCommand command : core.getCommandHandler().getSubCommands()){
+                sender.sendPrefixedMsg("");
+                sender.sendPrefixedMsg(
+                    "<aqua><hover:show_text:\"%s\">" +
+                    "<click:suggest_command:/asl %s>" +
+                    "/asl <white>%s</white>" +
+                    "</click>" +
+                    "</hover></aqua>",
+                    getCommandHover(command),
+                    command.name(),
+                    command.name()
+                );
+            }
+        }
+        
+        @Override
+        public String usage(){
+            return "<aqua>/asl <white>help</white></aqua>";
+        }
+        
+        @Override
+        public String description(){
+            return "Shows all available commands.";
+        }
+        
+        private String getCommandHover(PluginCommand command){
+            return String.format(
+                """
+                <grey>Usage: %s
+                Permission: <white>%s</white>
+                
+                <white>%s</white>
+                """,
+                command.usage(),
+                command.permission(),
+                command.description()
+            );
         }
     }
     
@@ -119,6 +169,16 @@ public class CommandHandler{
             
             sender.sendPrefixedMsg("<green>Reload complete!");
         }
+        
+        @Override
+        public String usage(){
+            return "<aqua>/asl <white>reload</white></aqua>";
+        }
+        
+        @Override
+        public String description(){
+            return "Reloads the main config and all profiles.";
+        }
     }
     
     private static class ClearCache extends PluginCommand{
@@ -126,7 +186,7 @@ public class CommandHandler{
         private final AdvancedServerList<?> core;
         
         public ClearCache(AdvancedServerList<?> core){
-            super("clearCache");
+            super("clearcache");
             
             this.core = core;
         }
@@ -143,6 +203,16 @@ public class CommandHandler{
             
             sender.sendPrefixedMsg("<green>Cache clearing complete!");
         }
+        
+        @Override
+        public String usage(){
+            return "<aqua>/asl <white>clearcache</white></aqua>";
+        }
+        
+        @Override
+        public String description(){
+            return "Clears the Favicon and Player Cache.";
+        }
     }
     
     private static class Migrate extends PluginCommand{
@@ -195,5 +265,191 @@ public class CommandHandler{
                 sender.sendErrorMsg(" - MiniMOTD");
             }
         }
+        
+        @Override
+        public String usage(){
+            return "<aqua>/asl <white>migrate <grey>\\<</grey>Plugin<grey>></grey></white></aqua>";
+        }
+        
+        @Override
+        public String description(){
+            return "Migrates the configuration from supported Plugins to AdvancedServerList.";
+        }
+    }
+    
+    private static class Profiles extends PluginCommand{
+        
+        private final AdvancedServerList<?> core;
+        
+        public Profiles(AdvancedServerList<?> core){
+            super("profiles");
+            
+            this.core = core;
+        }
+        
+        @Override
+        public void handle(CmdSender sender, String[] args){
+            if(args.length == 0){
+                sender.sendErrorMsg("<red>Invalid command usage.");
+                sender.sendErrorMsg("<red>Usage:</red> %s", usage());
+                return;
+            }
+            
+            switch(args[0].toLowerCase(Locale.ROOT)){
+                case "list" -> {
+                    List<ServerListProfile> profiles = core.getFileHandler().getProfiles().stream()
+                        .sorted(Comparator.comparing(ServerListProfile::priority).reversed())
+                        .toList();
+                    
+                    sender.sendPrefixedMsg("Available Profiles:");
+                    for(ServerListProfile profile : profiles){
+                        sender.sendPrefixedMsg("- <white><hover:show_text:\"%s\">%s</hover></white>", getHover(profile), profile.file());
+                    }
+                }
+                case "add" -> {
+                    if(args.length == 1){
+                        sender.sendErrorMsg("<red>Insufficient arguments.");
+                        sender.sendErrorMsg("<red>Usage:</red> /asl profiles add <name>");
+                        return;
+                    }
+                    
+                    String name = getProfileName(args[1]);
+                    
+                    if(core.getFileHandler().getProfiles().stream().anyMatch(profile -> profile.file().equalsIgnoreCase(name))){
+                        sender.sendErrorMsg("<red>A profile with file name</red> %s <red>already exists!");
+                        return;
+                    }
+                    
+                    if(core.getFileHandler().createFile(name)){
+                        sender.sendPrefixedMsg("<green>Successfully created</green> %s<green>!", name);
+                        sender.sendPrefixedMsg("<green>Load the file using</green> /asl reload");
+                    }else{
+                        sender.sendErrorMsg("<red>Error while trying to create</red> %s<red>!", name);
+                        sender.sendErrorMsg("<red>Check console for further details.");
+                    }
+                }
+                case "copy" -> {
+                    if(args.length < 3){
+                        sender.sendErrorMsg("<red>Insufficient arguments.");
+                        sender.sendErrorMsg("<red>Usage:</red> /asl profiles copy <profile> <name>");
+                        return;
+                    }
+                    
+                    String name = getProfileName(args[1]);
+                    String copy = getProfileName(args[2]);
+                    
+                    ServerListProfile targetProfile = core.getFileHandler().getProfiles().stream()
+                        .filter(file -> file.file().equalsIgnoreCase(name))
+                        .findFirst()
+                        .orElse(null);
+                    boolean copyExists = core.getFileHandler().getProfiles().stream()
+                        .anyMatch(profile -> profile.file().equals(copy));
+                    
+                    if(targetProfile == null){
+                        sender.sendErrorMsg("<red>There is no file with name</red> %s<red>!", name);
+                        return;
+                    }
+                    
+                    if(copyExists){
+                        sender.sendErrorMsg("<red>A profile with file name</red> %s <red>already exists!", copy);
+                        return;
+                    }
+                    
+                    Path profilePath = core.getPlugin().getFolderPath().resolve("profiles").resolve(copy);
+                    try{
+                        Files.createFile(profilePath);
+                    }catch(IOException ex){
+                        sender.sendErrorMsg("<red>There was an error while creating the file</red> %s<red>!");
+                        sender.sendErrorMsg("<red>Check console for further details.");
+                        
+                        core.getPlugin().getPluginLogger().warn("Encountered IOException while creating file %s", ex, copy);
+                        return;
+                    }
+                    
+                    YamlConfigurationLoader loader = YamlConfigurationLoader.builder()
+                        .path(profilePath)
+                        .indent(2)
+                        .nodeStyle(NodeStyle.BLOCK)
+                        .defaultOptions(options -> options.serializers(builder -> builder.register(ProfileEntry.class, ProfileSerializer.INSTANCE)))
+                        .build();
+                    
+                    ConfigurationNode node;
+                    try{
+                        node = loader.load();
+                    }catch(IOException ex){
+                        sender.sendErrorMsg("<red>There was an error while loading the file</red> %s<red>!");
+                        sender.sendErrorMsg("<red>Check console for further details.");
+                        
+                        core.getPlugin().getPluginLogger().warn("Encountered IOException while loading file %s", ex, copy);
+                        return;
+                    }
+                    
+                    if(node == null){
+                        sender.sendErrorMsg("Cannot copy</red> %s <red>to</red> %s<red>. ConfigurationNode was null.", name, copy);
+                        return;
+                    }
+                    
+                    try{
+                        node.node("priority").set(targetProfile.priority());
+                        node.node("condition").set(targetProfile.condition());
+                        
+                        node.node("profiles").setList(ProfileEntry.class, targetProfile.profiles());
+                        
+                        node.set(ProfileEntry.class, targetProfile.defaultProfile());
+                    }catch(SerializationException ex){
+                        sender.sendErrorMsg("<red>There was an Error while copying values from</red> %s <red>to</red> %s<red>.", name, copy);
+                        sender.sendErrorMsg("<red>Check console for details.");
+                        return;
+                    }
+                    
+                    try{
+                        loader.save(node);
+                        sender.sendPrefixedMsg("<green>Successfully created copy of</green> %s <green>as</green> %s<green>!", name, copy);
+                        sender.sendPrefixedMsg("<green>Load the file using</green> /asl reload");
+                    }catch(IOException ex){
+                        sender.sendErrorMsg("<red>There was an Error while trying to save</red> %s<red>!", copy);
+                        sender.sendErrorMsg("<red>Check console for details.");
+                    }
+                }
+                default -> {
+                    sender.sendErrorMsg("<red>Unknown argument</red> %s<red>!", args[0]);
+                    sender.sendErrorMsg("<red>Usage:</red> %s", usage());
+                }
+            }
+        }
+        
+        @Override
+        public String usage(){
+            return "<aqua>/asl <white>profiles</white> <grey><" +
+                "<white>add</white> <<white>name</white>> | " +
+                "<white>copy</white> <<white>profile</white>> <<white>name</white>> | " +
+                "<white>list</white>" +
+                "></grey></aqua>";
+        }
+        
+        @Override
+        public String description(){
+            return "Creates a new profile, copies one from an existing file, or lists all available profiles.";
+        }
+        
+        private String getHover(ServerListProfile profile){
+            return String.format(
+                """
+                <grey>Priority: <white>%s</white>
+                Condition: <white>%s</white>
+                
+                Valid profile: %s
+                """,
+                profile.priority(),
+                profile.condition() == null || profile.condition().isEmpty() ? "<i>None</i>" : profile.condition(),
+                profile.isInvalidProfile() ? "<red>No</red>" : "<green>Yes</green>"
+            );
+        }
+        
+        private String getProfileName(String name){
+            String fileName = name.toLowerCase(Locale.ROOT);
+            
+            return fileName.endsWith(".yml") ? fileName : fileName + ".yml";
+        }
     }
 }

core/src/main/java/ch/andre601/advancedserverlist/core/file/FileHandler.java

@@ -99,23 +99,36 @@ public class FileHandler{
     
     public boolean loadProfiles(){
         logger.info("Loading profiles...");
-        if(!profilesFolder.toFile().exists() && profilesFolder.toFile().mkdirs()){
+        
+        if(createFile("default.yml")){
+            return reloadProfiles();
+        }else{
+            return false;
+        }
+    }
+    
+    public boolean createFile(String name){
+        if(Files.notExists(profilesFolder) && profilesFolder.toFile().mkdirs()){
             logger.info("Successfully created profiles folder.");
-            
-            try(InputStream stream = plugin.getClass().getResourceAsStream("/profiles/default.yml")){
-                if(stream == null){
-                    logger.warn("Cannot retrieve default.yml from Plugin.");
-                    return false;
-                }
-                
-                Files.copy(stream, profilesFolder.resolve("default.yml"));
-            }catch(IOException ex){
-                logger.warn("Cannot create default.yml for plugin.", ex);
-                return false;
-            }
         }
         
-        return reloadProfiles();
+        File file = new File(profilesFolder.toFile(), name);
+        if(file.exists()){
+            return true;
+        }
+        
+        try(InputStream stream = plugin.getClass().getResourceAsStream("/profiles/default.yml")){
+            if(stream == null){
+                logger.warn("Cannot retrieve content of internal default.yml file.");
+                return false;
+            }
+            
+            Files.copy(stream, profilesFolder.resolve(name));
+            return true;
+        }catch(IOException ex){
+            logger.warn("Encountered IOException while trying to create file %s", ex, name);
+            return false;
+        }
     }
     
     public boolean migrateConfig(){

core/src/main/java/ch/andre601/advancedserverlist/core/interfaces/commands/PluginCommand.java

@@ -35,13 +35,17 @@ public abstract class PluginCommand{
         this.argument = argument;
     }
     
-    public String getArgument(){
+    public String name(){
         return argument;
     }
     
-    public String getPermission(){
-        return "advancedserverlist.command." + getArgument().toLowerCase(Locale.ROOT);
+    public String permission(){
+        return "advancedserverlist.command." + name().toLowerCase(Locale.ROOT);
     }
     
     public abstract void handle(CmdSender sender, String[] args);
+    
+    public abstract String usage();
+    
+    public abstract String description();
 }

docs/commands/index.md

@@ -19,8 +19,9 @@ The following subcommands are available (Subcommands are case-insensitive):
 - [`reload`](#reload)
 - [`clearCache`](#clearcache)
 - [`migrate <plugin>`](#migrate)
+- [`profiles <add <profile> | copy <profile> <name> | list>`](#profiles)
 
-### help
+### `help`
 
 **Permission:** `advancedserverlist.command.help`
 
@@ -28,7 +29,7 @@ Shows a list of all available [subcommands](#subcommands) for AdvancedServerList
 
 ----
 
-### reload
+### `reload`
 
 **Permission:** `advancedserverlist.command.reload`
 
@@ -36,7 +37,7 @@ Reloads the plugin's `config.yml` and all available YAML files in the `profiles`
 
 ----
 
-### clearCache
+### `clearcache`
 
 **Permission:** `advancedserverlist.command.clearcache`
 
@@ -44,7 +45,7 @@ Clears the currently cached favicons and players.
 
 ----
 
-### migrate &lt;plugin&gt; { #migrate }
+### `migrate <plugin>` { #migrate }
 
 **Permission:** `advancedserverlist.command.migrate`
 
@@ -53,4 +54,18 @@ Clears the currently cached favicons and players.
 - `<plugin>` - The plugin to migrate from.
 
 Migrates files from one plugin over to AdvancedServerList.  
-Check the [Migration Page](../migration/index.md) for a list of supported plugins.
+Check the [Migration Page](../migration/index.md) for a list of supported plugins.
+
+----
+
+### `profiles <add <profile> | copy <profile> <name> | list>` { #profiles }
+
+**Permission:** `advancedserverlist.command.profiles`
+
+**Arguments:**
+
+- `add <profile>` - Creates a new profile with name `<profile>` using the default profile values.
+- `copy <profile> <name>` - Creates a copy of `<profile>` and saves it as `<name>`.
+- `list` - Lists all loaded profiles. The entries have hover text for extra info.
+
+Creates, copies or shows profiles in AdvancedServerList.

pom.xml

@@ -37,7 +37,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         
-        <plugin.version>4.10.0</plugin.version>
+        <plugin.version>4.11.0</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
         <api.version>3.3.0</api.version>