Add ServerlinkModule#LEGACY_BUTTON_PLACEMENT & ServerLinkModule#MODERN_BUTTON_PLACEMENT (#291)

Author: ItsNature

api/src/main/java/com/lunarclient/apollo/module/combat/CombatModule.java

@@ -45,7 +45,10 @@ public final class CombatModule extends ApolloModule {
      * @since 1.0.4
      */
     public static final SimpleOption<Boolean> DISABLE_MISS_PENALTY = Option.<Boolean>builder()
-        .comment("Set to 'true' to remove the miss penalty on all versions 1.8 and above, otherwise 'false'. Enabling this option may cause compatibility issues with anti-cheats.")
+        .comment(
+            "Set to 'true' to remove the miss penalty on all versions 1.8 and above, otherwise 'false'.",
+            "Enabling this option may cause compatibility issues with anti-cheats."
+        )
         .node("disable-miss-penalty").type(TypeToken.get(Boolean.class))
         .defaultValue(false).notifyClient().build();
 
@@ -58,7 +61,10 @@ public final class CombatModule extends ApolloModule {
      * @since 1.2.8
      */
     public static final SimpleOption<Boolean> ALLOW_DIG_AND_USE = Option.<Boolean>builder()
-        .comment("Set to 'true' to allow digging and using an item at the same time on all versions 1.8 and above, otherwise 'false'. Enabling this option may cause compatibility issues with anti-cheats.")
+        .comment(
+            "Set to 'true' to allow digging and using an item at the same time on all versions 1.8 and above, otherwise 'false'.",
+            "Enabling this option may cause compatibility issues with anti-cheats."
+        )
         .node("allow-dig-and-use").type(TypeToken.get(Boolean.class))
         .defaultValue(false).notifyClient().build();
 

api/src/main/java/com/lunarclient/apollo/module/serverlink/ServerLinkModule.java

@@ -26,7 +26,12 @@
 import com.lunarclient.apollo.common.icon.ResourceLocationIcon;
 import com.lunarclient.apollo.module.ApolloModule;
 import com.lunarclient.apollo.module.ModuleDefinition;
+import com.lunarclient.apollo.module.serverlink.pausemenu.LegacyServerLinkPlacement;
+import com.lunarclient.apollo.module.serverlink.pausemenu.ModernServerLinkPlacement;
+import com.lunarclient.apollo.option.EnumOption;
+import com.lunarclient.apollo.option.Option;
 import com.lunarclient.apollo.recipients.Recipients;
+import io.leangen.geantyref.TypeToken;
 import java.util.List;
 import org.jetbrains.annotations.ApiStatus;
 
@@ -42,6 +47,49 @@
 @ModuleDefinition(id = "server_link", name = "Server Link")
 public abstract class ServerLinkModule extends ApolloModule {
 
+    /**
+     * Controls where the server links button is placed in the pause menu
+     * (1.7-1.12), where it is added on a new line by default.
+     *
+     * @since 1.2.8
+     */
+    public static final EnumOption<LegacyServerLinkPlacement> LEGACY_BUTTON_PLACEMENT = Option.<LegacyServerLinkPlacement>enumerator()
+        .comment(
+            "Where the server links button appears in the pause menu (1.7-1.12), added on a new line by default.",
+            " 'NEW_ROW' adds a dedicated row.",
+            " 'REPLACE_ACHIEVEMENTS' reuses the achievements button.",
+            " 'REPLACE_STATISTICS' reuses the statistics button."
+        )
+        .node("legacy-button-placement").type(TypeToken.get(LegacyServerLinkPlacement.class))
+        .defaultValue(LegacyServerLinkPlacement.NEW_ROW).notifyClient().build();
+
+    /**
+     * Controls where the server links button is placed in the pause menu
+     * (1.16.1+), where it replaces the existing report bugs button by default.
+     *
+     * <p>On 1.21 and above the server links button is handled natively and this
+     * option has no effect.</p>
+     *
+     * @since 1.2.8
+     */
+    public static final EnumOption<ModernServerLinkPlacement> MODERN_BUTTON_PLACEMENT = Option.<ModernServerLinkPlacement>enumerator()
+        .comment(
+            "Where the server links button appears in the pause menu (1.16.1+), replaces the existing report bugs button by default.",
+            " 'REPLACE_REPORT_BUGS' reuses the report bugs button.",
+            " 'REPLACE_ACHIEVEMENTS' reuses the advancements button.",
+            " 'REPLACE_STATISTICS' reuses the statistics button.",
+            "Has no effect on 1.21+ (handled natively)."
+        )
+        .node("modern-button-placement").type(TypeToken.get(ModernServerLinkPlacement.class))
+        .defaultValue(ModernServerLinkPlacement.REPLACE_REPORT_BUGS).notifyClient().build();
+
+    ServerLinkModule() {
+        this.registerOptions(
+            ServerLinkModule.LEGACY_BUTTON_PLACEMENT,
+            ServerLinkModule.MODERN_BUTTON_PLACEMENT
+        );
+    }
+
     /**
      * Overrides the server link menu title image for the {@link Recipients}.
      *

api/src/main/java/com/lunarclient/apollo/module/serverlink/pausemenu/LegacyServerLinkPlacement.java

@@ -0,0 +1,56 @@
+/*
+ * This file is part of Apollo, licensed under the MIT License.
+ *
+ * Copyright (c) 2026 Moonsworth
+ *
+ * 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 com.lunarclient.apollo.module.serverlink.pausemenu;
+
+/**
+ * Represents where the server links button is placed in the pause menu
+ * (1.7-1.12), where it is added on a new line by default.
+ *
+ * @since 1.2.8
+ */
+public enum LegacyServerLinkPlacement {
+
+    /**
+     * Adds the server links button on a dedicated new row, shifting the
+     * remaining buttons down.
+     *
+     * @since 1.2.8
+     */
+    NEW_ROW,
+
+    /**
+     * Replaces the vanilla achievements button with the server links button.
+     *
+     * @since 1.2.8
+     */
+    REPLACE_ACHIEVEMENTS,
+
+    /**
+     * Replaces the vanilla statistics button with the server links button.
+     *
+     * @since 1.2.8
+     */
+    REPLACE_STATISTICS
+
+}

api/src/main/java/com/lunarclient/apollo/module/serverlink/pausemenu/ModernServerLinkPlacement.java

@@ -0,0 +1,58 @@
+/*
+ * This file is part of Apollo, licensed under the MIT License.
+ *
+ * Copyright (c) 2026 Moonsworth
+ *
+ * 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 com.lunarclient.apollo.module.serverlink.pausemenu;
+
+/**
+ * Represents where the server links button is placed in the pause menu
+ * (1.16.1+), where it replaces the existing report bugs button by default.
+ *
+ * <p>On 1.21 and above the server links button is handled natively and this
+ * option has no effect.</p>
+ *
+ * @since 1.2.8
+ */
+public enum ModernServerLinkPlacement {
+
+    /**
+     * Replaces the report bugs button with the server links button.
+     *
+     * @since 1.2.8
+     */
+    REPLACE_REPORT_BUGS,
+
+    /**
+     * Replaces the vanilla advancements button with the server links button.
+     *
+     * @since 1.2.8
+     */
+    REPLACE_ACHIEVEMENTS,
+
+    /**
+     * Replaces the vanilla statistics button with the server links button.
+     *
+     * @since 1.2.8
+     */
+    REPLACE_STATISTICS
+
+}

api/src/main/java/com/lunarclient/apollo/option/OptionBuilder.java

@@ -86,6 +86,22 @@ public M comment(@Nullable String comment) {
         return (M) this;
     }
 
+    /**
+     * Sets the option comment to the provided lines, joined with a newline, and
+     * returns this builder.
+     *
+     * <p>Each provided line is rendered as its own comment line in the
+     * configuration.</p>
+     *
+     * @param lines the comment lines
+     * @return this builder
+     * @since 1.2.8
+     */
+    public M comment(@NonNull String... lines) {
+        this.comment = String.join("\n", lines);
+        return (M) this;
+    }
+
     /**
      * Sets the option default value to the provided {@code T} value and
      * returns this builder.

docs/developers/lightweight/json/packet-util.mdx

@@ -15,7 +15,7 @@ To utilize Apollo Modules, first define a list of the modules you want to use:
 ```java
 private static final List<String> APOLLO_MODULES = Arrays.asList("auto_text_hotkey", "beam", "border", "chat", "colored_fire", "combat", "cooldown",
     "entity", "glint", "glow", "hologram", "inventory", "limb", "mod_setting", "nametag", "nick_hider", "notification", "pay_now", "packet_enrichment",
-    "rich_presence", "saturation", "server_rule", "staff_mod", "stopwatch", "team", "tebex", "title", "tnt_countdown", "transfer", "vignette", "waypoint"
+    "rich_presence", "saturation", "server_link", "server_rule", "staff_mod", "stopwatch", "team", "tebex", "title", "tnt_countdown", "transfer", "vignette", "waypoint"
 );
 ```
 
@@ -41,6 +41,8 @@ static {
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-close.send-packet", false);
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-use-item.send-packet", false);
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-use-item-bucket.send-packet", false);
+    CONFIG_MODULE_PROPERTIES.put("server_link", "legacy-button-placement", "NEW_ROW");
+    CONFIG_MODULE_PROPERTIES.put("server_link", "modern-button-placement", "REPLACE_REPORT_BUGS");
     CONFIG_MODULE_PROPERTIES.put("server_rule", "competitive-game", false);
     CONFIG_MODULE_PROPERTIES.put("server_rule", "competitive-commands", Arrays.asList("/server", "/servers", "/hub"));
     CONFIG_MODULE_PROPERTIES.put("server_rule", "disable-shaders", false);

docs/developers/lightweight/protobuf/packet-util.mdx

@@ -15,7 +15,7 @@ To utilize Apollo Modules, first define a list of the modules you want to use:
 ```java
 private static final List<String> APOLLO_MODULES = Arrays.asList("auto_text_hotkey", "beam", "border", "chat", "colored_fire", "combat", "cooldown",
     "entity", "glint", "glow", "hologram", "inventory", "limb", "mod_setting", "nametag", "nick_hider", "notification", "pay_now", "packet_enrichment",
-    "rich_presence", "saturation", "server_rule", "staff_mod", "stopwatch", "team", "tebex", "title", "tnt_countdown", "transfer", "vignette", "waypoint"
+    "rich_presence", "saturation", "server_link", "server_rule", "staff_mod", "stopwatch", "team", "tebex", "title", "tnt_countdown", "transfer", "vignette", "waypoint"
 );
 ```
 
@@ -41,6 +41,8 @@ static {
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-close.send-packet", Value.newBuilder().setBoolValue(false).build());
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-use-item.send-packet", Value.newBuilder().setBoolValue(false).build());
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-use-item-bucket.send-packet", Value.newBuilder().setBoolValue(false).build());
+    CONFIG_MODULE_PROPERTIES.put("server_link", "legacy-button-placement", Value.newBuilder().setStringValue("NEW_ROW").build());
+    CONFIG_MODULE_PROPERTIES.put("server_link", "modern-button-placement", Value.newBuilder().setStringValue("REPLACE_REPORT_BUGS").build());
     CONFIG_MODULE_PROPERTIES.put("server_rule", "competitive-game", Value.newBuilder().setBoolValue(false).build());
     CONFIG_MODULE_PROPERTIES.put("server_rule", "competitive-commands", Value.newBuilder().setListValue(
         ListValue.newBuilder().addAllValues(Arrays.asList(

docs/developers/modules/serverlink.mdx

@@ -100,6 +100,24 @@ public void resetServerLinksExample(Player viewer) {
 }
 ```
 
+### Set Legacy Button Placement
+
+```java
+public void setLegacyButtonPlacementExample(String placement) {
+    LegacyServerLinkPlacement legacyPlacement = LegacyServerLinkPlacement.valueOf(placement);
+    this.serverLinkModule.getOptions().set(ServerLinkModule.LEGACY_BUTTON_PLACEMENT, legacyPlacement);
+}
+```
+
+### Set Modern Button Placement
+
+```java
+public void setModernButtonPlacementExample(String placement) {
+    ModernServerLinkPlacement modernPlacement = ModernServerLinkPlacement.valueOf(placement);
+    this.serverLinkModule.getOptions().set(ServerLinkModule.MODERN_BUTTON_PLACEMENT, modernPlacement);
+}
+```
+
 ### `ServerLink` Options
 
 `.id(String)` sets a unique identifier for the server link.
@@ -205,6 +223,30 @@ public void resetServerLinksExample(Player viewer) {
 }
 ```
 
+**Set Legacy Button Placement**
+
+```java
+public void setLegacyButtonPlacementExample(String placement) {
+    Map<String, Value> properties = new HashMap<>();
+    properties.put("legacy-button-placement", Value.newBuilder().setStringValue(placement).build());
+
+    ConfigurableSettings settings = ProtobufPacketUtil.createModuleMessage("server_link", properties);
+    ProtobufPacketUtil.broadcastPacket(settings);
+}
+```
+
+**Set Modern Button Placement**
+
+```java
+public void setModernButtonPlacementExample(String placement) {
+    Map<String, Value> properties = new HashMap<>();
+    properties.put("modern-button-placement", Value.newBuilder().setStringValue(placement).build());
+
+    ConfigurableSettings settings = ProtobufPacketUtil.createModuleMessage("server_link", properties);
+    ProtobufPacketUtil.broadcastPacket(settings);
+}
+```
+
 </Tab>
 
 <Tab>
@@ -288,6 +330,44 @@ public void resetServerLinksExample(Player viewer) {
 }
 ```
 
+**Set Legacy Button Placement**
+
+```java
+public void setLegacyButtonPlacementExample(String placement) {
+    Map<String, Object> properties = new HashMap<>();
+    properties.put("legacy-button-placement", placement);
+
+    JsonObject message = JsonUtil.createEnableModuleObjectWithType("server_link", properties);
+    JsonPacketUtil.broadcastPacket(message);
+}
+```
+
+**Set Modern Button Placement**
+
+```java
+public void setModernButtonPlacementExample(String placement) {
+    Map<String, Object> properties = new HashMap<>();
+    properties.put("modern-button-placement", placement);
+
+    JsonObject message = JsonUtil.createEnableModuleObjectWithType("server_link", properties);
+    JsonPacketUtil.broadcastPacket(message);
+}
+```
+
 </Tab>
 
 </Tabs>
+
+## Available options
+
+- __`LEGACY_BUTTON_PLACEMENT`__
+    - Where the server links button appears in the pause menu (1.7-1.12), where it is added on a new line by default.
+    - Values
+        - Type: `LegacyServerLinkPlacement` (`NEW_ROW`, `REPLACE_ACHIEVEMENTS`, `REPLACE_STATISTICS`)
+        - Default: `NEW_ROW`
+
+- __`MODERN_BUTTON_PLACEMENT`__
+    - Where the server links button appears in the pause menu (1.16.1+), where it replaces the existing report bugs button by default. Has no effect on 1.21+ (handled natively).
+    - Values
+        - Type: `ModernServerLinkPlacement` (`REPLACE_REPORT_BUGS`, `REPLACE_ACHIEVEMENTS`, `REPLACE_STATISTICS`)
+        - Default: `REPLACE_REPORT_BUGS`

example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/ServerLinkApiExample.java

@@ -29,6 +29,8 @@
 import com.lunarclient.apollo.example.module.impl.ServerLinkExample;
 import com.lunarclient.apollo.module.serverlink.ServerLink;
 import com.lunarclient.apollo.module.serverlink.ServerLinkModule;
+import com.lunarclient.apollo.module.serverlink.pausemenu.LegacyServerLinkPlacement;
+import com.lunarclient.apollo.module.serverlink.pausemenu.ModernServerLinkPlacement;
 import com.lunarclient.apollo.player.ApolloPlayer;
 import java.util.Optional;
 import net.kyori.adventure.text.Component;
@@ -98,4 +100,16 @@ public void resetServerLinksExample(Player viewer) {
         apolloPlayerOpt.ifPresent(this.serverLinkModule::resetServerLinks);
     }
 
+    @Override
+    public void setLegacyButtonPlacementExample(String placement) {
+        LegacyServerLinkPlacement legacyPlacement = LegacyServerLinkPlacement.valueOf(placement);
+        this.serverLinkModule.getOptions().set(ServerLinkModule.LEGACY_BUTTON_PLACEMENT, legacyPlacement);
+    }
+
+    @Override
+    public void setModernButtonPlacementExample(String placement) {
+        ModernServerLinkPlacement modernPlacement = ModernServerLinkPlacement.valueOf(placement);
+        this.serverLinkModule.getOptions().set(ServerLinkModule.MODERN_BUTTON_PLACEMENT, modernPlacement);
+    }
+
 }