example: add mod status command

Author: ItsNature

api/src/main/java/com/lunarclient/apollo/event/mods/ApolloUpdateModOptionEvent.java

@@ -25,7 +25,6 @@
 
 import com.lunarclient.apollo.event.Event;
 import com.lunarclient.apollo.option.Option;
-import com.lunarclient.apollo.option.Options;
 import com.lunarclient.apollo.player.ApolloPlayer;
 import lombok.Value;
 import org.jetbrains.annotations.Nullable;
@@ -38,15 +37,6 @@
 @Value
 public final class ApolloUpdateModOptionEvent implements Event {
 
-    // TODO: not needed?
-    /**
-     * The {@link Options} container that the option is in.
-     *
-     * @return the options container
-     * @since 1.2.1
-     */
-    Options container;
-
     /**
      * The {@link ApolloPlayer} that the option was updated for.
      *

api/src/main/java/com/lunarclient/apollo/mods/ModStatus.java

@@ -44,6 +44,6 @@ public interface ModStatus {
      * @return the value of the option
      * @since 1.2.1
      */
-    public <T, C extends Option<T, ?, ?>> T get(@NonNull C option);
+    <T, C extends Option<T, ?, ?>> T get(@NonNull C option);
 
 }

common/src/main/java/com/lunarclient/apollo/mods/ApolloModsManager.java

@@ -23,15 +23,23 @@
  */
 package com.lunarclient.apollo.mods;
 
+import com.google.protobuf.Any;
+import com.google.protobuf.InvalidProtocolBufferException;
+import com.google.protobuf.Value;
+import com.lunarclient.apollo.configurable.v1.ConfigurableSettings;
+import com.lunarclient.apollo.configurable.v1.OverrideConfigurableSettingsMessage;
 import com.lunarclient.apollo.event.ApolloListener;
 import com.lunarclient.apollo.event.ApolloReceivePacketEvent;
 import com.lunarclient.apollo.event.EventBus;
 import com.lunarclient.apollo.event.Listen;
+import com.lunarclient.apollo.event.mods.ApolloUpdateModOptionEvent;
+import com.lunarclient.apollo.network.NetworkOptions;
 import com.lunarclient.apollo.option.Option;
-import com.lunarclient.apollo.option.Options;
 import com.lunarclient.apollo.option.StatusOptionsImpl;
+import com.lunarclient.apollo.player.ApolloPlayer;
 import java.lang.reflect.Field;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -47,7 +55,7 @@
 public final class ApolloModsManager implements ApolloListener {
 
     private final Container container;
-    private final Options playerOptions;
+    private final StatusOptionsImpl playerOptions;
 
     /**
      * Constructs the {@link ApolloModsManager}.
@@ -58,11 +66,7 @@ public ApolloModsManager() {
         EventBus.getBus().register(this);
 
         this.container = ApolloModsManager.loadModOptions();
-        this.playerOptions = new StatusOptionsImpl();
-
-        for (Option<?, ?, ?> option : this.container.getModStatusOptions().values()) {
-            this.playerOptions.set(option, option.getDefaultValue());
-        }
+        this.playerOptions = new StatusOptionsImpl(this.container.getModStatusOptions());
     }
 
     /**
@@ -133,7 +137,54 @@ public static class Container {
 
     @Listen
     private void onApolloReceivePacket(ApolloReceivePacketEvent event) {
+        ApolloPlayer player = event.getPlayer();
+        Any packet = event.getPacket();
 
+        if(packet.is(OverrideConfigurableSettingsMessage.class) || packet.is(ConfigurableSettings.class)) {
+            this.handleConfiguration(player, packet);
+        }
     }
 
+    private void handleConfiguration(ApolloPlayer player, Any any) {
+        // Unpack the settings first.
+        List<ConfigurableSettings> settings;
+        try {
+            if (any.is(OverrideConfigurableSettingsMessage.class)) {
+                OverrideConfigurableSettingsMessage message = any.unpack(OverrideConfigurableSettingsMessage.class);
+                settings = message.getConfigurableSettingsList();
+            } else {
+                settings = Collections.singletonList(any.unpack(ConfigurableSettings.class));
+            }
+        } catch (InvalidProtocolBufferException exception) {
+            throw new RuntimeException(exception);
+        }
+
+        for (ConfigurableSettings setting : settings) {
+            if (!setting.hasApolloModule()) {
+                continue;
+            }
+
+            if (!setting.getApolloModule().equals("mod_status")) {
+                continue;
+            }
+
+            for (Map.Entry<String, Value> entry : setting.getPropertiesMap().entrySet()) {
+                Option<?, ?, ?> option = this.playerOptions.getOptionsByKey().get(entry.getKey());
+
+                Object unwrappedValue = NetworkOptions.unwrapValue(
+                    entry.getValue(),
+                    option.getTypeToken().getType()
+                );
+
+                this.playerOptions.set(player, option, unwrappedValue);
+
+                EventBus.EventResult<ApolloUpdateModOptionEvent> eventResult = EventBus.getBus()
+                    .post(new ApolloUpdateModOptionEvent(player, option, unwrappedValue));
+
+                for (Throwable throwable : eventResult.getThrowing()) {
+                    throwable.printStackTrace();
+                }
+            }
+        }
+    }
 }

common/src/main/java/com/lunarclient/apollo/option/StatusOptionsImpl.java

@@ -23,12 +23,13 @@
  */
 package com.lunarclient.apollo.option;
 
-import com.lunarclient.apollo.event.EventBus;
-import com.lunarclient.apollo.event.mods.ApolloUpdateModOptionEvent;
 import com.lunarclient.apollo.player.ApolloPlayer;
 import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Objects;
 import java.util.WeakHashMap;
+import lombok.Getter;
 import lombok.NonNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -39,13 +40,24 @@
  */
 public class StatusOptionsImpl extends OptionsImpl {
 
+    @Getter
+    private final Map<String, Option<?, ?, ?>> optionsByKey = new HashMap<>();
+
     /**
      * Constructs a new {@link StatusOptionsImpl}.
      *
+     * @param options the mod options with default values
      * @since 1.2.1
      */
-    public StatusOptionsImpl() {
+    public StatusOptionsImpl(Map<String, Option<?, ?, ?>> options) {
         super(null);
+
+        for (Map.Entry<String, Option<?, ?, ?>> entry : options.entrySet()) {
+            Option<?, ?, ?> option = entry.getValue();
+
+            this.set(option, option.getDefaultValue());
+            this.optionsByKey.put(entry.getKey(), option);
+        }
     }
 
     @Override
@@ -69,13 +81,6 @@ public <T> void set(@NonNull ApolloPlayer player, @NonNull Option<?, ?, ?> optio
 
     @Override
     protected boolean postEvent(Option<?, ?, ?> option, @Nullable ApolloPlayer player, @Nullable Object value) {
-        EventBus.EventResult<ApolloUpdateModOptionEvent> eventResult = EventBus.getBus()
-            .post(new ApolloUpdateModOptionEvent(this, player, option, value));
-
-        for (Throwable throwable : eventResult.getThrowing()) {
-            throwable.printStackTrace();
-        }
-
         return false;
     }
 

example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/ApolloApiExamplePlatform.java

@@ -30,6 +30,7 @@
 import com.lunarclient.apollo.example.api.debug.impl.SpamPacketDebug;
 import com.lunarclient.apollo.example.api.listener.ApolloPlayerApiListener;
 import com.lunarclient.apollo.example.api.mods.ApolloModStatusExample;
+import com.lunarclient.apollo.example.api.mods.ModStatusCommand;
 import com.lunarclient.apollo.example.api.module.AutoTextHotkeyApiExample;
 import com.lunarclient.apollo.example.api.module.BeamApiExample;
 import com.lunarclient.apollo.example.api.module.BorderApiExample;
@@ -74,6 +75,7 @@ public void enable() {
     @Override
     public void registerCommands() {
         this.getCommand("apollodebug").setExecutor(new ApolloDebugCommand());
+        this.getCommand("modstatus").setExecutor(new ModStatusCommand());
     }
 
     @Override

example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/mods/ApolloModStatusExample.java

@@ -33,6 +33,8 @@
 import com.lunarclient.apollo.mods.impl.ModFreelook;
 import com.lunarclient.apollo.mods.impl.ModMinimap;
 import com.lunarclient.apollo.mods.impl.ModWaypoints;
+import java.util.Objects;
+import net.kyori.adventure.text.Component;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
@@ -48,7 +50,9 @@ public ApolloModStatusExample(ApolloExamplePlugin plugin) {
 
     @Listen
     private void onApolloUpdateModOption(ApolloUpdateModOptionEvent event) {
-        System.out.println(event.getOption().getKey() + " was updated to " + event.getValue());
+        event.getPlayer().sendMessage(Component.text(event.getOption().getKey())
+            .append(Component.text(" was updated to "))
+            .append(Component.text(Objects.toString(event.getValue()))));
     }
 
     @EventHandler(ignoreCancelled = true)
@@ -58,10 +62,17 @@ private void onBlockPlace(BlockPlaceEvent event) {
         Apollo.getPlayerManager().getPlayer(player.getUniqueId()).ifPresent(apolloPlayer -> {
             ModStatus status = apolloPlayer.getModStatus();
 
-            System.out.println("Waypoints Enabled: " + status.get(ModWaypoints.ENABLED));
-            System.out.println("Freelook Invert Yaw: " + status.get(ModFreelook.INVERT_YAW));
-            System.out.println("Freelook Invert Pitch: " + status.get(ModFreelook.INVERT_PITCH));
-            System.out.println("Minimap scale: " + status.get(ModMinimap.SCALE));
+            apolloPlayer.sendMessage(Component.text("Waypoints Enabled: ")
+                .append(Component.text(status.get(ModWaypoints.ENABLED))));
+
+            apolloPlayer.sendMessage(Component.text("Freelook Invert Yaw: ")
+                .append(Component.text(status.get(ModFreelook.INVERT_YAW))));
+
+            apolloPlayer.sendMessage(Component.text("Freelook Invert Pitch: ")
+                .append(Component.text(status.get(ModFreelook.INVERT_PITCH))));
+
+            apolloPlayer.sendMessage(Component.text("Minimap Scale: ")
+                .append(Component.text(status.get(ModMinimap.SCALE))));
         });
     }
 

example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/mods/ModStatusCommand.java

@@ -0,0 +1,98 @@
+/*
+ * This file is part of Apollo, licensed under the MIT License.
+ *
+ * Copyright (c) 2023 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.example.api.mods;
+
+import com.lunarclient.apollo.Apollo;
+import com.lunarclient.apollo.ApolloManager;
+import com.lunarclient.apollo.option.Option;
+import com.lunarclient.apollo.player.ApolloPlayer;
+import java.util.Map;
+import java.util.Optional;
+import org.bukkit.Bukkit;
+import org.bukkit.command.Command;
+import org.bukkit.command.CommandExecutor;
+import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Player;
+import org.jetbrains.annotations.NotNull;
+
+public class ModStatusCommand implements CommandExecutor {
+
+    @Override
+    public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] args) {
+        if (args.length == 0) {
+            sender.sendMessage("/modstatus <player>");
+            sender.sendMessage("/modstatus <player> <option>");
+            return true;
+        }
+
+        Player target = Bukkit.getPlayer(args[0]);
+
+        if (target == null) {
+            sender.sendMessage("Player '" + args[0] + "' not found!");
+            return true;
+        }
+
+        Optional<ApolloPlayer> apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(target.getUniqueId());
+        if (!apolloPlayerOpt.isPresent()) {
+            sender.sendMessage("Player '" + args[0] + "' not running Lunar Client!");
+            return true;
+        }
+
+        if (args.length == 1) {
+            this.sendCurrent(sender, apolloPlayerOpt.get());
+            return true;
+        }
+
+        if (args.length == 2) {
+            Option<?, ?, ?> option = ApolloManager.getModsManager().getPlayerOptions().getOptionsByKey().get(args[1]);
+
+            if (option == null) {
+                sender.sendMessage("Option not found!");
+                return true;
+            }
+
+            Object value = apolloPlayerOpt.get().getModStatus().get(option);
+            sender.sendMessage("Current value for \"" + option.getKey() + "\" is \"" + value + "\"");
+            return true;
+        }
+
+        sender.sendMessage("/modstatus <player>");
+        sender.sendMessage("/modstatus <player> <option>");
+        return true;
+    }
+
+    private void sendCurrent(CommandSender sender, ApolloPlayer target) {
+        Map<Option<?, ?, ?>, Object> playerOptions = ApolloManager.getModsManager().getPlayerOptions().getPlayerOptions().get(target.getUniqueId());
+
+        sender.sendMessage("-------------------------------------");
+        sender.sendMessage("Target: " + target.getName());
+        sender.sendMessage("");
+
+        for (Map.Entry<Option<?, ?, ?>, Object> entry : playerOptions.entrySet()) {
+            sender.sendMessage(" - " + entry.getKey().getKey() + "=" + entry.getValue());
+        }
+
+        sender.sendMessage("-------------------------------------");
+    }
+}

example/bukkit/api/src/main/resources/plugin.yml

@@ -9,6 +9,8 @@ folia-supported: true
 commands:
     apollodebug:
         description: "Apollo Debug!"
+    modstatus:
+        description: "Mod Status Command!"
     autotexthotkey:
         description: "Auto Text Hotkey!"
     beam: