Allow support for vanished players

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

bungeecord/pom.xml

@@ -64,6 +64,8 @@
             <version>${api.version}</version>
             <scope>compile</scope>
         </dependency>
+        
+        <!-- BungeeCord API -->
         <dependency>
             <groupId>net.md-5</groupId>
             <artifactId>bungeecord-api</artifactId>
@@ -78,6 +80,8 @@
             <type>javadoc</type>
             <scope>provided</scope>
         </dependency>
+        
+        <!-- Adventure Library. Needs to be shaded in -->
         <dependency>
             <groupId>net.kyori</groupId>
             <artifactId>adventure-api</artifactId>
@@ -96,18 +100,30 @@
             <version>4.3.2</version>
             <scope>compile</scope>
         </dependency>
+        
+        <!-- Metrics -->
         <dependency>
             <groupId>org.bstats</groupId>
             <artifactId>bstats-bungeecord</artifactId>
             <version>3.0.2</version>
             <scope>compile</scope>
         </dependency>
+        
+        <!-- Configurate -->
         <dependency>
             <groupId>org.spongepowered</groupId>
             <artifactId>configurate-yaml</artifactId>
             <version>4.1.2</version>
             <scope>compile</scope>
         </dependency>
+        
+        <!-- Plugins -->
+        <dependency>
+            <groupId>com.github.LeonMangler</groupId>
+            <artifactId>PremiumVanishAPI</artifactId>
+            <version>2.9.0-4</version>
+            <scope>provided</scope>
+        </dependency>
     </dependencies>
 
     <build>

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

@@ -35,13 +35,18 @@ import ch.andre601.advancedserverlist.core.AdvancedServerList;
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
 import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.profiles.favicon.FaviconHandler;
+import de.myzelyam.api.vanish.BungeeVanishAPI;
 import net.md_5.bungee.api.Favicon;
+import net.md_5.bungee.api.config.ServerInfo;
+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 java.awt.image.BufferedImage;
 import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
 
 public class BungeeCordCore extends Plugin implements PluginCore<Favicon>{
     
@@ -51,7 +56,7 @@ public class BungeeCordCore extends Plugin implements PluginCore<Favicon>{
     
     @Override
     public void onEnable(){
-        this.core = AdvancedServerList.init(this, BungeePlayerPlaceholders.init(), BungeeServerPlaceholders.init());
+        this.core = AdvancedServerList.init(this, BungeePlayerPlaceholders.init(), BungeeServerPlaceholders.init(this));
     }
     
     @Override
@@ -133,4 +138,15 @@ public class BungeeCordCore extends Plugin implements PluginCore<Favicon>{
     public Favicon createFavicon(BufferedImage image) throws IllegalArgumentException{
         return Favicon.create(image);
     }
+    
+    public int getOnlinePlayers(ServerInfo server){
+        List<ProxiedPlayer> players = new ArrayList<>(server == null ? getProxy().getPlayers() : server.getPlayers());
+        
+        // Exclude players when PremiumVanish is enabled and player is hidden.
+        if(getProxy().getPluginManager().getPlugin("PremiumVanish") != null){
+            players.removeIf(BungeeVanishAPI::isInvisible);
+        }
+        
+        return players.size();
+    }
 }

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

@@ -147,7 +147,7 @@ public class BungeeEventWrapper implements GenericEventWrapper<Favicon, BungeePl
     
     @Override
     public int getOnlinePlayers(){
-        return ping.getPlayers().getOnline();
+        return plugin.getOnlinePlayers(null);
     }
     
     @Override

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/objects/placeholders/BungeeServerPlaceholders.java

@@ -29,18 +29,22 @@ import ch.andre601.advancedserverlist.api.PlaceholderProvider;
 import ch.andre601.advancedserverlist.api.bungeecord.objects.BungeeProxy;
 import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
+import ch.andre601.advancedserverlist.bungeecord.BungeeCordCore;
 import net.md_5.bungee.api.config.ServerInfo;
 
 import java.net.InetSocketAddress;
 
 public class BungeeServerPlaceholders extends PlaceholderProvider{
     
-    private BungeeServerPlaceholders(){
+    private final BungeeCordCore plugin;
+    
+    private BungeeServerPlaceholders(BungeeCordCore plugin){
         super("server");
+        this.plugin = plugin;
     }
     
-    public static BungeeServerPlaceholders init(){
-        return new BungeeServerPlaceholders();
+    public static BungeeServerPlaceholders init(BungeeCordCore plugin){
+        return new BungeeServerPlaceholders(plugin);
     }
     
     @Override
@@ -64,7 +68,7 @@ public class BungeeServerPlaceholders extends PlaceholderProvider{
                         if(info == null)
                             continue;
                         
-                        players += info.getPlayers().size();
+                        players += plugin.getOnlinePlayers(info);
                     }
                     
                     yield String.valueOf(players);

core/pom.xml

@@ -73,7 +73,7 @@
         <dependency>
             <groupId>ch.andre601</groupId>
             <artifactId>expressionparser</artifactId>
-            <version>v1.2.0</version>
+            <version>1.3.0</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
@@ -102,6 +102,8 @@
             <version>4.16.0</version>
             <scope>provided</scope>
         </dependency>
+        
+        <!-- Misc -->
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>

core/src/main/java/ch/andre601/advancedserverlist/core/AdvancedServerList.java

@@ -46,7 +46,7 @@ public class AdvancedServerList<F>{
     private final FileHandler fileHandler;
     private final CommandHandler commandHandler;
     private final PlayerHandler playerHandler;
-    private final AdvancedServerListAPI api = AdvancedServerListAPI.get();
+    private static final AdvancedServerListAPI api = AdvancedServerListAPI.get();
     private final ProfileConditionParser parser = ProfileConditionParser.create();
     
     private UpdateChecker updateChecker;
@@ -59,7 +59,7 @@ public class AdvancedServerList<F>{
         this.commandHandler = new CommandHandler(this);
         this.playerHandler = new PlayerHandler(this);
         
-        placeholders.forEach(this.api::addPlaceholderProvider);
+        placeholders.forEach(AdvancedServerList.getApi()::addPlaceholderProvider);
         
         load();
     }
@@ -88,7 +88,7 @@ public class AdvancedServerList<F>{
         return version;
     }
     
-    public AdvancedServerListAPI getApi(){
+    public static AdvancedServerListAPI getApi(){
         return api;
     }
     

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/ServerListProfile.java

@@ -39,7 +39,7 @@ import java.util.ArrayList;
 import java.util.List;
 import java.util.Random;
 
-public record ServerListProfile(int priority, String condition, ProfileEntry defaultProfile, List<ProfileEntry> profiles){
+public record ServerListProfile(int priority, String condition, ProfileEntry defaultProfile, List<ProfileEntry> profiles, String file){
     private static final Random random = new Random();
     
     public boolean evalConditions(ProfileConditionParser parser, PluginLogger logger, GenericPlayer player, GenericServer server){
@@ -50,13 +50,17 @@ public record ServerListProfile(int priority, String condition, ProfileEntry def
         ExpressionTemplate template = parser.compile(condition, player, server, collector);
         
         if(collector.hasWarnings()){
-            logger.warn("Encountered %d Error(s) while parsing condition '%s':", collector.getWarnings().size(), condition);
+            logger.warn("Encountered %d Error(s) while parsing condition for file '%s':", collector.getWarnings().size(), file);
             
             for(ParseWarnCollector.Context context : collector.getWarnings()){
                 if(context.position() <= -1){
-                    logger.warn("  - %s", context.message());
+                    logger.warn("  - %s", condition);
+                    logger.warn("    -> %s", context.message());
                 }else{
-                    logger.warn("  - At Position %d: %s", context.position(), context.message());
+                    logger.warn("  - At position %d:", context.position());
+                    logger.warn("    %s", condition);
+                    logger.warn(" ".repeat(context.position() + 5) + "^");
+                    logger.warn("    -> %s", context.message());
                 }
             }
         }
@@ -159,7 +163,7 @@ public record ServerListProfile(int priority, String condition, ProfileEntry def
         }
         
         public ServerListProfile build(){
-            return new ServerListProfile(this.priority, this.condition, this.defaultProfile, this.profiles);
+            return new ServerListProfile(this.priority, this.condition, this.defaultProfile, this.profiles, this.fileName);
         }
     }
 }

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/conditions/ProfileConditionParser.java

@@ -54,7 +54,7 @@ public class ProfileConditionParser implements ExpressionParserEngine{
     }
     
     public static ProfileConditionParser create(){
-        return new ProfileConditionParserBuilder().createDefault()
+        return new ProfileConditionParserBuilder().addDefaults()
             .addTokenReader(new PlaceholderTokenReader(-20))
             .addValueReader(new PlaceholderValueReader())
             .build();

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/conditions/placeholders/PlaceholderParser.java

@@ -1,120 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2022-2024 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.profiles.conditions.placeholders;
-
-import ch.andre601.advancedserverlist.api.AdvancedServerListAPI;
-import ch.andre601.advancedserverlist.api.PlaceholderProvider;
-import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
-import ch.andre601.advancedserverlist.api.objects.GenericServer;
-import ch.andre601.advancedserverlist.core.profiles.conditions.placeholders.tokens.PlaceholderToken;
-import ch.andre601.expressionparser.ParseWarnCollector;
-
-import java.text.ParsePosition;
-
-public class PlaceholderParser{
-    
-    public static PlaceholderToken.Placeholder parse(String text, ParsePosition position, GenericPlayer player, GenericServer server, ParseWarnCollector collector){
-        AdvancedServerListAPI api = AdvancedServerListAPI.get();
-        
-        // We want to point to the start of a placeholder in the ParseWarnCollector.
-        // Since the PlaceholderTokenReader updates the index by 2 are we reverting this here.
-        int placeholderStart = position.getIndex() - 2;
-        int index = position.getIndex();
-        
-        StringBuilder identifier = new StringBuilder();
-        StringBuilder values = new StringBuilder();
-        
-        boolean identified = false;
-        boolean invalid = true;
-        
-        char[] chars = text.substring(index).toCharArray();
-        for(final char c : chars){
-            index++;
-            
-            if(c == '}'){
-                invalid = false;
-                break;
-            }
-            
-            if(c == ' ' && !identified){
-                identified = true;
-                continue;
-            }
-            
-            if(identified){
-                values.append(c);
-            }else{
-                identifier.append(c);
-            }
-        }
-        
-        String identifierStr = identifier.toString();
-        String valuesStr = values.toString();
-        
-        StringBuilder raw = new StringBuilder();
-        
-        // Skipping whatever character we currently were on (i.e. })
-        position.setIndex(index + 1);
-        
-        if(invalid){
-            raw.append("${").append(identifierStr);
-            
-            if(identified)
-                raw.append(' ').append(valuesStr);
-            
-            collector.appendWarningFormatted(placeholderStart, "Placeholder '%s' does not have a closing bracket (}).", raw.toString());
-            return new PlaceholderToken.Placeholder(raw.toString());
-        }
-        
-        PlaceholderProvider provider = api.retrievePlaceholderProvider(identifierStr);
-        if(provider == null){
-            raw.append("${").append(identifierStr);
-            
-            if(identified)
-                raw.append(' ').append(valuesStr);
-            
-            raw.append('}');
-            
-            collector.appendWarningFormatted(placeholderStart, "Placeholder '%s' does not have any available PlaceholderProvider", raw.toString());
-            return new PlaceholderToken.Placeholder(raw.toString());
-        }
-        
-        String replacement = provider.parsePlaceholder(valuesStr, player, server);
-        if(replacement == null){
-            raw.append("${").append(identifierStr);
-            
-            if(identified)
-                raw.append(' ').append(valuesStr);
-            
-            raw.append('}');
-            
-            collector.appendWarningFormatted(placeholderStart, "Placeholder '%s' has an invalid value String '%s'.", raw.toString(), valuesStr);
-            return new PlaceholderToken.Placeholder(raw.toString());
-        }
-        
-        return new PlaceholderToken.Placeholder(replacement);
-    }
-}

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/conditions/placeholders/reader/PlaceholderTokenReader.java

@@ -27,8 +27,8 @@ package ch.andre601.advancedserverlist.core.profiles.conditions.placeholders.rea
 
 import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
-import ch.andre601.advancedserverlist.core.profiles.conditions.placeholders.PlaceholderParser;
 import ch.andre601.advancedserverlist.core.profiles.conditions.placeholders.tokens.PlaceholderToken;
+import ch.andre601.advancedserverlist.core.profiles.replacer.StringReplacer;
 import ch.andre601.expressionparser.ParseWarnCollector;
 import ch.andre601.expressionparser.tokens.Token;
 
@@ -44,7 +44,7 @@ public class PlaceholderTokenReader extends CustomTokenReader{
     public Token read(String text, ParsePosition position, GenericPlayer player, GenericServer server, ParseWarnCollector collector){
         if(position.getIndex() + 1 < text.length() && text.charAt(position.getIndex()) == '$' && text.charAt(position.getIndex() + 1) == '{'){
             position.setIndex(position.getIndex() + 2);
-            return new PlaceholderToken(PlaceholderParser.parse(text, position, player, server, collector));
+            return new PlaceholderToken(StringReplacer.parsePlaceholder(text, position, player, server, collector));
         }
         return null;
     }

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

@@ -86,15 +86,15 @@ public class ProfileManager{
         Integer maxPlayers = resolveNullableInt(node, "playerCount", "maxPlayers", "amount");
         
         return new ProfileEntry.Builder()
-            .setMotd(motd)
-            .setPlayers(players)
-            .setPlayerCountText(playerCountText)
-            .setFavicon(favicon)
-            .setHidePlayersEnabled(hidePlayers)
-            .setExtraPlayersEnabled(extraPlayersEnabled)
-            .setMaxPlayersEnabled(maxPlayersEnabled)
-            .setExtraPlayersCount(extraPlayers)
-            .setMaxPlayersCount(maxPlayers)
+            .motd(motd)
+            .players(players)
+            .playerCountText(playerCountText)
+            .favicon(favicon)
+            .hidePlayersEnabled(hidePlayers)
+            .extraPlayersEnabled(extraPlayersEnabled)
+            .maxPlayersEnabled(maxPlayersEnabled)
+            .extraPlayersCount(extraPlayers)
+            .maxPlayersCount(maxPlayers)
             .build();
     }
     

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/replacer/StringReplacer.java

@@ -29,6 +29,11 @@ import ch.andre601.advancedserverlist.api.AdvancedServerListAPI;
 import ch.andre601.advancedserverlist.api.PlaceholderProvider;
 import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
+import ch.andre601.advancedserverlist.core.AdvancedServerList;
+import ch.andre601.advancedserverlist.core.profiles.conditions.placeholders.tokens.PlaceholderToken;
+import ch.andre601.expressionparser.ParseWarnCollector;
+
+import java.text.ParsePosition;
 
 public class StringReplacer{
     
@@ -36,99 +41,113 @@ public class StringReplacer{
         if(input == null)
             return null;
         
-        char[] chars = input.toCharArray();
+        ParsePosition position = new ParsePosition(0);
         StringBuilder builder = new StringBuilder(input.length());
         
-        StringBuilder identifier = new StringBuilder();
-        StringBuilder placeholder = new StringBuilder();
-        
-        AdvancedServerListAPI api = AdvancedServerListAPI.get();
-        
-        for(int i = 0; i < chars.length; i++){
-            char c = chars[i];
-            char next = (i == (chars.length - 1)) ? '\0' : chars[i + 1];
-            
-            if(c != '$' || i + 2 >= chars.length){
-                builder.append(c);
+        while(position.getIndex() < input.length()){
+            if(position.getIndex() + 1 < input.length() && input.charAt(position.getIndex()) == '$' && input.charAt(position.getIndex() + 1) == '{'){
+                position.setIndex(position.getIndex() + 2);
+                builder.append(parsePlaceholder0(input, position, player, server, null));
                 continue;
             }
             
-            if(next != '{'){
-                if(next == '\0')
-                    continue;
-                
-                builder.append(next);
-                i++;
-                continue;
-            }
-            
-            i++;
-            
-            boolean identified = false;
-            boolean invalid = true;
-            
-            while(++i < chars.length){
-                final char id = chars[i];
-                
-                if(id == '}'){
-                    invalid = false;
-                    break;
-                }
-                
-                if(id == ' ' && !identified){
-                    identified = true;
-                    continue;
-                }
-                
-                if(identified){
-                    placeholder.append(id);
-                }else{
-                    identifier.append(id);
-                }
-            }
-            
-            String identifierString = identifier.toString();
-            String placeholderString = placeholder.toString();
-            
-            identifier.setLength(0);
-            placeholder.setLength(0);
-            
-            if(invalid){
-                builder.append("${").append(identifierString);
-                
-                if(identified){
-                    builder.append(' ').append(placeholderString);
-                }
-                continue;
-            }
-            
-            PlaceholderProvider provider = api.retrievePlaceholderProvider(identifierString);
-            if(provider == null){
-                builder.append("${").append(identifierString);
-    
-                if(identified){
-                    builder.append(' ').append(placeholderString);
-                }
-                
-                builder.append('}');
-                continue;
-            }
-            
-            String replacement = provider.parsePlaceholder(placeholderString, player, server);
-            if(replacement == null){
-                builder.append("${").append(identifierString);
-    
-                if(identified){
-                    builder.append(' ').append(placeholderString);
-                }
-    
-                builder.append('}');
-                continue;
-            }
-            
-            builder.append(replacement);
+            builder.append(input.charAt(position.getIndex()));
+            position.setIndex(position.getIndex() + 1);
         }
         
         return builder.toString();
     }
+    
+    public static PlaceholderToken.Placeholder parsePlaceholder(String input, ParsePosition position, GenericPlayer player, GenericServer server, ParseWarnCollector collector){
+        return new PlaceholderToken.Placeholder(parsePlaceholder0(input, position, player, server, collector));
+    }
+    
+    private static String parsePlaceholder0(String input, ParsePosition position, GenericPlayer player, GenericServer server, ParseWarnCollector collector){
+        AdvancedServerListAPI api = AdvancedServerList.getApi();
+        
+        int placeholderStart = position.getIndex() - 2;
+        int index = position.getIndex();
+        
+        StringBuilder identifier = new StringBuilder();
+        StringBuilder values = new StringBuilder();
+        
+        boolean identified = false;
+        boolean invalid = true;
+        
+        char[] chars = input.substring(index).toCharArray();
+        for(final char c : chars){
+            index++;
+            
+            if(c == '}'){
+                invalid = false;
+                break;
+            }
+            
+            if(c == ' ' && !identified){
+                identified = true;
+                continue;
+            }
+            
+            if(identified){
+                values.append(c);
+            }else{
+                identifier.append(c);
+            }
+        }
+        
+        String identifierStr = identifier.toString();
+        String valuesStr = values.toString();
+        
+        StringBuilder raw = new StringBuilder();
+        
+        // Condition parsing needs one extra increase of index... for some reason
+        if(collector != null)
+            index++;
+        
+        position.setIndex(index);
+        
+        if(invalid){
+            raw.append("${").append(identifierStr);
+            
+            if(identified)
+                raw.append(' ').append(valuesStr);
+            
+            if(collector != null)
+                collector.appendWarningFormatted(placeholderStart, "Placeholder '%s' does not have a closing bracket (})", raw.toString());
+            
+            return raw.toString();
+        }
+        
+        PlaceholderProvider provider = api.retrievePlaceholderProvider(identifierStr);
+        if(provider == null){
+            raw.append("${").append(identifierStr);
+            
+            if(identified)
+                raw.append(' ').append(valuesStr);
+            
+            raw.append('}');
+            
+            if(collector != null)
+                collector.appendWarningFormatted(placeholderStart, "Placeholder '%s' does not have any available PlaceholderProvider", raw.toString());
+            
+            return raw.toString();
+        }
+        
+        String replacement = provider.parsePlaceholder(valuesStr, player, server);
+        if(replacement == null){
+            raw.append("${").append(identifierStr);
+            
+            if(identified)
+                raw.append(' ').append(valuesStr);
+            
+            raw.append('}');
+            
+            if(collector != null)
+                collector.appendWarningFormatted(placeholderStart, "Placeholder '%s' has an invalid value String '%s'", raw.toString(), valuesStr);
+            
+            return raw.toString();
+        }
+        
+        return replacement;
+    }
 }

docs/.overrides/api-doc.html

@@ -8,28 +8,28 @@
       Object summaries
     -->
     {% if page.meta.constructors %}
-      {{ info.summary('Constructor Summary', page.meta.constructors, details_type='constructor') }}
+      {{ info.summary('Constructor Summary', page.meta.constructors, details_type='constructor', defaults=page.meta.defaults) }}
     {% endif %}
     {% if page.meta.classes %}
-      {{ info.summary('Class Summary', page.meta.classes, details_type='class') }}
+      {{ info.summary('Class Summary', page.meta.classes, details_type='class', defaults=page.meta.defaults) }}
     {% endif %}
     {% if page.meta.enums %}
-      {{ info.summary('Enum Constant Summary', page.meta.enums, details_type='enum') }}
+      {{ info.summary('Enum Constant Summary', page.meta.enums, details_type='enum', defaults=page.meta.defaults) }}
     {% endif %}
     {% if page.meta.methods or page.meta.inherits %}
-      {{ info.summary('Method Summary', page.meta.methods, page.meta.inherits, details_type='method') }}
+      {{ info.summary('Method Summary', page.meta.methods, page.meta.inherits, details_type='method', defaults=page.meta.defaults) }}
     {% endif %}
     <!--
       Detailed object info
     -->
     {% if page.meta.constructors %}
-      {{ info.info('Constructor Detail', page.meta.constructors) }}
+      {{ info.info('Constructor Detail', page.meta.constructors, defaults=page.meta.defaults) }}
     {% endif %}
     {% if page.meta.enums %}
-      {{ info.info('Enum Constant Detail', page.meta.enums, true) }}
+      {{ info.info('Enum Constant Detail', page.meta.enums, true, defaults=page.meta.defaults) }}
     {% endif %}
     {% if page.meta.methods %}
-      {{ info.info('Method Detail', page.meta.methods)}}
+      {{ info.info('Method Detail', page.meta.methods, defaults=page.meta.defaults)}}
     {% endif %}
   {% endif %}
 {% endblock %}

docs/.overrides/api-objects/info-template.html

@@ -1,4 +1,4 @@
-{% macro summary(title, summaries, inherits, details_type = 'unknown') -%}
+{% macro summary(title, summaries, inherits, details_type = 'unknown', defaults = []) -%}
   <h2 id="{{ title | lower() | replace(' ', '-') |  e}}">
     {{ title }}
   </h2>
@@ -28,6 +28,8 @@
                 
                 {% if summary.type and summary.type.name %}
                   {% set modifiers.name = modifiers.name ~ summary.type.name %}
+                {% elif defaults and defaults.type and defaults.type.name %}
+                  {% set modifiers.name = modifiers.name ~ defaults.type.name %}
                 {% else %}
                   {% set modifiers.name = modifiers.name ~ "void" %}
                 {% endif %}
@@ -103,7 +105,7 @@
   </div>
 {%- endmacro %}
 
-{% macro info(title, details, enum = false) -%}
+{% macro info(title, details, enum = false, defaults = []) -%}
   <h2 id="{{ title | lower() | replace(' ', '-') | e}}">
     {{ title }}
   </h2>
@@ -144,6 +146,14 @@
           {% else %}
             <span class="api-type__{{- detail.type.type | default('primitive') -}}">{{ detail.type.name | default('void') | e }}</span>
           {% endif %}
+        {% elif defaults and defaults.type %}
+          {% if defaults.type.link %}
+            <a href="{{ defaults.type.link }}" class="api-type__{{- defaults.type.type | default('primitive') -}}">{{ defaults.type.name | default('void') | e }}</a>
+          {% else %}
+            <span class="api-type__{{- defaults.type.type | default('primitive') -}}">{{ defaults.type.name | default('void') }}</span>
+          {% endif %}
+        {% else %}
+          <span class="api-type__primitive">void</span>
         {% endif %}
         <code>{{ final_name.name | e }}</code><a href="#{{ final_name.name | lower() | replace(' ', '-') | e }}" class="headerlink" title="Permanent link">¶</a>
       </h3>

docs/api/changelog.md

@@ -7,6 +7,85 @@ icon: octicons/log-24
 This page lists the recent changes made towards the AdvancedServerListAPI.  
 They are ordered newest to oldest.
 
+## v3.2.1 { #v3.2.1 }
+
+### :octicons-pencil-24:{ .changelog-changed title="Changed" } Changed { #v3.2.1-changed }
+
+- Removed usage of `${api.version}` in the different pom.xml for version resolving.
+
+## v3.2.0 { #v3.2.0 }
+
+### :octicons-plus-circle-24:{ .changelog-added title="Added" } Added { #v3.2.0-added }
+
+- New setter methods added to [`ProfileEntry.Builder`][profileentry.builder] class, replacing old ones (See deprecations below):
+    - [`extraPlayersCount(Integer)`][extraplayerscount]
+    - [`extraPlayersEnabled(NullBool)`][extraplayersenabled]
+    - [`favicon(String)`][favicon]
+    - [`hidePlayersEnabled(NullBool)`][hideplayersenabled]
+    - [`maxPlayersCount(Integer)`][maxplayerscount]
+    - [`maxPlayersEnabled(NullBool)`][maxplayersenabled]
+    - [`motd(List<String>)`][motd]
+    - [`playerCountText(String)`][playercounttext]
+    - [`players(List<String>)`][players]
+
+[extraplayerscount]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#extraplayerscount(integer)
+[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)
+[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)
+[players]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md#players(list<string>)
+
+### :octicons-pencil-24:{ .changelog-changed title="Changed" } Changed { #v3.2.0-changed }
+
+- The API has been moved to Codeberg and is now available under a new repository URL to download. The group and artifact ID remained the same, but version no longer has a `v` prefix:
+    
+    /// tab | ":simple-apachemaven: Maven (pom.xml)"
+    ```xml
+    <repositories>
+      <repository>
+        <id>codeberg</id>
+        <url>https://codeberg.org/api/packages/Andre601/maven/</url>
+      </repository>
+    </repositories>
+    
+    <dependencies>
+      <dependency>
+        <groupId>ch.andre601.asl-api</groupId>
+        <artifactId>api</artifactId>
+        <version>{apiVersion}</version>
+        <scope>provided</scope>
+      </dependency>
+    </dependencies>
+    ```
+    ///
+    /// tab | ":simple-gradle: Gradle (build.gradle)"
+    ```groovy
+    repositories {
+        maven = { url ="https://codeberg.org/api/packages/Andre601/maven/" }
+    }
+    
+    dependencies {
+        compileOnly "ch.andre601.asl-api:api:{apiVersion}"
+    }
+    ```
+    ///
+
+### :octicons-zap-24:{ .changelog-breaking title="Deprecated" } Deprecated { #v3.2.0-deprecated }
+
+- Setters in [`ProfileEntry.Builder`][profileentry.builder] deprecated in favour of more consistent method naming.
+    - `setExtraPlayersCount(Integer)`
+    - `setExtraPlayersEnabled(NullBool)`
+    - `setFavicon(String)`
+    - `setHidePlayersEnabled(NullBool)`
+    - `setMaxPlayersCount(Integer)`
+    - `setMaxPlayersEnabled(NullBool)`
+    - `setMotd(List<String>)`
+    - `setPlayerCountText(String)`
+    - `setPlayers(List<String>)`
+
 ## v3.1.0 { #v3.1.0 }
 
 ### :octicons-plus-circle-24:{ .changelog-added title="Added" } Added { #v3.1.0-added }
@@ -111,6 +190,6 @@ Templates for changelog
 ### :octicons-plus-circle-24:{ .changelog-added title="Added" } Added { #v-added }
 ### :octicons-pencil-24:{ .changelog-changed title="Changed" } Changed { #v-changed }
 ### :octicons-trash-24:{ .changelog-removed title="Removed" } Removed { #v-removed }
-### :octicons-zap-24:{ .changelog-deprecated title="Deprecated" } Deprecated { #v-deprecated }
+### :octicons-zap-24:{ .changelog-breaking title="Deprecated" } Deprecated { #v-deprecated }
 
 -->

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

@@ -1,59 +1,213 @@
 ---
 template: api-doc.html
 
+defaults:
+  type:
+    name: 'Builder'
+    type: 'object'
+
 constructors:
   - name: 'Builder'
+    description: 'Empty Builder Constructor used to create a new instance of this class.'
   
 methods:
-  - name: 'setMotd'
+  - name: 'extraPlayersCount'
+    description: |
+      Sets the number of players to add to the online players to use as the new max players value.<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>.
+    parameters:
+      - name: 'extraPlayersCount'
+        description: 'The number of extra players to add.'
+        type: 'Integer'
+        attribute:
+          - 'nullable'
+    returns: 'This Builder after the extra player count has been set. Useful for chaining.'
+  - name: 'extraPlayersEnabled'
+    description: |
+      Sets whether the extra players feature should be enabled or not.<br>
+      <br>
+      Set to <a href="../../../objects/nullbool#not_set"><code>NullBool.NOT_SET</code></a> to not set this.
+    parameters:
+      - name: 'extraPlayersEnabled'
+        description: 'Whether the extra 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: 'favicon'
+    description: |
+      Sets the value to use for the favicon.<br>
+      The following values are supported:
+      <ul>
+      <li>URL to a valid PNG file.</li>
+      <li>File name (with <code>.png</code> extension) matching a file saved in the favicons folder of AdvancedServerList.</li>
+      <li><code>${player uuid}</code> to display the avatar of the player.
+      </ul>
+      Set to an empty String or <code>null</code> to not alter the Favicon.
+    parameters:
+      - name: 'favicon'
+        description: 'The favicon to set.'
+        type: 'String'
+        attribute:
+          - 'nullable'
+    returns: 'This Builder after the Favicon has been set. Useful for chaining.'
+  - name: 'hidePlayersEnabled'
+    description: |
+      Sets whether the player count 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: 'hidePlayersEnabled'
+        description: 'Whether the player count should be hidden 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>
+      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>.
+    parameters:
+      - name: 'maxPlayersCount'
+        description: 'The number of max players to set.'
+        type: 'Integer'
+        attribute:
+          - 'nullable'
+    returns: 'This Builder after the max player count has been set. Useful for chaining.'
+  - name: 'maxPlayersEnabled'
+    description: |
+      Sets whether the max players feature should be enabled.<br>
+      <br>
+      Set to <a href="../../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a> to not set this.<br>
+      <br>
+      An <code>IllegalArgumentException</code> may be thrown by the <code>CheckUtil</code> should maxPlayersEnabled be null.
+    parameters:
+      - name: 'maxPlayersEnabled'
+        description: 'Whether the extra 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: 'motd'
     description: |
       Sets a new MOTD to use.<br>
       <br>
       Set to an empty list to not change the MOTD.<br>
-      Only the first two entries of the list will be considered and any additional ones discarded.
-    returns: 'This Builder after the motd has been set. Useful for chaining.'
+      Only the first two entries of the list will be considered and any additional ones discarded.<br>
+      <br>
+      An <code>IllegalArgumentException</code> may be thrown by the <code>CheckUtil</code> should the provided motd list be null.
     parameters:
       - name: 'motd'
         description: 'The MOTD to use.'
         type: 'List<String>'
-        attributes:
-          - notnull
+        attribute:
+          - 'notnull'
+    returns: 'This Builder after the motd 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.'
-    type:
-      name: 'Builder'
-      type: 'object'
-  - name: 'setPlayers'
-    description: |
-      Sets the players (lines) to use for the hover.<br>
-      <br>
-      Set to an empty list to not change the hover text.
-    returns: 'This Builder after the players have been set. Useful for chaining.'
-    parameters:
-      - name: 'players'
-        description: 'The lines to set for the hover.'
-        type: 'List<String>'
-        attributes:
-          - notnull
-    throws:
-      - name: 'IllegalArgumentException'
-        description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
-    type:
-      name: 'Builder'
-      type: 'object'
-  - name: 'setPlayerCountText'
+  - name: 'playerCountText'
     description: |
       Sets the text to override the player count with.<br>
       <br>
       Set to an empty String or <code>null</code> to not alter the player count text.
-    returns: 'This Builder after the player count text has been set. Useful for chaining.'
     parameters:
       - name: 'playerCountText'
         description: 'The text to show in the player count.'
-        type: String
-        attributes:
+        type: 'String'
+        attribute:
+          - 'nullable'
+    returns: 'This Builder after the player count text has been set. Useful for chaining.'
+  - name: 'players'
+    description: |
+      Sets the players (lines) to use for the hover.<br>
+      <br>
+      Set to an empty list to not change the hover text.
+      <br>
+      An <code>IllegalArgumentException</code> may be thrown by the <code>CheckUtil</code> should the provided okayersmotd list be null.
+    parameters:
+      - name: 'players'
+        description: 'The lines to set for the hover.'
+        type: 'List<String>'
+        attribute:
+          - 'notnull'
+    returns: 'This Builder after the players have 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: 'build'
+    description: 'Creates a new <a href="./.."><code>ProfileEntry</code> instance</a> with the values set in this Builder.'
+    returns: 'New <a href="./.."><code>ProfileEntry</code> instance</a>.'
+    type:
+      name: 'ProfileEntry'
+      type: 'object'
+      link: './..'
+  #
+  # Deprecated stuff
+  #
+  - name: 'setExtraPlayerCount'
+    description: |
+      Sets the number of players to add to the online players to use as the new max players value.<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>.
+    returns: 'This Builder after the extra player count has been set. Useful for chaining.'
+    parameters:
+      - name: 'extraPlayersCount'
+        description: 'The number of extra players to add.'
+        type: Integer
+        attribute:
           - nullable
+    deprecated: 'Typo in the name. Use <a href="#setextraplayerscount(integer)">setExtraPlayersCount(Integer)</a> instead.'
+    type:
+      name: 'Builder'
+      type: 'object'
+  - name: 'setExtraPlayersCount'
+    description: |
+      Sets the number of players to add to the online players to use as the new max players value.<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>.
+    returns: 'This Builder after the extra player count has been set. Useful for chaining.'
+    parameters:
+      - name: 'extraPlayersCount'
+        description: 'The number of extra players to add.'
+        type: Integer
+        attribute:
+          - nullable
+    deprecated: 'Method renamed to fit <a href="..">ProfileEntry</a> record more closely. Use <a href="#extraplayerscount(integer)">extraPlayersCount(Integer)</a> instead.'
+    type:
+      name: 'Builder'
+      type: 'object'
+  - name: 'setExtraPlayersEnabled'
+    description: |
+      Sets whether the extra players feature should be enabled or not.<br>
+      <br>
+      Set to <a href="../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a> to not set this.
+    returns: 'This Builder after the NullBool has been set. Useful for chaining.'
+    parameters:
+      - name: 'extraPlayersEnabled'
+        description: 'Whether the extra players feature should be enabled or not.'
+        type: NullBool
+        attribute:
+          - notnull
+    deprecated: 'Method renamed to fit <a href="..">ProfileEntry</a> record more closely. Use <a href="#extraplayersenabled(nullbool)">extraPlayersEnabled(NullBool)</a> instead.'
+    throws:
+      - name: 'IllegalArgumentException'
+        description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
     type:
       name: 'Builder'
       type: 'object'
@@ -71,8 +225,9 @@ methods:
       - name: 'favicon'
         description: 'The favicon to set'
         type: String
-        attributes:
+        attribute:
           - nullable
+    deprecated: 'Method renamed to fit <a href="..">ProfileEntry</a> record more closely. Use <a href="#favicon(string)">favicon(String)</a> instead.'
     type:
       name: 'Builder'
       type: 'object'
@@ -86,83 +241,15 @@ methods:
       - name: 'hidePlayersEnabled'
         description: 'Whether the player count should be hidden or not.'
         type: NullBool
-        attributes:
+        attribute:
           - notnull
+    deprecated: 'Method renamed to fit <a href="..">ProfileEntry</a> record more closely. Use <a href="#hideplayersenabled(nullbool)">hidePlayersEnabled(NullBool)</a> instead.'
     throws:
       - name: 'IllegalArgumentException'
         description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
     type:
       name: 'Builder'
       type: 'object'
-  - name: 'setExtraPlayersEnabled'
-    description: |
-      Sets whether the extra players feature should be enabled or not.<br>
-      <br>
-      Set to <a href="../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a> to not set this.
-    returns: 'This Builder after the NullBool has been set. Useful for chaining.'
-    parameters:
-      - name: 'extraPlayersEnabled'
-        description: 'Whether the extra players feature should be enabled or not.'
-        type: NullBool
-        attributes:
-          - notnull
-    throws:
-      - name: 'IllegalArgumentException'
-        description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
-    type:
-      name: 'Builder'
-      type: 'object'
-  - name: 'setMaxPlayersEnabled'
-    description: |
-      Sets whether the max players feature should be enabled.<br>
-      <br>
-      Set to <a href="../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a> to not set this.
-    returns: 'This Builder after the NullBool has been set. Useful for chaining.'
-    parameters:
-      - name: 'maxPlayersEnabled'
-        description: 'Whether the extra players feature should be enabled or not.'
-        type: NullBool
-        attributes:
-          - notnull
-    throws:
-      - name: 'IllegalArgumentException'
-        description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
-    type:
-      name: 'Builder'
-      type: 'object'
-  - name: 'setExtraPlayerCount'
-    description: |
-      Sets the number of players to add to the online players to use as the new max players value.<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>.
-    returns: 'This Builder after the extra player count has been set. Useful for chaining.'
-    parameters:
-      - name: 'extraPlayersCount'
-        description: 'The number of extra players to add.'
-        type: Integer
-        attributes:
-          - nullable
-    deprecated: 'Typo in the name. Use <a href="#setextraplayerscount(integer)">setExtraPlayersCount(Integer)</a> instead.'
-    type:
-      name: 'Builder'
-      type: 'object'
-  - name: 'setExtraPlayersCount'
-    description: |
-      Sets the number of players to add to the online players to use as the new max players value.<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>.
-    returns: 'This Builder after the extra player count has been set. Useful for chaining.'
-    parameters:
-      - name: 'extraPlayersCount'
-        description: 'The number of extra players to add.'
-        type: Integer
-        attributes:
-          - nullable
-    type:
-      name: 'Builder'
-      type: 'object'
   - name: 'setMaxPlayersCount'
     description: |
       Sets the number of max players allowed to join this server.<br>
@@ -174,18 +261,86 @@ methods:
       - name: 'maxPlayersCount'
         description: 'The number of max players to set.'
         type: Integer
-        attributes:
+        attribute:
           - nullable
+    deprecated: 'Method renamed to fit <a href="..">ProfileEntry</a> record more closely. Use <a href="#maxplayerscount(integer)">maxPlayersCount(Integer)</a> instead.'
     type:
       name: 'Builder'
       type: 'object'
-  - name: 'build'
-    description: 'Creates a new <a href="./.."><code>ProfileEntry</code> instance</a> with the values set in this Builder.'
-    returns: 'New <a href="./.."><code>ProfileEntry</code> instance</a>.'
+  - name: 'setMaxPlayersEnabled'
+    description: |
+      Sets whether the max players feature should be enabled.<br>
+      <br>
+      Set to <a href="../../objects/nullbool/#not_set"><code>NullBool.NOT_SET</code></a> to not set this.
+    returns: 'This Builder after the NullBool has been set. Useful for chaining.'
+    parameters:
+      - name: 'maxPlayersEnabled'
+        description: 'Whether the extra players feature should be enabled or not.'
+        type: NullBool
+        attribute:
+          - notnull
+    deprecated: 'Method renamed to fit <a href="..">ProfileEntry</a> record more closely. Use <a href="#maxplayersenabled(nullbool)">maxPlayersEnabled(NullBool)</a> instead.'
+    throws:
+      - name: 'IllegalArgumentException'
+        description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
     type:
-      name: 'ProfileEntry'
+      name: 'Builder'
+      type: 'object'
+  - name: 'setMotd'
+    description: |
+      Sets a new MOTD to use.<br>
+      <br>
+      Set to an empty list to not change the MOTD.<br>
+      Only the first two entries of the list will be considered and any additional ones discarded.
+    returns: 'This Builder after the motd has been set. Useful for chaining.'
+    parameters:
+      - name: 'motd'
+        description: 'The MOTD to use.'
+        type: 'List<String>'
+        attribute:
+          - notnull
+    deprecated: 'Method renamed to fit <a href="..">ProfileEntry</a> record more closely. Use <a href="#motd(string)">motd(String)</a> instead.'
+    throws:
+      - name: 'IllegalArgumentException'
+        description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
+    type:
+      name: 'Builder'
+      type: 'object'
+  - name: 'setPlayerCountText'
+    description: |
+      Sets the text to override the player count with.<br>
+      <br>
+      Set to an empty String or <code>null</code> to not alter the player count text.
+    returns: 'This Builder after the player count text has been set. Useful for chaining.'
+    parameters:
+      - name: 'playerCountText'
+        description: 'The text to show in the player count.'
+        type: String
+        attribute:
+          - nullable
+    deprecated: 'Method renamed to fit <a href="..">ProfileEntry</a> record more closely. Use <a href="#playercounttext(string)">playerCountText(String)</a> instead.'
+    type:
+      name: 'Builder'
+      type: 'object'
+  - name: 'setPlayers'
+    description: |
+      Sets the players (lines) to use for the hover.<br>
+      <br>
+      Set to an empty list to not change the hover text.
+    returns: 'This Builder after the players have been set. Useful for chaining.'
+    parameters:
+      - name: 'players'
+        description: 'The lines to set for the hover.'
+        type: 'List<String>'
+        attribute:
+          - notnull
+    deprecated: 'Method renamed to fit <a href="..">ProfileEntry</a> record more closely. Use <a href="#players(list<string>)">players(List&lt;String&gt;)</a> instead.'
+    throws:
+      - name: 'IllegalArgumentException'
+        description: 'Thrown by the <code>CheckUtil</code> in case <code>null</code> has been provided as parameter.'
+    type:
+      name: 'Builder'
       type: 'object'
-      link: './..'
 ---
 
 # <api__class></api__class> Builder

docs/getting-started/index.md

@@ -53,46 +53,67 @@ The plugin also supports these additional plugins. They are all optional.
 <div class="grid cards" markdown>
 
 -   [**PlaceholderAPI**][placeholderapi]
-
+    
     ----
     
-    Supported on:
+    AdvancedServerList supports the use of placeholder from PlaceholderAPI in all its text options, excluding the `condition` option.
     
-    - :fontawesome-solid-paper-plane: Paper
+    ----
+    
+    **Supported on:**  
+    :fontawesome-solid-paper-plane: Paper
 
 -   [**ViaVersion**][viaversion]
     
     ----
     
-    Supported on:
+    When installed will AdvancedServerList use ViaVersion to resolve the protocol version of a player for its PlaceholderAPI placeholders.
     
-    - :fontawesome-solid-paper-plane: Paper
+    ----
+
+    **Supported on:**  
+    :fontawesome-solid-paper-plane: Paper
 
 -   [**PAPIProxyBridge**][papiproxybridge]
     
     ----
     
-    Supported on:
+    Allows AdvancedServerList to parse placeholders from PlaceholderAPI while being used on a proxy.
     
-    - :simple-spigotmc: BungeeCord
-    - :fontawesome-solid-paper-plane: Velocity
+    ----
+
+    **Supported on:**  
+    :simple-spigotmc: BungeeCord, :fontawesome-solid-paper-plane: Velocity
 
 -   [**Maintenance**][maintenance]
     
     ----
     
-    Supported on:
+    AdvancedServerList will disable any modification of the server list entry should Maintenance mode be enabled.
     
-    - :fontawesome-solid-paper-plane: Paper
-    - :simple-spigotmc: BungeeCord
-    - :fontawesome-solid-paper-plane: Velocity
+    ----
+
+    **Supported on:**  
+    :fontawesome-solid-paper-plane: Paper, :simple-spigotmc: BungeeCord, :fontawesome-solid-paper-plane: Velocity
+
+-   [**BanPlugins Addon**][addon]
     
+    ----
+    
+    Official Add-on for AdvancedServerList that adds placeholders for different Ban/Punishment plugins such as AdvancedBan and LibertyBans.
+    
+    ----
+
+    **Supported on:**  
+    :fontawesome-solid-paper-plane: Paper, :simple-spigotmc: BungeeCord, :fontawesome-solid-paper-plane: Velocity
+
 </div>
 
 [placeholderapi]: https://hangar.papermc.io/HelpChat/PlaceholderAPI
 [viaversion]: https://hangar.papermc.io/ViaVersion/ViaVersion
 [papiproxybridge]: https://hangar.papermc.io/William278/PAPIProxyBridge
 [maintenance]: https://hangar.papermc.io/kennytv/Maintenance
+[addon]: ../addons/banplugins.md
 
 ## 2. Installation { #installation }
 

docs/profiles/expressions.md

@@ -33,7 +33,7 @@ The following cases are considered literal values:
 Any number is considered an expression, meaning the below examples are considered valid:
 
 /// example | Examples
-```
+```shell
 0
 1000
 -7
@@ -53,7 +53,7 @@ To avoid this is it very important to always surround Strings with single or dou
 ///
 
 /// example | Examples
-```
+```shell
 "Hello World!"
 ""
 ```
@@ -68,7 +68,7 @@ Strings `true` and `false` are treated as boolean literals.
 Any [placeholder](placeholders.md) is a valid expression.
 
 /// example | Examples
-```
+```shell
 ${player protocol}
 ${player name}
 
@@ -110,7 +110,7 @@ These additional binary operators can also be used to perform certain actions:
 | `/`      | Divides one number by another. Strings use their text length as number.     |
 
 /// example | Examples
-```
+```shell
 ${player name} != "Anonymous"
 763 > ${player protocol} > 758
 ${player hasPlayedBefore} and ${player isBanned} == "false"
@@ -126,7 +126,7 @@ Parenthesis can be used to prevent ambiguities.
 
 `!` can be used to negate boolean expressions.
 
-```
+```shell
 !${player isWhitelisted}
 ```
 

paper/pom.xml

@@ -92,7 +92,7 @@
         <dependency>
             <groupId>com.viaversion</groupId>
             <artifactId>viaversion-api</artifactId>
-            <version>4.9.2</version>
+            <version>4.9.3</version>
             <scope>provided</scope>
         </dependency>
     </dependencies>

paper/src/main/java/ch/andre601/advancedserverlist/paper/PaperCore.java

@@ -39,11 +39,16 @@ import ch.andre601.advancedserverlist.paper.objects.placeholders.PaperServerPlac
 import org.bstats.bukkit.Metrics;
 import org.bstats.charts.SimplePie;
 import org.bukkit.Bukkit;
+import org.bukkit.World;
+import org.bukkit.entity.Player;
+import org.bukkit.metadata.MetadataValue;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.bukkit.util.CachedServerIcon;
 
 import java.awt.image.BufferedImage;
 import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
 
 public class PaperCore extends JavaPlugin implements PluginCore<CachedServerIcon>{
     
@@ -68,7 +73,7 @@ public class PaperCore extends JavaPlugin implements PluginCore<CachedServerIcon
             }
         }
         
-        this.core = AdvancedServerList.init(this, new PaperPlayerPlaceholders(), new PaperServerPlaceholders());
+        this.core = AdvancedServerList.init(this, new PaperPlayerPlaceholders(), new PaperServerPlaceholders(this));
         
         if(getServer().getPluginManager().isPluginEnabled("PlaceholderAPI"))
             papiPlaceholders = new PAPIPlaceholders(this);
@@ -171,6 +176,21 @@ public class PaperCore extends JavaPlugin implements PluginCore<CachedServerIcon
         return (worldCache = new WorldCache());
     }
     
+    public int getPlayersOnline(World world){
+        List<? extends Player> players = new ArrayList<>(world == null ? getServer().getOnlinePlayers() : world.getPlayers());
+        
+        players.removeIf(player -> {
+            for(MetadataValue metadata : player.getMetadata("vanished")){
+                if(metadata.asBoolean())
+                    return true;
+            }
+            
+            return false;
+        });
+        
+        return players.size();
+    }
+    
     private void printNoPaperWarning(){
         getPluginLogger().warn("======================================================================================");
         getPluginLogger().warn("THIS SERVER DOES NOT USE PAPER OR A COMPATIBLE FORK!");

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

@@ -145,7 +145,7 @@ public class PaperEventWrapper implements GenericEventWrapper<CachedServerIcon,
     
     @Override
     public int getOnlinePlayers(){
-        return event.getNumPlayers();
+        return plugin.getPlayersOnline(null);
     }
     
     @Override

paper/src/main/java/ch/andre601/advancedserverlist/paper/objects/placeholders/PaperServerPlaceholders.java

@@ -28,15 +28,20 @@ package ch.andre601.advancedserverlist.paper.objects.placeholders;
 import ch.andre601.advancedserverlist.api.PlaceholderProvider;
 import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
+import ch.andre601.advancedserverlist.paper.PaperCore;
 import ch.andre601.advancedserverlist.paper.objects.impl.PaperServerImpl;
 import org.bukkit.Bukkit;
 import org.bukkit.World;
 
 public class PaperServerPlaceholders extends PlaceholderProvider{
     
-    public PaperServerPlaceholders(){
+    private final PaperCore plugin;
+    
+    public PaperServerPlaceholders(PaperCore plugin){
         super("server");
+        this.plugin = plugin;
     }
+    
     @Override
     public String parsePlaceholder(String placeholder, GenericPlayer player, GenericServer server){
         if(!(server instanceof PaperServerImpl paperServer))
@@ -58,7 +63,7 @@ public class PaperServerPlaceholders extends PlaceholderProvider{
                         if(world == null)
                             continue;
                         
-                        players += world.getPlayers().size();
+                        players += plugin.getPlayersOnline(world);
                     }
                     
                     yield String.valueOf(players);

pom.xml

@@ -36,9 +36,8 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <project.build.commit/>
         
-        <plugin.version>4.3.0</plugin.version>
+        <plugin.version>4.4.0</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
         <api.version>3.2.1</api.version>

requirements.txt

@@ -1,4 +1,4 @@
-mkdocs-material==9.5.12
+mkdocs-material==9.5.13
 mkdocs-glightbox==0.3.7
 mkdocs-awesome-pages-plugin==2.9.2
 git+https://github.com/Andre601/mkdocs-pagenav-generator

velocity/pom.xml

@@ -63,24 +63,38 @@
             <version>${api.version}</version>
             <scope>compile</scope>
         </dependency>
+        
+        <!-- Velocity API -->
         <dependency>
             <groupId>com.velocitypowered</groupId>
             <artifactId>velocity-api</artifactId>
             <version>3.1.2-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
+        
+        <!-- Metrics -->
         <dependency>
             <groupId>org.bstats</groupId>
             <artifactId>bstats-velocity</artifactId>
             <version>3.0.2</version>
             <scope>compile</scope>
         </dependency>
+        
+        <!-- Configurate -->
         <dependency>
             <groupId>org.spongepowered</groupId>
             <artifactId>configurate-yaml</artifactId>
             <version>4.1.2</version>
             <scope>provided</scope>
         </dependency>
+        
+        <!-- Plugins -->
+        <dependency>
+            <groupId>com.github.LeonMangler</groupId>
+            <artifactId>PremiumVanishAPI</artifactId>
+            <version>2.9.0-4</version>
+            <scope>provided</scope>
+        </dependency>
     </dependencies>
     
     <build>

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

@@ -41,14 +41,19 @@ import com.velocitypowered.api.event.Subscribe;
 import com.velocitypowered.api.event.proxy.ProxyInitializeEvent;
 import com.velocitypowered.api.event.proxy.ProxyShutdownEvent;
 import com.velocitypowered.api.plugin.annotation.DataDirectory;
+import com.velocitypowered.api.proxy.Player;
 import com.velocitypowered.api.proxy.ProxyServer;
+import com.velocitypowered.api.proxy.server.RegisteredServer;
 import com.velocitypowered.api.util.Favicon;
+import de.myzelyam.api.vanish.VelocityVanishAPI;
 import org.bstats.charts.SimplePie;
 import org.bstats.velocity.Metrics;
 import org.slf4j.LoggerFactory;
 
 import java.awt.image.BufferedImage;
 import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
 
 public class VelocityCore implements PluginCore<Favicon>{
     
@@ -71,7 +76,7 @@ public class VelocityCore implements PluginCore<Favicon>{
     
     @Subscribe
     public void init(ProxyInitializeEvent event){
-        this.core = AdvancedServerList.init(this, VelocityPlayerPlaceholders.init(), VelocityServerPlaceholders.init());
+        this.core = AdvancedServerList.init(this, VelocityPlayerPlaceholders.init(), VelocityServerPlaceholders.init(this));
     }
     
     @Subscribe
@@ -154,11 +159,25 @@ public class VelocityCore implements PluginCore<Favicon>{
     }
     
     @Override
-    public Favicon createFavicon(BufferedImage image) throws Exception{
+    public Favicon createFavicon(BufferedImage image){
         return Favicon.create(image);
     }
     
     public ProxyServer getProxy(){
         return proxy;
     }
+    
+    public int getOnlinePlayers(RegisteredServer server){
+        if(getProxy() == null)
+            return -1;
+        
+        List<Player> players = new ArrayList<>(server == null ? getProxy().getAllPlayers() : server.getPlayersConnected());
+        
+        // Exclude players when PremiumVanish is enabled and player is hidden.
+        if(getProxy().getPluginManager().isLoaded("premiumvanish")){
+            players.removeIf(VelocityVanishAPI::isInvisible);
+        }
+        
+        return players.size();
+    }
 }

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

@@ -44,10 +44,7 @@ import com.velocitypowered.api.proxy.server.ServerPing;
 import com.velocitypowered.api.util.Favicon;
 import net.kyori.adventure.text.Component;
 
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.UUID;
+import java.util.*;
 import java.util.concurrent.ExecutionException;
 
 public class VelocityEventWrapper implements GenericEventWrapper<Favicon, VelocityPlayerImpl>{
@@ -146,7 +143,11 @@ public class VelocityEventWrapper implements GenericEventWrapper<Favicon, Veloci
     
     @Override
     public int getOnlinePlayers(){
-        return builder.getOnlinePlayers();
+        int players = plugin.getOnlinePlayers(null);
+        if(players == -1)
+            return builder.getOnlinePlayers();
+        
+        return players;
     }
     
     @Override

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/objects/placeholders/VelocityServerPlaceholders.java

@@ -29,16 +29,20 @@ import ch.andre601.advancedserverlist.api.PlaceholderProvider;
 import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
 import ch.andre601.advancedserverlist.api.velocity.objects.VelocityProxy;
+import ch.andre601.advancedserverlist.velocity.VelocityCore;
 import com.velocitypowered.api.proxy.server.RegisteredServer;
 
 public class VelocityServerPlaceholders extends PlaceholderProvider{
     
-    private VelocityServerPlaceholders(){
+    private final VelocityCore plugin;
+    
+    private VelocityServerPlaceholders(VelocityCore plugin){
         super("server");
+        this.plugin = plugin;
     }
     
-    public static VelocityServerPlaceholders init(){
-        return new VelocityServerPlaceholders();
+    public static VelocityServerPlaceholders init(VelocityCore core){
+        return new VelocityServerPlaceholders(core);
     }
     
     @Override
@@ -62,7 +66,11 @@ public class VelocityServerPlaceholders extends PlaceholderProvider{
                         if(registeredServer == null)
                             continue;
                         
-                        players += registeredServer.getPlayersConnected().size();
+                        int connected = plugin.getOnlinePlayers(registeredServer);
+                        if(connected == -1)
+                            continue;
+                        
+                        players += connected;
                     }
                     
                     yield String.valueOf(players);

version-uploader/pom.xml

@@ -52,7 +52,7 @@
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
-            <version>1.5.1</version>
+            <version>1.5.3</version>
             <scope>compile</scope>
         </dependency>
         <dependency>