Markdown docs

Author: ItsNature

api/src/main/java/com/lunarclient/apollo/player/ApolloPlayer.java

@@ -147,7 +147,7 @@ default boolean hasPermission(Options options, Option<String, ?, ?> option) {
 
     /**
      * Returns the {@link ModStatus} interface used for retrieving
-     * the current value of a mod options.
+     * the current value of mod options.
      *
      * @return the mod status interface
      * @since 1.2.1

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

@@ -30,7 +30,7 @@
 import lombok.RequiredArgsConstructor;
 
 /**
- * Default implementation of {@link ModStatus} used to retrieve the current status of a mod option.
+ * Default implementation of {@link ModStatus} used for retrieving the current status of a mod option.
  *
  * @since 1.2.1
  */

docs/developers/_meta.json

@@ -5,6 +5,7 @@
     "options": "Options",
     "modules": "Modules",
     "mods": "Mods",
+    "mod-status": "Mod Status",
     "utilities": "Utilities",
     "platform-utilities": "Platform Utilities",
     "adventure": "Adventure",

docs/developers/events.mdx

@@ -161,7 +161,7 @@ _Called when the Apollo player sends an Apollo packet to Lunar Client._
 
 ### ApolloUpdateOptionEvent
 
-_Called when an option is updated._
+_Called when an Apollo option is updated._
 
 | Field                    | Description                                                                      |
 | ------------------------ | -------------------------------------------------------------------------------- |
@@ -174,6 +174,21 @@ _Called when an option is updated._
 
 </details>
 
+<details>
+<summary>ApolloUpdateModOptionEvent</summary>
+
+### ApolloUpdateModOptionEvent
+
+_Called when a Lunar Client Mod option is updated._
+
+| Field                    | Description                                   |
+| ------------------------ | --------------------------------------------- |
+| `ApolloPlayer player`    | The Apollo player the option was updated for. |
+| `Option<?, ?, ?> option` | The option that was updated.                  |
+| `Object value`           | The new value of the option.                  |
+
+</details>
+
 <details>
 <summary>ApolloPlayerChatCloseEvent</summary>
 

docs/developers/mod-status.mdx

@@ -0,0 +1,68 @@
+import { Callout } from 'nextra-theme-docs'
+
+# Mod Status
+
+The Mod Status API allows you to get the current values for a player's Lunar Client mod options.
+
+<Callout type="info">
+  This API heavily integrates with our [Options API](/developers/options).
+  You can find all available mods and their options under the mods section.
+</Callout>
+
+## Integration
+
+### Retrieve the current value for options
+
+```java
+private void printOptionStatusExample(Player player) {
+    Apollo.getPlayerManager().getPlayer(player.getUniqueId()).ifPresent(apolloPlayer -> {
+        ModStatus status = apolloPlayer.getModStatus();
+
+        if (status == null) {
+            // Handshake not received yet
+            return;
+        }
+
+        boolean waypointsEnabled = status.get(ModWaypoints.ENABLED);
+        float minimapScale = status.get(ModMinimap.SCALE);
+        int fovDefaultFov = status.get(ModFov.DEFAULT_FOV);
+
+        apolloPlayer.sendMessage(Component.text("Waypoints Enabled: ")
+            .append(Component.text(waypointsEnabled)));
+
+        apolloPlayer.sendMessage(Component.text("Minimap Scale: ")
+            .append(Component.text(minimapScale)));
+
+        apolloPlayer.sendMessage(Component.text("Fov Default Fov: ")
+            .append(Component.text(fovDefaultFov)));
+    });
+}
+```
+
+### Listening for Updates
+
+Apollo provides an event, `[ApolloUpdateModOptionEvent](/developers/events)`, that is fired whenever a Lunar Client Mod Option is updated.
+
+```java
+import com.lunarclient.apollo.event.ApolloListener;
+import com.lunarclient.apollo.event.EventBus;
+import com.lunarclient.apollo.event.Listen;
+import com.lunarclient.apollo.event.mods.ApolloUpdateModOptionEvent;
+import java.util.Objects;
+import net.kyori.adventure.text.Component;
+
+public class ApolloModStatusExample implements ApolloListener {
+
+    public ApolloModStatusExample() {
+        EventBus.getBus().register(this);
+    }
+
+    @Listen
+    private void onApolloUpdateModOption(ApolloUpdateModOptionEvent event) {
+        event.getPlayer().sendMessage(Component.text(event.getOption().getKey())
+            .append(Component.text(" was updated to "))
+            .append(Component.text(Objects.toString(event.getValue()))));
+    }
+
+}
+```

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

@@ -30,12 +30,13 @@
 import com.lunarclient.apollo.event.mods.ApolloUpdateModOptionEvent;
 import com.lunarclient.apollo.example.ApolloExamplePlugin;
 import com.lunarclient.apollo.mods.ModStatus;
-import com.lunarclient.apollo.mods.impl.ModFreelook;
+import com.lunarclient.apollo.mods.impl.ModFov;
 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.Material;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
@@ -55,24 +56,38 @@ private void onApolloUpdateModOption(ApolloUpdateModOptionEvent event) {
             .append(Component.text(Objects.toString(event.getValue()))));
     }
 
-    @EventHandler(ignoreCancelled = true)
+    @EventHandler
     private void onBlockPlace(BlockPlaceEvent event) {
         Player player = event.getPlayer();
 
+        if (event.getBlock().getType() != Material.DIAMOND_BLOCK) {
+            return;
+        }
+
+        this.printOptionStatusExample(player);
+    }
+
+    private void printOptionStatusExample(Player player) {
         Apollo.getPlayerManager().getPlayer(player.getUniqueId()).ifPresent(apolloPlayer -> {
             ModStatus status = apolloPlayer.getModStatus();
 
-            apolloPlayer.sendMessage(Component.text("Waypoints Enabled: ")
-                .append(Component.text(status.get(ModWaypoints.ENABLED))));
+            if (status == null) {
+                // Handshake not received yet
+                return;
+            }
 
-            apolloPlayer.sendMessage(Component.text("Freelook Invert Yaw: ")
-                .append(Component.text(status.get(ModFreelook.INVERT_YAW))));
+            boolean waypointsEnabled = status.get(ModWaypoints.ENABLED);
+            float minimapScale = status.get(ModMinimap.SCALE);
+            int fovDefaultFov = status.get(ModFov.DEFAULT_FOV);
 
-            apolloPlayer.sendMessage(Component.text("Freelook Invert Pitch: ")
-                .append(Component.text(status.get(ModFreelook.INVERT_PITCH))));
+            apolloPlayer.sendMessage(Component.text("Waypoints Enabled: ")
+                .append(Component.text(waypointsEnabled)));
 
             apolloPlayer.sendMessage(Component.text("Minimap Scale: ")
-                .append(Component.text(status.get(ModMinimap.SCALE))));
+                .append(Component.text(minimapScale)));
+
+            apolloPlayer.sendMessage(Component.text("Fov Default Fov: ")
+                .append(Component.text(fovDefaultFov)));
         });
     }