feat: introduce new versioning & Minecraft compatibility system

common/src/main/java/net/william278/husksync/HuskSync.java

@@ -39,6 +39,7 @@ import net.william278.husksync.redis.RedisManager;
 import net.william278.husksync.sync.DataSyncer;
 import net.william278.husksync.user.ConsoleUser;
 import net.william278.husksync.user.OnlineUser;
+import net.william278.husksync.util.CompatibilityChecker;
 import net.william278.husksync.util.LegacyConverter;
 import net.william278.husksync.util.Task;
 import net.william278.uniform.Uniform;
@@ -52,7 +53,8 @@ import java.util.logging.Level;
 /**
  * Abstract implementation of the HuskSync plugin.
  */
-public interface HuskSync extends Task.Supplier, EventDispatcher, ConfigProvider, SerializerRegistry {
+public interface HuskSync extends Task.Supplier, EventDispatcher, ConfigProvider, SerializerRegistry,
+        CompatibilityChecker {
 
     int SPIGOT_RESOURCE_ID = 97144;
 
@@ -338,7 +340,11 @@ public interface HuskSync extends Task.Supplier, EventDispatcher, ConfigProvider
                 
                 Caused by: %s""";
 
-        FailedToLoadException(@NotNull String message, @NotNull Throwable cause) {
+        public FailedToLoadException(@NotNull String message) {
+            super(String.format(FORMAT, message));
+        }
+
+        public FailedToLoadException(@NotNull String message, @NotNull Throwable cause) {
             super(String.format(FORMAT, message), cause);
         }
 

common/src/main/java/net/william278/husksync/util/CompatibilityChecker.java

@@ -0,0 +1,76 @@
+/*
+ * This file is part of HuskSync, licensed under the Apache License 2.0.
+ *
+ *  Copyright (c) William278 <will27528@gmail.com>
+ *  Copyright (c) contributors
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package net.william278.husksync.util;
+
+import de.exlll.configlib.Configuration;
+import de.exlll.configlib.YamlConfigurationProperties;
+import de.exlll.configlib.YamlConfigurationStore;
+import net.william278.desertwell.util.Version;
+import net.william278.husksync.HuskSync;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.InputStream;
+import java.util.Objects;
+import java.util.logging.Level;
+
+import static net.william278.husksync.config.ConfigProvider.YAML_CONFIGURATION_PROPERTIES;
+
+public interface CompatibilityChecker {
+
+    String COMPATIBILITY_FILE = "compatibility.yml";
+
+    default void checkCompatibility() throws HuskSync.FailedToLoadException {
+        final YamlConfigurationProperties p = YAML_CONFIGURATION_PROPERTIES.build();
+        final Version compatible;
+
+        // Load compatibility file
+        try (InputStream input = getResource(COMPATIBILITY_FILE)) {
+            final CompatibilityConfig compat = new YamlConfigurationStore<>(CompatibilityConfig.class, p).read(input);
+            compatible = Objects.requireNonNull(compat.getCompatibleWith());
+        } catch (Throwable e) {
+            getPlugin().log(Level.WARNING, "Failed to load compatibility config, skipping check.", e);
+            return;
+        }
+
+        // Check compatibility
+        if (!compatible.equals(getPlugin().getMinecraftVersion())) {
+            throw new HuskSync.FailedToLoadException("""
+                    Incompatible Minecraft version. This version of HuskSync is designed for Minecraft %s.
+                    Please download the correct version of HuskSync for your server's Minecraft version (%s)."""
+                    .formatted(compatible.toString(), getPlugin().getMinecraftVersion().toString()));
+        }
+    }
+
+    InputStream getResource(@NotNull String name);
+
+    @NotNull
+    HuskSync getPlugin();
+
+    @Configuration
+    record CompatibilityConfig(@NotNull String compatibleMinecraftVersion) {
+
+        @NotNull
+        public Version getCompatibleWith() {
+            return Version.fromString(compatibleMinecraftVersion);
+        }
+
+    }
+
+}