implement minestom properties & finish docs

Author: ItsNature

docs/developers/minestom.mdx

@@ -1,4 +1,5 @@
 import { Tab, Tabs } from 'nextra-theme-docs';
+import { Callout } from 'nextra-theme-docs'
 
 # Apollo for Minestom
 
@@ -51,14 +52,14 @@ Next, add the `apollo-minestom` dependency to your project.
   <Tab>
     ```kotlin filename="build.gradle.kts"
     dependencies {
-        implementation("com.lunarclient:apollo-minestom:1.1.9")
+        implementation("com.lunarclient:apollo-minestom:1.2.0")
     }
     ```
   </Tab>
   <Tab>
     ```groovy filename="build.gradle"
     dependencies {
-        implementation 'com.lunarclient:apollo-minestom:1.1.9'
+        implementation 'com.lunarclient:apollo-minestom:1.2.0'
     }
     ```
   </Tab>
@@ -68,7 +69,7 @@ Next, add the `apollo-minestom` dependency to your project.
         <dependency>
             <groupId>com.lunarclient</groupId>
             <artifactId>apollo-minestom</artifactId>
-            <version>1.1.9</version>
+            <version>1.2.0</version>
             <scope>compile</scope>
         </dependency>
     </dependencies>
@@ -78,7 +79,7 @@ Next, add the `apollo-minestom` dependency to your project.
 
 ## Initialization
 
-To initialize Apollo, simply call `ApolloMinestomPlatform.init()` in your server's startup code, before you start the server. This will set up all the necessary listeners and modules.
+To initialize Apollo, simply call `ApolloMinestomPlatform.init(ApolloMinestomProperties.DEFAULT_PROPERTIES)` in your server's startup code, before you start the server. This will set up all the necessary listeners and modules.
 
 Here is an example of a simple Minestom server with Apollo integrated:
 
@@ -87,6 +88,7 @@ package com.lunarclient.apollo.example;
 
 import com.lunarclient.apollo.Apollo;
 import com.lunarclient.apollo.ApolloMinestomPlatform;
+import com.lunarclient.apollo.ApolloMinestomProperties;
 import com.lunarclient.apollo.common.location.ApolloBlockLocation;
 import com.lunarclient.apollo.event.EventBus;
 import com.lunarclient.apollo.event.player.ApolloRegisterPlayerEvent;
@@ -116,7 +118,7 @@ public final class ApolloMinestomExample {
         eventHandler.addListener(AsyncPlayerConfigurationEvent.class, event -> event.setSpawningInstance(instance));
 
         // Initialize Apollo
-        ApolloMinestomPlatform.init();
+        ApolloMinestomPlatform.init(ApolloMinestomProperties.DEFAULT_PROPERTIES);
 
         // Display a Apollo Waypoint example
         EventBus.getBus().register(ApolloRegisterPlayerEvent.class, event -> {
@@ -146,10 +148,49 @@ public final class ApolloMinestomExample {
 }
 ```
 
+## Properties
+
+Apollo exposes several properties to configure its behavior at startup. By default, you can simply call `ApolloMinestomPlatform.init(ApolloMinestomProperties.DEFAULT_PROPERTIES)`. However, there are situations where you may not want to rely on the defaults:
+
+`sendRegisterPacket` (default: `true`)
+
+Unlike Bukkit/Spigot, Minestom does **not** maintain a global registry of plugin channels. This means there is no automatic tracking or registration of channels, so Apollo must explicitly send the `minecraft:register` packet to let the client know about its channel (`lunar:apollo`).
+
+By default, `sendRegisterPacket` is set to `true`, and Apollo will send this packet automatically.
+
+<Callout type="warning" emoji="⚠️">
+  If you disable this, you must ensure your server or another plugin sends the `lunar:apollo` channel registration manually.
+</Callout>
+
+To disable this behavior, set the property to false:
+
+```java
+sendRegisterPacket(false)
+```
+
+`configPath` (default: `./Apollo/`)
+
+By default, Apollo stores its configuration in an Apollo folder at the root of your server directory.
+If you want Apollo’s config files to live elsewhere (e.g., inside a configs/ folder you already manage), override this value.
+
+```java
+configPath(/* Your config path */)
+```
+
+The final initialization call with both properties overridden may look like this:
+
+```java
+ApolloMinestomPlatform.init(ApolloMinestomProperties.builder()
+    .sendRegisterPacket(false)
+    .configPath(/* Your config path here */)
+    .build());
+```
+
+
 ## Permissions
 
 Since Minestom does not have a traditional permissions system, Apollo uses Minestom's built-in permission levels. Here are the default permission levels required for various features:
 
-- **`/apollo <reload|update>`**: `level 2`
-- **`/lunarclient <player>`**: `level 2`
-- **Receive Apollo update notifications**: `level 4`
+- `/apollo <reload|update>`: `2`
+- `/lunarclient <player>`: `2`
+- Receive Apollo update notifications: `4`

example/minestom/api/build.gradle.kts

@@ -13,3 +13,11 @@ dependencies {
 
     implementation(libs.minestom)
 }
+
+tasks {
+    jar {
+        manifest {
+            attributes["Main-Class"] = "com.lunarclient.apollo.example.ApolloMinestomExample"
+        }
+    }
+}

example/minestom/api/src/main/java/com/lunarclient/apollo/example/ApolloMinestomExample.java

@@ -25,6 +25,7 @@
 
 import com.lunarclient.apollo.Apollo;
 import com.lunarclient.apollo.ApolloMinestomPlatform;
+import com.lunarclient.apollo.ApolloMinestomProperties;
 import com.lunarclient.apollo.common.location.ApolloBlockLocation;
 import com.lunarclient.apollo.event.EventBus;
 import com.lunarclient.apollo.event.player.ApolloRegisterPlayerEvent;
@@ -59,7 +60,7 @@ public static void main(String[] args) {
         });
 
         // Initialize Apollo
-        ApolloMinestomPlatform.init();
+        ApolloMinestomPlatform.init(ApolloMinestomProperties.DEFAULT_PROPERTIES);
 
         // Display a Apollo Waypoint example
         EventBus.getBus().register(ApolloRegisterPlayerEvent.class, event -> {

minestom/src/main/java/com/lunarclient/apollo/ApolloMinestomPlatform.java

@@ -87,9 +87,9 @@
 import com.lunarclient.apollo.option.OptionsImpl;
 import com.lunarclient.apollo.stats.ApolloStats;
 import com.lunarclient.apollo.wrapper.MinestomApolloStats;
-import java.io.File;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import lombok.Getter;
 import net.minestom.server.MinecraftServer;
 import net.minestom.server.command.CommandManager;
 import net.minestom.server.event.Event;
@@ -102,36 +102,38 @@
  */
 public final class ApolloMinestomPlatform implements ApolloPlatform {
 
-    public static boolean SEND_REGISTER_PACKET = true;
-
-    private static ApolloMinestomPlatform instance;
+    @Getter private static ApolloMinestomPlatform instance;
 
     private final Options options;
     private final Logger logger;
     private final ApolloStats stats;
+    @Getter private final ApolloMinestomProperties properties;
 
     /**
      * Constructs the {@link ApolloMinestomPlatform}.
      *
+     * @param properties the Apollo minestom properties
      * @since 1.2.0
      */
-    public ApolloMinestomPlatform() {
+    public ApolloMinestomPlatform(ApolloMinestomProperties properties) {
         this.options = new OptionsImpl(null);
         this.logger = Logger.getLogger(ApolloMinestomPlatform.class.getName());
         this.stats = new MinestomApolloStats();
+        this.properties = properties;
     }
 
     /**
      * Initialize Apollo for Minestom.
      *
+     * @param properties the Apollo minestom properties
      * @since 1.2.0
      */
-    public static void init() {
+    public static void init(ApolloMinestomProperties properties) {
         if (instance != null) {
             throw new IllegalStateException("ApolloMinestomPlatform is already initialized!");
         }
 
-        instance = new ApolloMinestomPlatform();
+        instance = new ApolloMinestomPlatform(properties);
 
         ApolloManager.bootstrap(instance);
         ApolloManager.setMetadataManager(new MinestomMetadataManager());
@@ -177,8 +179,7 @@ public static void init() {
             .addModule(WaypointModule.class, new WaypointModuleImpl());
 
         try {
-            // TODO: config path
-            ApolloManager.setConfigPath(new File("").toPath());
+            ApolloManager.setConfigPath(properties.getConfigPath());
             ApolloManager.loadConfiguration();
             ((ApolloModuleManagerImpl) Apollo.getModuleManager()).enableModules();
             ApolloManager.saveConfiguration();

minestom/src/main/java/com/lunarclient/apollo/ApolloMinestomProperties.java

@@ -0,0 +1,102 @@
+/*
+ * 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;
+
+import java.io.File;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.experimental.Accessors;
+
+/**
+ * Configuration properties for initializing the Apollo Minestom platform.
+ *
+ * @since 1.2.0
+ */
+@Getter
+@Builder
+@Accessors
+public class ApolloMinestomProperties {
+
+    /**
+     * An instance of {@link ApolloMinestomProperties} with default properties.
+     */
+    public static final ApolloMinestomProperties DEFAULT_PROPERTIES = ApolloMinestomProperties.builder().build();
+
+    /**
+     * Determines whether Apollo should skip sending the {@code minecraft:register}
+     * packet for its plugin channels.
+     *
+     * <p>By default, this is {@code false}, and Apollo will automatically register its
+     * {@code lunar:apollo} plugin channel to communicate with the client.</p>
+     *
+     * <p>Set this to {@code true} if another plugin or system is responsible
+     * for sending the register packet, to avoid conflicts where
+     * multiple plugins attempt registration at the same time.</p>
+     *
+     * <p>If you disable channel registration, you must ensure that your server
+     * or another plugin sends the {@code lunar:apollo} registration packet
+     * if you want Apollo to function correctly.</p>
+     *
+     * @return true if channel registration is disabled, false otherwise
+     * @since 1.2.0
+     */
+    @Builder.Default
+    private final boolean sendRegisterPacket = true;
+
+    /**
+     * The path where Apollo will store and load its configuration files.
+     *
+     * <p>By default, this path points to the {@code ./Apollo/} directory,
+     * relative to the server's working directory. If this directory does not
+     * exist, it will be created automatically.</p>
+     *
+     * <p>Override this path if you want to keep Apollo's configuration files in a different location</p>
+     *
+     * @return the path to Apollo's configuration directory
+     * @since 1.2.0
+     */
+    @Builder.Default
+    private final Path configPath = ApolloMinestomProperties.getDefaultConfigPath();
+
+    /**
+     * Computes the default configuration path ({@code ./Apollo/}).
+     *
+     * @return the resolved config path
+     * @since 1.2.0
+     */
+    private static Path getDefaultConfigPath() {
+        Path serverDir = Paths.get("").toAbsolutePath();
+        Path apolloDir = serverDir.resolve("Apollo");
+        File apolloFile = apolloDir.toFile();
+
+        if (!apolloFile.exists()) {
+            apolloFile.mkdirs();
+        }
+
+        return apolloDir;
+    }
+
+}

minestom/src/main/java/com/lunarclient/apollo/listener/ApolloPlayerListener.java

@@ -100,7 +100,7 @@ private void onPlayerDisconnect(PlayerDisconnectEvent event) {
     private void onPlayerSpawn(PlayerSpawnEvent event) {
         Player player = event.getPlayer();
 
-        if (ApolloMinestomPlatform.SEND_REGISTER_PACKET) {
+        if (ApolloMinestomPlatform.getInstance().getProperties().isSendRegisterPacket()) {
             player.sendPluginMessage("minecraft:register", ApolloManager.PLUGIN_MESSAGE_CHANNEL);
         }