Add simple Platform API

Author: Warriorrrr

api/src/main/java/net/earthmc/mycelium/api/Mycelium.java

@@ -3,6 +3,7 @@
 import net.earthmc.mycelium.api.event.Events;
 import net.earthmc.mycelium.api.messaging.MessagingRegistrar;
 import net.earthmc.mycelium.api.network.Network;
+import net.earthmc.mycelium.api.platform.Platform;
 import net.earthmc.mycelium.api.store.Store;
 
 /**
@@ -35,4 +36,9 @@ static Mycelium api() {
      * {@return the event manager}
      */
     Events events();
+
+    /**
+     * {@return the current running platform}
+     */
+    Platform platform();
 }

api/src/main/java/net/earthmc/mycelium/api/platform/Platform.java

@@ -0,0 +1,16 @@
+package net.earthmc.mycelium.api.platform;
+
+/**
+ * Represents the current platform Mycelium is running on.
+ */
+public interface Platform {
+    /**
+     * {@return the identifier of the platform}
+     */
+    String id();
+
+    /**
+     * {@return the current platform's type}
+     */
+    PlatformType type();
+}

api/src/main/java/net/earthmc/mycelium/api/platform/PlatformType.java

@@ -0,0 +1,10 @@
+package net.earthmc.mycelium.api.platform;
+
+/**
+ * All possible platform types where Mycelium can be ran.
+ */
+public enum PlatformType {
+    STANDALONE,
+    SERVER,
+    PROXY
+}

…et/earthmc/mycelium/client/Platform.java …mc/mycelium/client/AbstractPlatform.javaclient/src/main/java/net/earthmc/mycelium/client/Platform.java renamed to client/src/main/java/net/earthmc/mycelium/client/AbstractPlatform.java client/src/main/java/net/earthmc/mycelium/client/Platform.java renamed to client/src/main/java/net/earthmc/mycelium/client/AbstractPlatform.java

@@ -1,12 +1,16 @@
 package net.earthmc.mycelium.client;
 
+import net.earthmc.mycelium.api.platform.Platform;
+import net.earthmc.mycelium.api.platform.PlatformType;
 import net.earthmc.mycelium.client.util.Property;
+import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.Nullable;
 
 import java.nio.file.Path;
 import java.util.Locale;
 
-public abstract class Platform {
+@NullMarked
+public abstract class AbstractPlatform implements Platform {
     protected static final String UNKNOWN_ID = "unknown";
 
     private final String environment = Property.property("mycelium.environment", "prod");
@@ -21,6 +25,7 @@ public String environment() {
         return this.environment;
     }
 
+    @Override
     public String id() {
         return id;
     }
@@ -36,15 +41,9 @@ public String platformIdentifier() {
      *
      * @return The type of platform.
      */
-    public abstract Type type();
+    public abstract PlatformType type();
 
     public @Nullable Path dataDirectory() {
         return null;
     }
-
-    public enum Type {
-        STANDALONE,
-        SERVER,
-        PROXY
-    }
 }

client/src/main/java/net/earthmc/mycelium/client/MyceliumClient.java

@@ -42,13 +42,13 @@ public class MyceliumClient implements Mycelium, Closeable {
     private final MessagingRegistrarImpl messagingRegistrar;
     private final CallbackProvider callbackProvider;
     private final NetworkImpl network;
-    private final Platform platform;
+    private final AbstractPlatform platform;
     private final Store storage;
     private final EventsImpl events;
 
     private final String clientId = UUID.randomUUID().toString();
 
-    protected MyceliumClient(final UnifiedJedis client, final Platform platform) {
+    protected MyceliumClient(final UnifiedJedis client, final AbstractPlatform platform) {
         this.redisClient = client;
         this.platform = platform;
 
@@ -71,7 +71,7 @@ public static Builder standalone() {
         return new Builder(new StandalonePlatform());
     }
 
-    public static Builder forPlatform(final Platform platform) {
+    public static Builder forPlatform(final AbstractPlatform platform) {
         return new Builder(platform);
     }
 
@@ -95,7 +95,7 @@ public Events events() {
         return this.events;
     }
 
-    public Platform platform() {
+    public AbstractPlatform platform() {
         return this.platform;
     }
 
@@ -116,7 +116,7 @@ public Logger logger() {
     }
 
     public static class Builder {
-        private final Platform platform;
+        private final AbstractPlatform platform;
 
         private boolean registerInstance = false;
         private Function<MyceliumClient, @Nullable Server> nativeServer = client -> null;
@@ -127,7 +127,7 @@ public static class Builder {
         private @Nullable String redisUsername;
         private @Nullable String redisPassword;
 
-        private Builder(final Platform platform) {
+        private Builder(final AbstractPlatform platform) {
             this.platform = platform;
 
             // read defaults if settings file is supplied

client/src/main/java/net/earthmc/mycelium/client/StandalonePlatform.java

@@ -1,13 +1,10 @@
 package net.earthmc.mycelium.client;
 
-public class StandalonePlatform extends Platform {
-    @Override
-    public String platformIdentifier() {
-        return "standalone";
-    }
+import net.earthmc.mycelium.api.platform.PlatformType;
 
+public class StandalonePlatform extends AbstractPlatform {
     @Override
-    public Type type() {
-        return Type.STANDALONE;
+    public PlatformType type() {
+        return PlatformType.STANDALONE;
     }
 }

client/src/main/java/net/earthmc/mycelium/client/impl/messaging/MessagingRegistrarImpl.java

@@ -6,7 +6,8 @@
 import net.earthmc.mycelium.api.messaging.MessageSender;
 import net.earthmc.mycelium.api.messaging.MessagingRegistrar;
 import net.earthmc.mycelium.api.messaging.OutgoingMessageBuilder;
-import net.earthmc.mycelium.client.Platform;
+import net.earthmc.mycelium.api.platform.PlatformType;
+import net.earthmc.mycelium.client.AbstractPlatform;
 import net.earthmc.mycelium.api.serialization.JsonCodec;
 import net.earthmc.mycelium.client.MyceliumClient;
 import net.earthmc.mycelium.client.redis.RedisKey;
@@ -106,9 +107,9 @@ public <T> ChannelIdentifier.Bound<T> bind(ChannelIdentifier identifier, JsonCod
 
     @Override
     public <T> Listener registerPlatformChannel(ChannelIdentifier.Bound<T> identifier, Consumer<IncomingMessage<T>> receiver) {
-        final Platform platform = this.client.platform();
+        final AbstractPlatform platform = this.client.platform();
 
-        if (platform.type() == Platform.Type.STANDALONE) {
+        if (platform.type() == PlatformType.STANDALONE) {
             throw new IllegalStateException("Cannot register a platform-relative channel on a standalone platform.");
         }
 

platform/paper/src/main/java/net/earthmc/mycelium/platform/paper/PaperPlatform.java

@@ -2,7 +2,8 @@
 
 import net.earthmc.mycelium.api.messaging.ChannelIdentifier;
 import net.earthmc.mycelium.api.messaging.MessagingRegistrar;
-import net.earthmc.mycelium.client.Platform;
+import net.earthmc.mycelium.api.platform.PlatformType;
+import net.earthmc.mycelium.client.AbstractPlatform;
 import net.earthmc.mycelium.api.network.command.ConsoleCommand;
 import net.earthmc.mycelium.client.MyceliumClient;
 import net.earthmc.mycelium.client.impl.model.PlayerCommandRequest;
@@ -17,7 +18,7 @@
 
 import java.nio.file.Path;
 
-public class PaperPlatform extends Platform implements Listener {
+public class PaperPlatform extends AbstractPlatform implements Listener {
     private final PaperLoader loader;
     private final Logger logger;
     private final Server server;
@@ -88,8 +89,8 @@ public UnifiedJedis redis() {
     }
 
     @Override
-    public Type type() {
-        return Type.SERVER;
+    public PlatformType type() {
+        return PlatformType.SERVER;
     }
 
     @Override

platform/velocity/src/main/java/net/earthmc/mycelium/platform/velocity/VelocityPlatform.java

@@ -17,7 +17,8 @@
 import com.velocitypowered.api.proxy.server.RegisteredServer;
 import net.earthmc.mycelium.api.messaging.ChannelIdentifier;
 import net.earthmc.mycelium.api.messaging.MessagingRegistrar;
-import net.earthmc.mycelium.client.Platform;
+import net.earthmc.mycelium.api.platform.PlatformType;
+import net.earthmc.mycelium.client.AbstractPlatform;
 import net.earthmc.mycelium.api.network.Server;
 import net.earthmc.mycelium.api.network.command.ConsoleCommand;
 import net.earthmc.mycelium.client.MyceliumClient;
@@ -45,7 +46,7 @@
 import java.util.function.Supplier;
 
 @Plugin(name = "Mycelium", id = "mycelium", version = "0.0.1", authors = "Warriorrr")
-public class VelocityPlatform extends Platform {
+public class VelocityPlatform extends AbstractPlatform {
     @Inject
     public ProxyServer proxy;
 
@@ -302,8 +303,8 @@ private void cleanupStalePlayersOnProxy(final boolean shuttingDown) {
     }
 
     @Override
-    public Type type() {
-        return Type.PROXY;
+    public PlatformType type() {
+        return PlatformType.PROXY;
     }
 
     @Override