Try new Bungeecord version to fix CI

Reviewed-on: https://codeberg.org/Andre601/AdvancedServerList/pulls/395

addons/banplugins/pom.xml

@@ -99,7 +99,7 @@
         <dependency>
             <groupId>space.arim.libertybans</groupId>
             <artifactId>bans-api</artifactId>
-            <version>1.1.0-RC1</version>
+            <version>1.1.0-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

bungeecord/pom.xml

@@ -49,6 +49,10 @@
             <id>sonatype</id>
             <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
         </repository>
+        <repository>
+            <id>repo-sayandevelopment</id>
+            <url>https://repo.sayandev.org/snapshots</url>
+        </repository>
     </repositories>
     
     <dependencies>
@@ -69,14 +73,14 @@
         <dependency>
             <groupId>net.md-5</groupId>
             <artifactId>bungeecord-api</artifactId>
-            <version>1.20-R0.2</version>
+            <version>1.21-R0.1-SNAPSHOT</version>
             <type>jar</type>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>net.md-5</groupId>
             <artifactId>bungeecord-api</artifactId>
-            <version>1.20-R0.2</version>
+            <version>1.21-R0.1-SNAPSHOT</version>
             <type>javadoc</type>
             <scope>provided</scope>
         </dependency>
@@ -124,6 +128,18 @@
             <version>2.9.0-4</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>org.sayandev</groupId>
+            <artifactId>sayanvanish-api</artifactId>
+            <version>1.6.1</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.sayandev</groupId>
+            <artifactId>sayanvanish-proxy-bungeecord</artifactId>
+            <version>1.6.1</version>
+            <scope>provided</scope>
+        </dependency>
         
         <!-- Other -->
         <dependency>

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/BungeeCordCore.java

@@ -47,6 +47,7 @@ import net.md_5.bungee.api.connection.ProxiedPlayer;
 import net.md_5.bungee.api.plugin.Plugin;
 import org.bstats.bungeecord.Metrics;
 import org.bstats.charts.SimplePie;
+import org.sayandev.sayanvanish.bungeecord.api.SayanVanishBungeeAPI;
 
 import java.awt.image.BufferedImage;
 import java.nio.file.Path;
@@ -210,6 +211,9 @@ public class BungeeCordCore extends Plugin implements PluginCore<Favicon>{
         // Exclude players when PremiumVanish is enabled and player is hidden.
         if(getProxy().getPluginManager().getPlugin("PremiumVanish") != null){
             players.removeIf(BungeeVanishAPI::isInvisible);
+        }else // Do the same if SayanVanish is enabled.
+        if(getProxy().getPluginManager().getPlugin("SayanVanish") != null){
+            players.removeIf(player -> SayanVanishBungeeAPI.getInstance().isVanished(player.getUniqueId()));
         }
         
         return players.size();

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/listeners/BungeeEventWrapper.java

@@ -118,6 +118,11 @@ public class BungeeEventWrapper implements GenericEventWrapper<Favicon, BungeePl
             ping.getPlayers().setSample(players);
     }
     
+    @Override
+    public void setPlayersHidden(){
+        ping.getPlayers().setSample(new ServerPing.PlayerInfo[0]);
+    }
+    
     @Override
     public void setFavicon(Favicon favicon){
         ping.setFavicon(favicon);

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

@@ -102,43 +102,27 @@ public class CommandHandler{
         public void handle(CmdSender sender, String[] args){
             sender.sendPrefixedMsg("- Commands. Hover for details.");
             for(PluginCommand command : core.getCommandHandler().getSubCommands()){
-                sender.sendPrefixedMsg("");
-                sender.sendPrefixedMsg(
-                    "<aqua><hover:show_text:\"%s\">" +
+                sender.sendMsg();
+                sender.sendMsg(
                     "<click:suggest_command:/asl %s>" +
-                    "/asl <white>%s</white>" +
-                    "</click>" +
-                    "</hover></aqua>",
-                    getCommandHover(command),
-                    command.name(),
+                    command.usage() +
+                    "</click>",
                     command.name()
                 );
+                sender.sendMsg("<grey>[<hover:show_text:\"%s\"><white>Permission</white></hover>]</grey>", command.permission());
             }
         }
         
         @Override
         public String usage(){
-            return "<aqua>/asl <white>help</white></aqua>";
+            return new CommandStringBuilder("help", description())
+                .build();
         }
         
         @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()
-            );
-        }
     }
     
     private static class Reload extends PluginCommand{
@@ -172,7 +156,8 @@ public class CommandHandler{
         
         @Override
         public String usage(){
-            return "<aqua>/asl <white>reload</white></aqua>";
+            return new CommandStringBuilder("reload", description())
+                .build();
         }
         
         @Override
@@ -206,7 +191,8 @@ public class CommandHandler{
         
         @Override
         public String usage(){
-            return "<aqua>/asl <white>clearcache</white></aqua>";
+            return new CommandStringBuilder("clearcache", description())
+                .build();
         }
         
         @Override
@@ -268,7 +254,18 @@ public class CommandHandler{
         
         @Override
         public String usage(){
-            return "<aqua>/asl <white>migrate <grey>\\<</grey>Plugin<grey>></grey></white></aqua>";
+            return new CommandStringBuilder("migrate", description())
+                .appendSpace()
+                .appendArgument(new CommandStringBuilder.ArgumentBuilder("Plugin").description(
+                    """
+                    The Plugin to migrate from.
+                    Supported options:
+                    
+                    - <white>ServerListPlus</white>
+                    - <white>MiniMOTD</white>
+                    """
+                ).build())
+                .build();
         }
         
         @Override
@@ -422,11 +419,32 @@ public class CommandHandler{
         
         @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>";
+            return new CommandStringBuilder("profiles", "Creates a new profile, copies one from an existing file, or lists all available profiles.")
+                .appendSpace()
+                .appendText("<grey>\\<")
+                // add <name>
+                .appendLiteralArgument("add", "Adds a new profile using the default values.")
+                .appendSpace()
+                .appendArgument(new CommandStringBuilder.ArgumentBuilder("name").description("Name of the new profile").required().build())
+                // Divider
+                .appendSpace()
+                .appendText("|")
+                .appendSpace()
+                // copy <profile> <name>
+                .appendLiteralArgument("copy", "Creates a copy of the provided profile.")
+                .appendSpace()
+                .appendArgument(new CommandStringBuilder.ArgumentBuilder("profile").description("The profile to copy.").required().build())
+                .appendSpace()
+                .appendArgument(new CommandStringBuilder.ArgumentBuilder("name").description("Name of the copy.").required().build())
+                // Divider
+                .appendSpace()
+                .appendText("|")
+                .appendSpace()
+                // list
+                .appendLiteralArgument("list", "Lists all currently know profiles and wether they are valid or not.")
+                // Closing bracket
+                .appendText("></grey>")
+                .build();
         }
         
         @Override

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

@@ -0,0 +1,110 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022-2025 Andre_601
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package ch.andre601.advancedserverlist.core.commands;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class CommandStringBuilder{
+    
+    private final List<CommandPart> commandParts = new ArrayList<>();
+    
+    public CommandStringBuilder(String subcommand, String description){
+        appendText("<hover:show_text:\"<grey>" + description + "</grey>\"><white>" + subcommand + "</white></hover>");
+    }
+    
+    public CommandStringBuilder appendArgument(Argument argument){
+        this.commandParts.add(argument);
+        return this;
+    }
+    
+    public CommandStringBuilder appendText(String text){
+        this.commandParts.add(new Text(text));
+        return this;
+    }
+    
+    public CommandStringBuilder appendLiteralArgument(String name, String description){
+        return appendText("<hover:show_text:\"<grey>" + description + "</grey>\"><white>" + name + "</white></hover>");
+    }
+    
+    public CommandStringBuilder appendSpace(){
+        return appendText(" ");
+    }
+    
+    public String build(){
+        StringBuilder builder = new StringBuilder("<aqua>/asl ");
+        for(CommandPart part : commandParts){
+            builder.append(part.build());
+        }
+        builder.append("</aqua>"); // Closing the first color tag.
+        
+        return builder.toString();
+    }
+    
+    public static class ArgumentBuilder{
+        private final String name;
+        
+        private String description = "No description provided.";
+        private boolean required = false;
+        
+        public ArgumentBuilder(String name){
+            this.name = name;
+        }
+        
+        public ArgumentBuilder description(String description){
+            this.description = description;
+            return this;
+        }
+        
+        public ArgumentBuilder required(){
+            this.required = true;
+            return this;
+        }
+        
+        public Argument build(){
+            return new Argument(name, description, required);
+        }
+    }
+    
+    private record Text(String text) implements CommandPart{
+        @Override
+        public String build(){
+            return text();
+        }
+    }
+    
+    private record Argument(String name, String description, boolean required) implements CommandPart{
+        @Override
+        public String build(){
+            return "<hover:show_text:\"<grey>" + description() + "</grey>\">" +
+                "<grey>" + (required() ? "\\<" : "[") + "<white>" + name() + "</white>" + (required() ? ">" : "]") +
+                "</grey></hover>";
+        }
+    }
+    
+    private interface CommandPart{
+        String build();
+    }
+}

core/src/main/java/ch/andre601/advancedserverlist/core/events/PingEventHandler.java

@@ -175,7 +175,13 @@ public class PingEventHandler{
             );
         }
         
-        if(ProfileManager.checkOption(entry.players()) && !hidePlayers && ignoreMaintenance(event, "playerCountHover")){
+        boolean hidePlayersHover = ProfileManager.checkOption(entry.hidePlayersHoverEnabled());
+        if(hidePlayersHover){
+            logger.debug(PingEventHandler.class, "'playerCount -> hidePlayersHover' option set. Hiding Player Hover...");
+            event.setPlayersHidden();
+        }
+        
+        if(ProfileManager.checkOption(entry.players()) && !hidePlayers && !hidePlayersHover && ignoreMaintenance(event, "playerCountHover")){
             logger.debug(PingEventHandler.class, "'playerCount -> hover' option set. Applying ['%s']...", String.join("', '", entry.players()));
             
             event.setPlayers(entry.players(), player, server);

core/src/main/java/ch/andre601/advancedserverlist/core/interfaces/events/GenericEventWrapper.java

@@ -52,6 +52,8 @@ public interface GenericEventWrapper<F, P extends GenericPlayer>{
     
     void setPlayers(List<String> players, P player, GenericServer server);
     
+    void setPlayersHidden();
+    
     void setFavicon(F favicon);
     
     void setDefaultFavicon();

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/profile/ProfileManager.java

@@ -56,6 +56,7 @@ public class ProfileManager{
         NullBool extraPlayersEnabled = resolve(defEntry, entry, ProfileEntry::extraPlayersEnabled);
         NullBool maxPlayersEnabled = resolve(defEntry, entry, ProfileEntry::maxPlayersEnabled);
         NullBool onlinePlayersEnabled = resolve(defEntry, entry, ProfileEntry::onlinePlayersEnabled);
+        NullBool hidePlayersHoverEnabled = resolve(defEntry, entry, ProfileEntry::hidePlayersHoverEnabled);
         String extraPlayersCount = resolve(defEntry, entry, ProfileEntry::extraPlayersCount);
         String maxPlayersCount = resolve(defEntry, entry, ProfileEntry::maxPlayersCount);
         String onlinePlayersCount = resolve(defEntry, entry, ProfileEntry::onlinePlayersCount);
@@ -69,6 +70,7 @@ public class ProfileManager{
             .extraPlayersEnabled(extraPlayersEnabled)
             .maxPlayersEnabled(maxPlayersEnabled)
             .onlinePlayersEnabled(onlinePlayersEnabled)
+            .hidePlayersHoverEnabled(hidePlayersHoverEnabled)
             .extraPlayersCount(extraPlayersCount)
             .maxPlayersCount(maxPlayersCount)
             .onlinePlayersCount(onlinePlayersCount)
@@ -96,6 +98,7 @@ public class ProfileManager{
         NullBool extraPlayersEnabled = resolveNullBool(node, "playerCount", "extraPlayers", "enabled");
         NullBool maxPlayersEnabled = resolveNullBool(node, "playerCount", "maxPlayers", "enabled");
         NullBool onlinePlayersEnabled = resolveNullBool(node, "playerCount", "onlinePlayers", "enabled");
+        NullBool hidePlayersHoverEnabled = resolveNullBool(node, "playerCount", "hidePlayersHover");
         String extraPlayers = resolveNullableString(node, "playerCount", "extraPlayers", "amount");
         String maxPlayers = resolveNullableString(node, "playerCount", "maxPlayers", "amount");
         String onlinePlayers = resolveNullableString(node, "playerCount", "onlinePlayers", "amount");
@@ -109,6 +112,7 @@ public class ProfileManager{
             .extraPlayersEnabled(extraPlayersEnabled)
             .maxPlayersEnabled(maxPlayersEnabled)
             .onlinePlayersEnabled(onlinePlayersEnabled)
+            .hidePlayersHoverEnabled(hidePlayersHoverEnabled)
             .extraPlayersCount(extraPlayers)
             .maxPlayersCount(maxPlayers)
             .onlinePlayersCount(onlinePlayers)

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/profile/ProfileSerializer.java

@@ -53,6 +53,7 @@ public class ProfileSerializer implements TypeSerializer<ProfileEntry>{
         node.node("playerCount", "text").set(profile.playerCountText());
         node.node("favicon").set(profile.favicon());
         node.node("playerCount", "hidePlayers").set(profile.hidePlayersEnabled().getOrDefault(false));
+        node.node("playerCount", "hidePlayersHover").set(profile.hidePlayersHoverEnabled().getOrDefault(false));
         node.node("playerCount", "extraPlayers", "enabled").set(profile.extraPlayersEnabled().getOrDefault(false));
         node.node("playerCount", "extraPlayers", "amount").set((profile.extraPlayersCount() == null) ? "0" : profile.extraPlayersCount());
         node.node("playerCount", "maxPlayers", "enabled").set(profile.maxPlayersEnabled().getOrDefault(false));

docs/api/changelog.md

@@ -7,6 +7,15 @@ icon: octicons/log-24
 This page lists the recent changes made towards the AdvancedServerListAPI.  
 They are ordered newest to oldest.
 
+## v4.1.0 { #v4.1.0 }
+
+### :octicons-plus-circle-24:{ .changelog-added title="Added" } Added { #v-added }
+
+- New setter method added to [`ProfileEntry.Builder`][profileentry.builder] class:
+    - [`hidePlayersHoverEnabled(NullBool)`][hidePlayersHoverEnabled]
+
+[hidePlayersHoverEnabled]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#hideplayershoverenabled(nullbool)
+
 ## v4.0.0 { #v4.0.0 }
 
 ### :octicons-alert-24:{ .changelog-breaking title="Breaking Changes" } Breaking Changes { #v4.0.0-breaking }
@@ -21,7 +30,7 @@ They are ordered newest to oldest.
     - [`onlinePlayersCount(String)`][onlinePlayersCount]
     - [`onlinePlayersEnabled(NullBool)`][onlinePlayersEnabled]
 
-[onlinePlayersCount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#onlineplayerscount(integer)
+[onlinePlayersCount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#onlineplayerscount(string)
 [onlinePlayersEnabled]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#onlineplayersenabled(nullbool)
 
 ## v3.3.0 { #v3.3.0 }
@@ -53,11 +62,11 @@ They are ordered newest to oldest.
     - [`playerCountText(String)`][playercounttext]
     - [`players(List<String>)`][players]
 
-[extraplayerscount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#extraplayerscount(integer)
+[extraplayerscount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#extraplayerscount(string)
 [extraplayersenabled]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#extraplayersenabled(nullbool)
 [favicon]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#favicon(string)
 [hideplayersenabled]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#hideplayersenabled(nullbool)
-[maxplayerscount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#maxplayerscount(integer)
+[maxplayerscount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#maxplayerscount(string)
 [maxplayersenabled]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#maxplayersenabled(nullbool)
 [motd]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#motd(list<string>)
 [playercounttext]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#playercounttext(string)
@@ -119,9 +128,9 @@ They are ordered newest to oldest.
     - [`maxPlayersEnabled()`][maxplayersenabled] - Returns the value for `playerCount -> maxPlayers -> enabled` as `NullBool`
     - [`maxPlayersCount()`][maxplayerscount] - Returns the value of `playerCount -> maxPlayers -> amount` as nullable `Integer`
 - New setters in [`ProfileEntry.Builder`][profileentry.builder]:
-    - [`setMaxPlayersEnabled(NullBool)`][setmaxplayersenabled] - Sets whether the max players feature is enabled or not.
-    - [`setMaxPlayersCount(Integer)`][setmaxplayerscount] - Sets the number to use for the max players count.
-    - [`setExtraPlayersCount(Integer)`][setextraplayersecount] - Replacement for [deprecated `setExtraPlayerCount(Integer)` method](#v3.1.0-deprecated).
+    - `setMaxPlayersEnabled(NullBool)`- Sets whether the max players feature is enabled or not.
+    - `setMaxPlayersCount(Integer)` - Sets the number to use for the max players count.
+    - `setExtraPlayersCount(Integer)` - Replacement for [deprecated `setExtraPlayerCount(Integer)` method](#v3.1.0-deprecated).
 
 ### :octicons-zap-24:{ .changelog-breaking title="Deprecated" } Deprecated { #v3.1.0-deprecated }
 
@@ -132,9 +141,6 @@ They are ordered newest to oldest.
 [maxplayerscount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/index.md#maxplayerscount()
 
 [profileentry.builder]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md
-[setmaxplayersenabled]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#setmaxplayersenabled(nullbool)
-[setmaxplayerscount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#setmaxplayerscount(integer)
-[setextraplayersecount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#setextraplayerscount(integer)
 
 ----
 

docs/api/reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md

@@ -13,14 +13,16 @@ constructors:
 methods:
   - name: 'extraPlayersCount'
     description: |
-      Sets the number of players to add to the online players to use as the new max players value.<br>
+      Sets the value to resolve into a number by AdvancedServerList.<br>
+      Strings not resolving into valid numbers will be treated as this option not being set.<br>
+      <br>
       This option has no effect when <a href="../#extraplayersenabled()"><code>extraPlayersEnabled</code></a> is set to <a href="../../../objects/nullbool/#false"><code>NullBool.FALSE</code></a> or <a href="../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a>.<br>
       <br>
-      Set this to <code>null</code> to not alter the max player count. Alternatively, set <a href="#setextraplayersenabled(nullbool)"><code>setExtraPlayersEnabled(NullBool)</code></a> to <a href="../../../objects/nullbool/#false"><code>NullBool.FALSE</code></a>.
+      Set this to <code>null</code> to not alter the max player count. Alternatively <a href="#setextraplayersenabled(nullbool)"><code>disable extra Players</code></a>.
     parameters:
       - name: 'extraPlayersCount'
         description: 'The number of extra players to add.'
-        type: 'Integer'
+        type: 'String'
         attribute:
           - 'nullable'
     returns: 'This Builder after the extra player count has been set. Useful for chaining.'
@@ -71,9 +73,26 @@ methods:
     throws:
       - name: 'IllegalArgumentException'
         description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
+  - name: 'hidePlayersHoverEnabled'
+    description: |
+      Sets ehther the Hover List of online Players should be hidden or not.<br>
+      <br>
+      Set to <a href="../../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a> to not set this.
+    parameters:
+      - name: 'hidePlayersHoverEnabled'
+        description: 'Whether the online players feature should be enabled or not.'
+        type: 'NullBool'
+        attribute:
+          - 'notnull'
+    returns: 'This Builder after the NullBool has been set. Useful for chaining.'
+    throws:
+      - name: 'IllegalArgumentException'
+        description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
   - name: 'maxPlayersCount'
     description: |
-      Sets the number of max players allowed to join this server.<br>
+      Sets the value to resolve into a number by AdvancedServerList.<br>
+      Strings not resolving into valid numbers will be treated as this option not being set.<br>
+      <br>
       This option has no effect when <a href="#maxplayersenabled(nullbool)">maxPlayersEnabled</a> is set to <a href="../../../objects/nullbool/#false"><code>NullBool.FALSE</code></a> or <a href="../../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a>.<br>
       <br>
       Set this to <code>null</code> to not alter the max player count. Alternatively <a href="#maxplayersenabled(nullbool)">disable max Players</a>.
@@ -122,7 +141,11 @@ methods:
   - name: 'onlinePlayersCount'
     description: |
       Sets the value to resolve into a number by AdvancedServerList.<br>
-      Strings not resolving into valid numbers will be treated as this option not being set.
+      Strings not resolving into valid numbers will be treated as this option not being set.<br>
+      <br>
+      This option has no effect when <a href="#onlineplayersenabled(nullbool)">maxPlayersEnabled</a> is set to <a href="../../../objects/nullbool/#false"><code>NullBool.FALSE</code></a> or <a href="../../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a>.<br>
+      <br>
+      Set this to <code>null</code> to not alter the online player count. Alternatively <a href="#onlineplayersenabled(nullbool)">disable online Players</a>.
     parameters:
       - name: 'onlinePlayersCount'
         description: 'The number of online players to set.'

docs/api/reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/index.md

@@ -42,14 +42,24 @@ constructors:
         type: NullBool
         attributes:
           - notnull
+      - name: 'onlinePlayersCount'
+        description: 'The number to set for the Online Players count.'
+        type: String
+        attributes:
+          - nullable
+      - name: 'hidePlayersHoverEnabled'
+        description: 'Whether the online Players Hover should beenabled.'
+        type: NullBool
+        attributes:
+          - notnull
       - name: 'extraPlayersCount'
-        description: 'The number to add to the online players for the max players number.'
-        type: Integer
+        description: 'The number to add to the online Players for the extra Players.'
+        type: String
         attributes:
           - nullable
       - name: 'maxPlayersCount'
-        description: 'The number to use for the max players count.'
-        type: Integer
+        description: 'The number to set for the max Players count.'
+        type: String
         attributes:
           - nullable
     seealso:
@@ -74,8 +84,11 @@ methods:
         <li><a href="#hideplayersenabled()"><code>hidePlayersEnabled</code></a>: <a href="../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a></li>
         <li><a href="#extraplayersenabled()"><code>extraPlayersEnabled</code></a>: <a href="../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a></li>
         <li><a href="#maxplayersenabled()"><code>maxPlayersEnabled</code></a>: <a href="../../objects/nullbool/#not_set"><code>NullBoo.NOT_SET</code></a></li>
+        <li><a href="#onlineplayersenabled()"><code>onlinePlayersEnabled</code></a>: <a href="../../objects/nullbool/#not_set"><code>NullBoo.NOT_SET</code></a></li>
+        <li><a href="#hideplayershoverenabled()"><code>hidePlayersHoverEnabled</code></a>: <a href="../../objects/nullbool/#not_set"><code>NullBoo.NOT_SET</code></a></li>
         <li><a href="#extraplayerscount()"><code>extraPlayersCount</code></a>: <code>null</code></li>
         <li><a href="#maxplayerscount()"><code>maxPlayersCount</code></a>: <code>null</code></li>
+        <li><a href="#onlineplayerscount()"><code>onlinePlayersCount</code></a>: <code>null</code></li>
       </ul>
     returns: 'New ProfileEntry instance with empty/null values defined'
     attributes:
@@ -139,7 +152,7 @@ methods:
   - name: 'hidePlayersEnabled'
     description: |
       Whether the player count should be hidden or not in this ProfileEntry.<br>
-      To get the actual boolean value, append <a href="../../objects/nullbool/#getordefault()"><code>getOrDefault(boolean)</code></a>.
+      To get the actual boolean value, append <a href="../../objects/nullbool/#getordefault(boolean)"><code>getOrDefault(boolean)</code></a>.
     returns: 'Whether the player count should be hidden or not in this ProfileEntry.'
     type:
       name: 'NullBool'
@@ -148,7 +161,7 @@ methods:
   - name: 'extraPlayersEnabled'
     description: |
       Whether the extra players feature should be used or not in this ProfileEntry.<br>
-      To get the actual boolean value, append <a href="../../objects/nullbool/#getordefault()"><code>getOrDefault(boolean)</code></a>.
+      To get the actual boolean value, append <a href="../../objects/nullbool/#getordefault(boolean)"><code>getOrDefault(boolean)</code></a>.
     returns: 'Whether the extra players feature should be used or not in this ProfileEntry.'
     type:
       name: 'NullBool'
@@ -157,19 +170,39 @@ methods:
   - name: 'maxPlayersEnabled'
     description: |
       Whether the max players feature should be used or not.<br>
-      To get the actual boolean value, append <a href="../../objects/nullbool/#getordefault()"><code>getOrDefault(boolean)</code></a>.
+      To get the actual boolean value, append <a href="../../objects/nullbool/#getordefault(boolean)"><code>getOrDefault(boolean)</code></a>.
     returns: 'Whether the max players feature should be used or not.'
     type:
       name: 'NullBool'
       type: 'object'
       link: '../../objects/nullbool/'
+  - name: 'onlinePlayersEnabled'
+    description: |
+      Whether the online players feature should be used or not.<br>
+      To get the actual boolean value, append <a href="../../objects/nullbool/#getordefault(boolean)"><code>getOrDefault(boolean)</code></a>.
+    returns: 'Whether the online players feature should be used or not.'
+    type:
+      name: 'NullBool'
+      type: 'object'
+      link: '../../objects/nullbool/'
+  - name: 'hidePlayersHoverEnabled'
+    description: |
+      Whether the Hover List of online players should be hidden or not.<br>
+      To get the actual boolean value, use <a href="../../objects/nullbool/#getordefault()"><code>getOrDefault(boolean)</code></a> of the returned <a href="../../objects/nullbool"><code>NullBool</code></a>.<br>
+      <br>
+      When true, this option will force the <a href="#players()"><code>players()</code></a> list to be ignored.
+    returns: 'Whether the Hover List of online players should be hidden or not.'
+    type:
+      name: 'NullBool'
+      type: 'object'
+      link: '../../objects/nullbool/'
   - name: 'extraPlayersCount'
-    description: 'Gets the currently set number of extra players to use by this ProfileEntry. May be <code>null</code>.'
-    returns: 'Possibly-null integer number of extra players used by this ProfileEntry.'
+    description: 'Gets the currently set number of extra players of this ProfileEntry.'
+    returns: 'The current number of extra players used by this ProfileEntry.'
     attributes:
       - nullable
     type:
-      name: 'Integer'
+      name: 'String'
       type: 'object'
   - name: 'maxPlayersCount'
     description: 'Gets the currently set number of max players of this ProfileEntry.'
@@ -177,7 +210,15 @@ methods:
     attributes:
       - nullable
     type:
-      name: 'Integer'
+      name: 'String'
+      type: 'object'
+  - name: 'onlinePlayersCount'
+    description: 'Gets the currently set number of online players of this ProfileEntry.'
+    returns: 'The current number of online players used by this ProfileEntry.'
+    attributes:
+      - nullable
+    type:
+      name: 'String'
       type: 'object'
   - name: 'isInvalid'
     description: |

docs/profiles/formatting.md

@@ -4,57 +4,69 @@ icon: octicons/pencil-24
 
 # Formatting
 
-All text options, with exception of [`Conditions`](index.md#condition), allow the usage of formatting options using [MiniMessage].
+AdvancedServerList utilizes the [MiniMessage] text formatting to allow colors, formatting codes, gradients, etc. for the text options `motd`, `playerCount -> hover` and `playerCount -> text`.  
+You can find a collection of available tags on the library's [Format] page. Please make sure to see the [Unsupported Formatting](#unsupported-formatting) section below for tags with no support.
 
-/// info | Online Tool
-The devs of the Adventure library provide a handy online tool to create the right formatting codes to display the text properly.  
-You can find the tool at https://webui.advntr.dev/
+## Why no legacy colors (`&`/`§` codes) support?
+
+### The tl;dr
+
+MiniMessage tags are overall more readable while also allowing a lot more ways of formatting, with Legacy colors becoming an unreadable mess the more complex your formatting is.
+
+### The long explanation
+
+Legacy colors are a mess to read. This becomes especially evident with gradients using RGB color support.  
+As an example is here the text `Hello World` made into a Gradient with starting color `#084CFB` and end color `#ADF3FD` both in Legacy Color (Using `&` character) and MiniMessage format:
+
+/// tab | Legacy Color Codes
+```
+&#084CFBH&#195DFBe&#296DFBl&#3A7EFCl&#4A8FFCo &#6BB0FCW&#7CC1FCo&#8CD2FDr&#9DE2FDl&#ADF3FDd
+```
 ///
 
-## Before starting
-
-Please make sure to surround your text with either single quotes (`'`) or double quotes (`"`).  
-This avoids possible issues where the YAML parser would treat lines starting with specific characters as special options (i.e. `<` would be treated as a scolar value).
-
-Also, should your text contain single quotes (for example when using `you're`), either surround the text with double quotes, or change the single quote in your text into two single quotes (`you're -> you''re`).
-
-```yaml title="Wrong formatting"
-motd:
-  - <red>This will cause
-  - <red>Errors
+/// tab | MiniMessage
 ```
-
-```yaml title="Right formatting"
-motd:
-  - "<green>This will be formatted"
-  - "<green>properly."
+<gradient:#084CFB:#ADF3FD>Hello World</gradient>
 ```
+///
 
-## Unsupported options
+This becomes even more difficult to work with if you want to add text formatting to only parts of the text.  
+Assuming you want to make `World` be bold, with legacy colors, you would need to add `&l` before every character of the word, as colors reset any formatting applied. In MiniMessage all you need to do is put `<bold>` before the word and `</bold>` after it.
 
-The following options are **not** supported, no matter what option they are used in:
+Another benefit for gradients in particular is, that MiniMessage allows more than one color to be set for the gradient, i.e. you can set three colors for a start, middle and end color.
 
-- Hover Actions (Show text, Show Advancement, etc)
-- Click Actions (Run command, Suggest command, etc.)
-- Custom Fonts (May work if player already has the resource pack loaded)
+## Web Editor
 
-## Colors
+The Adventure team offers an [Online Web tool][webviewer]{ target="_blank" rel="nofollow" } that allows you to create the right MiniMessage tags while also having a preview.  
+Just visit the page and make sure to select `Server List` at the top to have a preview in a server list.
 
-### Default colors
+## YAML Formatting
 
-Default colors such as `<red>`, `<green>`, `<aqua>`, etc. may be used in all text options.
+It is recommended to always surround your text with single or double quotes. This avoids situations where the YAML parses sees a specific character and treats it as a special YAML feature.  
+This is especially the case with MiniMessage tags, where `<` can be seen as the start of a so-called scolar value.
 
-### Hex Colors
+Should you be using single quotes inside the text itself - i.e. for words such as `you're` - will you either need to surround the text with double quotes, or change the single quote in the word to two single quotes (`you're` becomes `you''re`).
 
-Hexadecimal colors may be used in the [`motd`](index.md#motd) option using the `<#RRGGBB>` format.
+## Unsupported Formatting
 
-### Gradients
+### Non-functional Tags
 
-Gradients can be created by using `<gradient:<color1>:<color2>>`, replacing `<color1>` with a starting color name or hex color value and `<color2>` with an ending color name or hex color value.  
-Only the [`motd`](index.md#motd) option may support hex color gradients and in all other options will it be downsampled.
+While MiniMessage will parse most, if not all tags, will not all work.  
+The following list of tags will do nothing, or only work under specific circumstances:
 
-## Formatting
+| Tag           | Note                                                                                                 |
+|---------------|------------------------------------------------------------------------------------------------------|
+| `<click>`     |                                                                                                      |
+| `<hover>`     |                                                                                                      |
+| `<insertion>` |                                                                                                      |
+| `<font>`      | May work if either a default MC font is used, or the player has a resourcepack with the font loaded. |
+| `<selector>`  |                                                                                                      |
+| `<score>`     |                                                                                                      |
 
-Formatting options (`<bold>`, `<italic>`, etc.) are available for all text options.
+### Non-supported RGB
 
-[MiniMessage]: https://docs.adventure.kyori.net/minimessage/index.html
+Only the `motd` option supports RGB colors. Every other option allowing MiniMessage format may only support the default colors provided by Minecraft (`<aqua>`, `<yellow>`, etc) with RGB colors being downsampled to their next supported option.
+
+[MiniMessage]: https://docs.advntr.dev/minimessage/index.html
+[Format]: https://docs.advntr.dev/minimessage/format.html
+[webviewer]: https://webui.advntr.dev/

paper/pom.xml

@@ -99,7 +99,7 @@
         <dependency>
             <groupId>com.viaversion</groupId>
             <artifactId>viaversion-api</artifactId>
-            <version>5.2.0</version>
+            <version>5.2.1</version>
             <scope>provided</scope>
         </dependency>
 

paper/src/main/java/ch/andre601/advancedserverlist/paper/listeners/PaperEventWrapper.java

@@ -98,14 +98,24 @@ public class PaperEventWrapper implements GenericEventWrapper<CachedServerIcon,
     @Override
     public void setPlayers(List<String> lines, PaperPlayerImpl player, GenericServer server){
         try{
-            event.getListedPlayers();
+            Class.forName("com.destroystokyo.paper.event.server.PaperServerListPingEvent$ListedPlayerInfo");
             setListedPlayers(lines, player, server);
-        }catch(NoSuchMethodError ex){
+        }catch(ClassNotFoundException ex){
             // Version before latest 1.20.6 builds(?)
             setPlayerSample(lines, player, server);
         }
     }
     
+    @Override
+    public void setPlayersHidden(){
+        try{
+            Class.forName("com.destroystokyo.paper.event.server.PaperServerListPingEvent$ListedPlayerInfo");
+            clearListedPlayers();
+        }catch(ClassNotFoundException ex){
+            clearPlayerSample();
+        }
+    }
+    
     @Override
     public void setFavicon(CachedServerIcon favicon){
         event.setServerIcon(favicon);
@@ -184,8 +194,12 @@ public class PaperEventWrapper implements GenericEventWrapper<CachedServerIcon,
         return new PaperServerImpl(plugin.getWorldCache().worlds(), playersOnline, playersMax, host);
     }
     
-    private void setListedPlayers(List<String> lines, PaperPlayerImpl player, GenericServer server){
+    private void clearListedPlayers(){
         event.getListedPlayers().clear();
+    }
+    
+    private void setListedPlayers(List<String> lines, PaperPlayerImpl player, GenericServer server){
+        clearListedPlayers();
         List<PaperServerListPingEvent.ListedPlayerInfo> playerList = getPlayerList(lines, player, server,
             text -> new PaperServerListPingEvent.ListedPlayerInfo(text, UUID.randomUUID()));
         
@@ -193,8 +207,13 @@ public class PaperEventWrapper implements GenericEventWrapper<CachedServerIcon,
     }
     
     @SuppressWarnings({"Deprecation", "removal"})
-    private void setPlayerSample(List<String> lines, PaperPlayerImpl player, GenericServer server){
+    private void clearPlayerSample(){
         event.getPlayerSample().clear();
+    }
+    
+    @SuppressWarnings({"Deprecation", "removal"})
+    private void setPlayerSample(List<String> lines, PaperPlayerImpl player, GenericServer server){
+        clearPlayerSample();
         List<PlayerProfile> playerProfiles = getPlayerList(lines, player, server, FakePlayerProfile::create);
         
         event.getPlayerSample().addAll(playerProfiles);

pom.xml

@@ -37,10 +37,10 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         
-        <plugin.version>5.2.1</plugin.version>
+        <plugin.version>5.4.0</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
-        <api.version>4.0.0</api.version>
+        <api.version>4.1.0</api.version>
 
         <dependency.adventure-api>4.18.0</dependency.adventure-api>
         <dependency.adventure-text-minimessage>4.18.0</dependency.adventure-text-minimessage>

renovate.json

@@ -1,11 +1,23 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:base", "group:allNonMajor"],
+  "dependencyDashboard": false,
   "labels": ["PR Type/Dependency Update"],
   "ignoreDeps": [
     "ch.andre601.advancedserverlist:parent",
     "ch.andre601.advancedserverlist:core"
   ],
   "packageRules": [
+    {
+      "description": "Automerge non-major updates",
+      "matchUpdateTypes": [
+        "minor",
+        "patch",
+        "pin",
+        "digest"
+      ],
+      "automerge": true
+    },
     {
       "description": "Use Jitpack registry for various Libs",
       "matchPackageNames": [
@@ -37,7 +49,7 @@
         "io.papermc.paper:paper-api"
       ],
       "registryUrls": [
-        "https://papermc.io/repo/repository/maven-public"
+        "https://repo.papermc.io/repository/maven-public"
       ]
     },
     {

velocity/pom.xml

@@ -48,6 +48,10 @@
             <id>velocity-repo</id>
             <url>https://repo.papermc.io/repository/maven-public/</url>
         </repository>
+        <repository>
+            <id>repo-sayandevelopment</id>
+            <url>https://repo.sayandev.org/snapshots</url>
+        </repository>
     </repositories>
     
     <dependencies>
@@ -95,6 +99,18 @@
             <version>2.9.0-4</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>org.sayandev</groupId>
+            <artifactId>sayanvanish-api</artifactId>
+            <version>1.6.1</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.sayandev</groupId>
+            <artifactId>sayanvanish-proxy-velocity</artifactId>
+            <version>1.6.1</version>
+            <scope>provided</scope>
+        </dependency>
         
         <!-- Other -->
         <dependency>

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/VelocityCore.java

@@ -54,6 +54,7 @@ import de.myzelyam.api.vanish.VelocityVanishAPI;
 import net.kyori.adventure.text.logger.slf4j.ComponentLogger;
 import org.bstats.charts.SimplePie;
 import org.bstats.velocity.Metrics;
+import org.sayandev.sayanvanish.velocity.api.SayanVanishVelocityAPI;
 
 import java.awt.image.BufferedImage;
 import java.nio.file.Path;
@@ -226,6 +227,9 @@ public class VelocityCore implements PluginCore<Favicon>{
         // Exclude players when PremiumVanish is enabled and player is hidden.
         if(getProxy().getPluginManager().isLoaded("premiumvanish")){
             players.removeIf(VelocityVanishAPI::isInvisible);
+        }else // Do the same if SayanVanish is enabled.
+        if(getProxy().getPluginManager().isLoaded("sayanvanish")){
+            players.removeIf(player -> SayanVanishVelocityAPI.getInstance().isVanished(player.getUniqueId()));
         }
         
         return players.size();

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/listeners/VelocityEventWrapper.java

@@ -119,6 +119,11 @@ public class VelocityEventWrapper implements GenericEventWrapper<Favicon, Veloci
             builder.clearSamplePlayers().samplePlayers(players);
     }
     
+    @Override
+    public void setPlayersHidden(){
+        builder.clearSamplePlayers();
+    }
+    
     @Override
     public void setFavicon(Favicon favicon){
         builder.favicon(favicon);