Introduce ignore-anonymous-player-request config option

Author: WouterGritter

proxy/src/main/java/com/velocityctd/proxy/util/SamplePlayersPlaceholderResolver.java

@@ -16,6 +16,7 @@ public class SamplePlayersPlaceholderResolver implements PlaceholderSubstitutor.
   private final String defaultEmpty;
   private final String defaultPrefix;
   private final String defaultSeparator;
+  private final boolean ignoreAnonymousPlayerRequest;
 
   private SamplePlayersPlaceholderResolver(Builder builder) {
     this.samplePlayersPicker = builder.samplePlayersPicker;
@@ -25,6 +26,7 @@ private SamplePlayersPlaceholderResolver(Builder builder) {
     this.defaultEmpty = builder.defaultEmpty;
     this.defaultPrefix = builder.defaultPrefix;
     this.defaultSeparator = builder.defaultSeparator;
+    this.ignoreAnonymousPlayerRequest = builder.ignoreAnonymousPlayerRequest;
   }
 
   public static Builder builder(SamplePlayersPicker samplePlayersPicker) {
@@ -38,7 +40,8 @@ public Builder toBuilder() {
         .defaultOrdering(defaultOrdering)
         .defaultEmpty(defaultEmpty)
         .defaultPrefix(defaultPrefix)
-        .defaultSeparator(defaultSeparator);
+        .defaultSeparator(defaultSeparator)
+        .ignoreAnonymousPlayerRequest(ignoreAnonymousPlayerRequest);
   }
 
   @Override
@@ -68,7 +71,7 @@ private String samplePlayers(int max, int maxPerLine, SamplePlayersPicker.Orderi
       VelocityClusterPlayer player = sample.get(i);
 
       String name;
-      if (!player.isClientListingAllowed()) {
+      if (!ignoreAnonymousPlayerRequest && !player.isClientListingAllowed()) {
         name = ServerPing.SamplePlayer.ANONYMOUS.getName();
       } else {
         name = player.getUsername();
@@ -116,6 +119,7 @@ public static class Builder {
     private String defaultEmpty = "None";
     private String defaultPrefix = "";
     private String defaultSeparator = ", ";
+    private boolean ignoreAnonymousPlayerRequest = false;
 
     private Builder(SamplePlayersPicker samplePlayersPicker) {
       this.samplePlayersPicker = samplePlayersPicker;
@@ -151,6 +155,11 @@ public Builder defaultSeparator(String defaultSeparator) {
       return this;
     }
 
+    public Builder ignoreAnonymousPlayerRequest(boolean ignoreAnonymousPlayerRequest) {
+      this.ignoreAnonymousPlayerRequest = ignoreAnonymousPlayerRequest;
+      return this;
+    }
+
     public SamplePlayersPlaceholderResolver build() {
       return new SamplePlayersPlaceholderResolver(this);
     }

proxy/src/main/java/com/velocitypowered/proxy/config/VelocityConfiguration.java

@@ -878,6 +878,19 @@ public String getBackendBrandCustom() {
     return advanced.getBackendBrandCustom();
   }
 
+  /**
+   * Returns whether a client's request to be anonymized in the server list ping should be ignored.
+   *
+   * <p>When a player disables "Allow Server Listings" in their client options, they are normally
+   * shown as "Anonymous Player" in the {@code {players}} sample. When this returns {@code true},
+   * their real username is shown regardless.
+   *
+   * @return {@code true} if the client's anonymization request should be ignored
+   */
+  public boolean isIgnoreAnonymousPlayerRequest() {
+    return advanced.isIgnoreAnonymousPlayerRequest();
+  }
+
   /**
    * Gets the dynamic fallback filter mode configured for server selection.
    *
@@ -2048,6 +2061,15 @@ private static final class Advanced {
     @Expose
     private String backendBrandCustom = "Paper";
 
+    /**
+     * Whether to ignore a client's request to be anonymized in the server list ping. When a player
+     * disables "Allow Server Listings" in their client options, they normally show up as
+     * "Anonymous Player" in the {@code {players}} sample. Enabling this displays their real username
+     * regardless.
+     */
+    @Expose
+    private boolean ignoreAnonymousPlayerRequest = false;
+
     private Advanced() {
     }
 
@@ -2086,6 +2108,7 @@ private Advanced(CommentedConfig config) {
         this.alwaysFallBackPing = config.getOrElse("always-fallback-ping", false);
         this.proxyBrandCustom = config.getOrElse("custom-brand-proxy", "Velocity-CTD");
         this.backendBrandCustom = config.getOrElse("custom-brand-backend", "Paper");
+        this.ignoreAnonymousPlayerRequest = config.getOrElse("ignore-anonymous-player-request", false);
       }
     }
 
@@ -2197,6 +2220,10 @@ public String getBackendBrandCustom() {
       return backendBrandCustom;
     }
 
+    public boolean isIgnoreAnonymousPlayerRequest() {
+      return ignoreAnonymousPlayerRequest;
+    }
+
     @Override
     public String toString() {
       return MoreObjects.toStringHelper(this)
@@ -2226,6 +2253,7 @@ public String toString() {
           .add("alwaysFallBackPing", alwaysFallBackPing)
           .add("proxyBrandCustom", proxyBrandCustom)
           .add("backendBrandCustom", backendBrandCustom)
+          .add("ignoreAnonymousPlayerRequest", ignoreAnonymousPlayerRequest)
           .toString();
     }
 

proxy/src/main/java/com/velocitypowered/proxy/connection/util/ServerListPingHandler.java

@@ -96,6 +96,7 @@ private ServerPing constructLocalPing(ProtocolVersion clientVersion) {
             .defaultMax(8)
             .defaultMaxPerLine(4)
             .defaultSeparator(", ")
+            .ignoreAnonymousPlayerRequest(configuration.isIgnoreAnonymousPlayerRequest())
             .build());
 
     List<String> motdHover = PlaceholderSubstitutor.substitute(
@@ -105,6 +106,7 @@ private ServerPing constructLocalPing(ProtocolVersion clientVersion) {
             .defaultMax(12)
             .defaultMaxPerLine(1)
             .defaultSeparator("")
+            .ignoreAnonymousPlayerRequest(configuration.isIgnoreAnonymousPlayerRequest())
             .build());
 
     String versionName = PlaceholderSubstitutor.substitute(
@@ -114,6 +116,7 @@ private ServerPing constructLocalPing(ProtocolVersion clientVersion) {
             .defaultMax(2)
             .defaultMaxPerLine(Integer.MAX_VALUE)
             .defaultSeparator(", ")
+            .ignoreAnonymousPlayerRequest(configuration.isIgnoreAnonymousPlayerRequest())
             .build());
 
     return new ServerPing(

proxy/src/main/resources/default-velocity.toml

@@ -385,6 +385,11 @@ custom-brand-proxy = "Velocity-CTD"
 # Replaces what is returned as the server brand for the user's client.
 custom-brand-backend = "Paper"
 
+# When a player disables "Allow Server Listings" in their client options, they are shown as
+# "Anonymous Player" in the {players} sample of the server list ping. Set this to true to ignore
+# that request and always show their real username.
+ignore-anonymous-player-request = false
+
 [slash-servers]
 # Defines "/<name>" aliases for servers - here "/faction" and "/factions" would both send you to the server named
 # "factions", for example.