Add support for Fabric targeting Minecraft 1.20.1

README.md

@@ -44,15 +44,15 @@
 **Ready?** [It's syncing time!](https://william278.net/docs/husksync/setup)
 
 ## Setup
-Requires a MySQL/Mongo/PostgreSQL database, a Redis (v5.0+) server and any number of Spigot-based 1.17.1+ Minecraft servers, running Java 17+.
+Requires a MySQL/Mongo/PostgreSQL database, a Redis (v5.0+) server and a network of Spigot (1.17.1+) or Fabric (1.20.1) Minecraft servers, running Java 17+.
 
-1. Place the plugin jar file in the /plugins/ directory of each Spigot server. You do not need to install HuskSync as a proxy plugin.
+1. Place the plugin jar file in the `/plugins` or `/mods` directory of each Spigot/Fabric server. You do not need to install HuskSync as a proxy plugin.
 2. Start, then stop every server to let HuskSync generate the config file.
-3. Navigate to the HuskSync config file on each server (~/plugins/HuskSync/config.yml) and fill in both your database and Redis server credentials.
+3. Navigate to the HuskSync config file on each server and fill in both your database and Redis server credentials.
 4. Start every server again and synchronization will begin.
 
 ## Development
-To build HuskSync, simply run the following in the root of the repository:
+To build HuskSync, simply run the following in the root of the repository (building requires Java 17). Builds will be output in `/target`:
 
 ```bash
 ./gradlew clean build
@@ -66,7 +66,7 @@ HuskSync is licensed under the Apache 2.0 license.
 Contributions to the project are welcome—feel free to open a pull request with new features, improvements and/or fixes!
 
 ### Support
-Due to its complexity, official binaries and customer support for HuskSync is provided through a paid model. This means that support is only available to users who have purchased a license to the plugin from Spigot, Polymart, Craftaro, or BuiltByBit and have provided proof of purchase. Please join our Discord server if you have done so and need help!
+Due to its complexity, official binaries and customer support for HuskSync is provided through a paid model. This means that support is only available to users who have purchased a license to the plugin from Spigot, Polymart, or BuiltByBit and have provided proof of purchase. Please join our Discord server if you have done so and need help!
 
 ### Translations
 Translations of the plugin locales are welcome to help make the plugin more accessible. Please submit a pull request with your translations as a `.yml` file.

build.gradle

@@ -69,6 +69,7 @@ allprojects {
     repositories {
         mavenLocal()
         mavenCentral()
+        maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
         maven { url 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/' }
         maven { url "https://repo.dmulloy2.net/repository/public/" }
         maven { url 'https://repo.codemc.io/repository/maven-public/' }
@@ -117,8 +118,13 @@ subprojects {
         archiveClassifier.set('')
     }
 
+    // Append the Minecraft to the version for Fabric projects
+    if (project.name == 'fabric') {
+        version += "+mc.${fabric_minecraft_version}"
+    }
+
     // API publishing
-    if (['common', 'bukkit'].contains(project.name)) {
+    if (['common', 'bukkit', 'fabric'].contains(project.name)) {
         java {
             withSourcesJar()
             withJavadocJar()
@@ -157,6 +163,19 @@ subprojects {
                     }
                 }
             }
+
+            if (['fabric'].contains(project.name)) {
+                publications {
+                    mavenJavaFabric(MavenPublication) {
+                        groupId = 'net.william278.husksync'
+                        artifactId = 'husksync-fabric'
+                        version = "$rootProject.version"
+                        artifact shadowJar
+                        artifact sourcesJar
+                        artifact javadocJar
+                    }
+                }
+            }
         }
     }
 

bukkit/src/main/java/net/william278/husksync/BukkitHuskSync.java

@@ -150,15 +150,15 @@ public void onEnable() {
             registerSerializer(Identifier.INVENTORY, new BukkitSerializer.Inventory(this));
             registerSerializer(Identifier.ENDER_CHEST, new BukkitSerializer.EnderChest(this));
             registerSerializer(Identifier.ADVANCEMENTS, new BukkitSerializer.Advancements(this));
-            registerSerializer(Identifier.STATISTICS, new BukkitSerializer.Json<>(this, BukkitData.Statistics.class));
+            registerSerializer(Identifier.STATISTICS, new Serializer.Json<>(this, BukkitData.Statistics.class));
             registerSerializer(Identifier.POTION_EFFECTS, new BukkitSerializer.PotionEffects(this));
-            registerSerializer(Identifier.GAME_MODE, new BukkitSerializer.Json<>(this, BukkitData.GameMode.class));
-            registerSerializer(Identifier.FLIGHT_STATUS, new BukkitSerializer.Json<>(this, BukkitData.FlightStatus.class));
-            registerSerializer(Identifier.ATTRIBUTES, new BukkitSerializer.Json<>(this, BukkitData.Attributes.class));
-            registerSerializer(Identifier.HEALTH, new BukkitSerializer.Json<>(this, BukkitData.Health.class));
-            registerSerializer(Identifier.HUNGER, new BukkitSerializer.Json<>(this, BukkitData.Hunger.class));
-            registerSerializer(Identifier.EXPERIENCE, new BukkitSerializer.Json<>(this, BukkitData.Experience.class));
-            registerSerializer(Identifier.LOCATION, new BukkitSerializer.Json<>(this, BukkitData.Location.class));
+            registerSerializer(Identifier.GAME_MODE, new Serializer.Json<>(this, BukkitData.GameMode.class));
+            registerSerializer(Identifier.FLIGHT_STATUS, new Serializer.Json<>(this, BukkitData.FlightStatus.class));
+            registerSerializer(Identifier.ATTRIBUTES, new Serializer.Json<>(this, BukkitData.Attributes.class));
+            registerSerializer(Identifier.HEALTH, new Serializer.Json<>(this, BukkitData.Health.class));
+            registerSerializer(Identifier.HUNGER, new Serializer.Json<>(this, BukkitData.Hunger.class));
+            registerSerializer(Identifier.EXPERIENCE, new Serializer.Json<>(this, BukkitData.Experience.class));
+            registerSerializer(Identifier.LOCATION, new Serializer.Json<>(this, BukkitData.Location.class));
             validateDependencies();
         });
 

bukkit/src/main/java/net/william278/husksync/data/BukkitData.java

@@ -69,7 +69,6 @@ public static abstract class Items extends BukkitData implements Data.Items {
         private final @Nullable ItemStack @NotNull [] contents;
 
         private Items(@Nullable ItemStack @NotNull [] contents) {
-
             this.contents = Arrays.stream(contents.clone())
                     .map(i -> i == null || i.getType() == Material.AIR ? null : i)
                     .toArray(ItemStack[]::new);
@@ -127,8 +126,6 @@ public boolean equals(Object obj) {
         @Getter
         public static class Inventory extends BukkitData.Items implements Data.Items.Inventory {
 
-            public static final int INVENTORY_SLOT_COUNT = 41;
-
             @Range(from = 0, to = 8)
             private int heldItemSlot;
 
@@ -175,15 +172,18 @@ private void clearInventoryCraftingSlots(@NotNull Player player) {
 
         public static class EnderChest extends BukkitData.Items implements Data.Items.EnderChest {
 
-            public static final int ENDER_CHEST_SLOT_COUNT = 27;
-
-            private EnderChest(@NotNull ItemStack[] contents) {
+            private EnderChest(@Nullable ItemStack @NotNull [] contents) {
                 super(contents);
             }
 
             @NotNull
-            public static BukkitData.Items.EnderChest adapt(@NotNull ItemStack[] items) {
-                return new BukkitData.Items.EnderChest(items);
+            public static BukkitData.Items.EnderChest adapt(@Nullable ItemStack @NotNull [] contents) {
+                return new BukkitData.Items.EnderChest(contents);
+            }
+
+            @NotNull
+            public static BukkitData.Items.EnderChest adapt(@NotNull Collection<ItemStack> items) {
+                return adapt(items.toArray(ItemStack[]::new));
             }
 
             @NotNull
@@ -200,7 +200,7 @@ public void apply(@NotNull BukkitUser user, @NotNull BukkitHuskSync plugin) thro
 
         public static class ItemArray extends BukkitData.Items implements Data.Items {
 
-            private ItemArray(@NotNull ItemStack[] contents) {
+            private ItemArray(@Nullable ItemStack @NotNull [] contents) {
                 super(contents);
             }
 
@@ -210,7 +210,7 @@ public static ItemArray adapt(@NotNull Collection<ItemStack> drops) {
             }
 
             @NotNull
-            public static ItemArray adapt(@NotNull ItemStack[] drops) {
+            public static ItemArray adapt(@Nullable ItemStack @NotNull [] drops) {
                 return new ItemArray(drops);
             }
 
@@ -341,9 +341,12 @@ public void apply(@NotNull BukkitUser user, @NotNull BukkitHuskSync plugin) thro
             }));
         }
 
-        private void setAdvancement(@NotNull HuskSync plugin, @NotNull org.bukkit.advancement.Advancement advancement,
-                                    @NotNull Player player, @NotNull BukkitUser user,
-                                    @NotNull Collection<String> toAward, @NotNull Collection<String> toRevoke) {
+        private void setAdvancement(@NotNull HuskSync plugin,
+                                    @NotNull org.bukkit.advancement.Advancement advancement,
+                                    @NotNull Player player,
+                                    @NotNull BukkitUser user,
+                                    @NotNull Collection<String> toAward,
+                                    @NotNull Collection<String> toRevoke) {
             plugin.runSync(() -> {
                 // Track player exp level & progress
                 final int expLevel = player.getLevel();
@@ -355,7 +358,8 @@ private void setAdvancement(@NotNull HuskSync plugin, @NotNull org.bukkit.advanc
                 toRevoke.forEach(progress::revokeCriteria);
 
                 // Set player experience and level (prevent advancement awards applying twice), reset game rule
-                if (!toAward.isEmpty() && player.getLevel() != expLevel || player.getExp() != expProgress) {
+                if (!toAward.isEmpty()
+                        && (player.getLevel() != expLevel || player.getExp() != expProgress)) {
                     player.setLevel(expLevel);
                     player.setExp(expProgress);
                 }

bukkit/src/main/java/net/william278/husksync/data/BukkitSerializer.java

@@ -29,6 +29,7 @@
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import net.william278.desertwell.util.Version;
+import net.william278.husksync.BukkitHuskSync;
 import net.william278.husksync.HuskSync;
 import net.william278.husksync.adapter.Adaptable;
 import net.william278.husksync.api.HuskSyncAPI;
@@ -41,6 +42,8 @@
 import java.util.List;
 
 import static net.william278.husksync.data.BukkitData.Items.Inventory.INVENTORY_SLOT_COUNT;
+import static net.william278.husksync.data.Data.Items.Inventory.HELD_ITEM_SLOT_TAG;
+import static net.william278.husksync.data.Data.Items.Inventory.ITEMS_TAG;
 
 @AllArgsConstructor(access = AccessLevel.PRIVATE)
 public class BukkitSerializer {
@@ -60,8 +63,6 @@ public HuskSync getPlugin() {
 
     public static class Inventory extends BukkitSerializer implements Serializer<BukkitData.Items.Inventory>,
             ItemDeserializer {
-        private static final String ITEMS_TAG = "items";
-        private static final String HELD_ITEM_SLOT_TAG = "held_item_slot";
 
         public Inventory(@NotNull HuskSync plugin) {
             super(plugin);
@@ -74,7 +75,7 @@ public BukkitData.Items.Inventory deserialize(@NotNull String serialized, @NotNu
             final ReadWriteNBT items = root.hasTag(ITEMS_TAG) ? root.getCompound(ITEMS_TAG) : null;
             return BukkitData.Items.Inventory.from(
                     items != null ? getItems(items, dataMcVersion) : new ItemStack[INVENTORY_SLOT_COUNT],
-                    root.getInteger(HELD_ITEM_SLOT_TAG)
+                    root.hasTag(HELD_ITEM_SLOT_TAG) ? root.getInteger(HELD_ITEM_SLOT_TAG) : 0
             );
         }
 
@@ -126,15 +127,15 @@ private interface ItemDeserializer {
         @Nullable
         default ItemStack[] getItems(@NotNull ReadWriteNBT tag, @NotNull Version mcVersion) {
             if (mcVersion.compareTo(getPlugin().getMinecraftVersion()) < 0) {
-                return upgradeItemStack((NBTCompound) tag, mcVersion);
+                return upgradeItemStacks((NBTCompound) tag, mcVersion);
             }
             return NBT.itemStackArrayFromNBT(tag);
         }
 
         @NotNull
-        private ItemStack @NotNull [] upgradeItemStack(@NotNull NBTCompound compound, @NotNull Version mcVersion) {
-            final ReadWriteNBTCompoundList items = compound.getCompoundList("items");
-            final ItemStack[] itemStacks = new ItemStack[compound.getInteger("size")];
+        private ItemStack @NotNull [] upgradeItemStacks(@NotNull NBTCompound itemsNbt, @NotNull Version mcVersion) {
+            final ReadWriteNBTCompoundList items = itemsNbt.getCompoundList("items");
+            final ItemStack[] itemStacks = new ItemStack[itemsNbt.getInteger("size")];
             for (int i = 0; i < items.size(); i++) {
                 if (items.get(i) == null) {
                     itemStacks[i] = new ItemStack(Material.AIR);
@@ -163,6 +164,7 @@ private int getDataVersion(@NotNull Version mcVersion) {
                 case "1.19", "1.19.1", "1.19.2" -> DataFixerUtil.VERSION1_19_2;
                 case "1.20", "1.20.1", "1.20.2" -> DataFixerUtil.VERSION1_20_2;
                 case "1.20.3", "1.20.4" -> DataFixerUtil.VERSION1_20_4;
+                case "1.20.5", "1.20.6" -> DataFixerUtil.VERSION1_20_5;
                 default -> DataFixerUtil.getCurrentVersion();
             };
         }
@@ -237,24 +239,19 @@ public String serialize(@NotNull BukkitData.PersistentData element) throws Seria
 
     }
 
-    public static class Json<T extends Data & Adaptable> extends BukkitSerializer implements Serializer<T> {
+    /**
+     * @deprecated Use {@link Serializer.Json} in the common module instead
+     */
+    @Deprecated(since = "2.6")
+    public class Json<T extends Data & Adaptable> extends Serializer.Json<T> {
 
-        private final Class<T> type;
-
-        public Json(@NotNull HuskSync plugin, Class<T> type) {
-            super(plugin);
-            this.type = type;
-        }
-
-        @Override
-        public T deserialize(@NotNull String serialized) throws DeserializationException {
-            return plugin.getDataAdapter().fromJson(serialized, type);
+        public Json(@NotNull HuskSync plugin, @NotNull Class<T> type) {
+            super(plugin, type);
         }
 
         @NotNull
-        @Override
-        public String serialize(@NotNull T element) throws SerializationException {
-            return plugin.getDataAdapter().toJson(element);
+        public BukkitHuskSync getPlugin() {
+            return (BukkitHuskSync) plugin;
         }
 
     }

bukkit/src/main/java/net/william278/husksync/data/BukkitUserDataHolder.java

@@ -67,9 +67,9 @@ default Optional<Data.Items.Inventory> getInventory() {
                 .isSyncDeadPlayersChangingServer())) {
             return Optional.of(BukkitData.Items.Inventory.empty());
         }
-        final PlayerInventory inventory = getBukkitPlayer().getInventory();
+        final PlayerInventory inventory = getPlayer().getInventory();
         return Optional.of(BukkitData.Items.Inventory.from(
-                getMapPersister().persistLockedMaps(inventory.getContents(), getBukkitPlayer()),
+                getMapPersister().persistLockedMaps(inventory.getContents(), getPlayer()),
                 inventory.getHeldItemSlot()
         ));
     }
@@ -78,80 +78,89 @@ default Optional<Data.Items.Inventory> getInventory() {
     @Override
     default Optional<Data.Items.EnderChest> getEnderChest() {
         return Optional.of(BukkitData.Items.EnderChest.adapt(
-                getMapPersister().persistLockedMaps(getBukkitPlayer().getEnderChest().getContents(), getBukkitPlayer())
+                getMapPersister().persistLockedMaps(getPlayer().getEnderChest().getContents(), getPlayer())
         ));
     }
 
     @NotNull
     @Override
     default Optional<Data.PotionEffects> getPotionEffects() {
-        return Optional.of(BukkitData.PotionEffects.from(getBukkitPlayer().getActivePotionEffects()));
+        return Optional.of(BukkitData.PotionEffects.from(getPlayer().getActivePotionEffects()));
     }
 
     @NotNull
     @Override
     default Optional<Data.Advancements> getAdvancements() {
-        return Optional.of(BukkitData.Advancements.adapt(getBukkitPlayer()));
+        return Optional.of(BukkitData.Advancements.adapt(getPlayer()));
     }
 
     @NotNull
     @Override
     default Optional<Data.Location> getLocation() {
-        return Optional.of(BukkitData.Location.adapt(getBukkitPlayer().getLocation()));
+        return Optional.of(BukkitData.Location.adapt(getPlayer().getLocation()));
     }
 
     @NotNull
     @Override
     default Optional<Data.Statistics> getStatistics() {
-        return Optional.of(BukkitData.Statistics.adapt(getBukkitPlayer()));
+        return Optional.of(BukkitData.Statistics.adapt(getPlayer()));
     }
 
     @NotNull
     @Override
     default Optional<Data.Health> getHealth() {
-        return Optional.of(BukkitData.Health.adapt(getBukkitPlayer()));
+        return Optional.of(BukkitData.Health.adapt(getPlayer()));
     }
 
     @NotNull
     @Override
     default Optional<Data.Hunger> getHunger() {
-        return Optional.of(BukkitData.Hunger.adapt(getBukkitPlayer()));
+        return Optional.of(BukkitData.Hunger.adapt(getPlayer()));
     }
 
     @NotNull
     @Override
     default Optional<Data.Attributes> getAttributes() {
-        return Optional.of(BukkitData.Attributes.adapt(getBukkitPlayer(), getPlugin()));
+        return Optional.of(BukkitData.Attributes.adapt(getPlayer(), getPlugin()));
     }
 
     @NotNull
     @Override
     default Optional<Data.Experience> getExperience() {
-        return Optional.of(BukkitData.Experience.adapt(getBukkitPlayer()));
+        return Optional.of(BukkitData.Experience.adapt(getPlayer()));
     }
 
     @NotNull
     @Override
     default Optional<Data.GameMode> getGameMode() {
-        return Optional.of(BukkitData.GameMode.adapt(getBukkitPlayer()));
+        return Optional.of(BukkitData.GameMode.adapt(getPlayer()));
     }
 
     @NotNull
     @Override
     default Optional<Data.FlightStatus> getFlightStatus() {
-        return Optional.of(BukkitData.FlightStatus.adapt(getBukkitPlayer()));
+        return Optional.of(BukkitData.FlightStatus.adapt(getPlayer()));
     }
 
     @NotNull
     @Override
     default Optional<Data.PersistentData> getPersistentData() {
-        return Optional.of(BukkitData.PersistentData.adapt(getBukkitPlayer().getPersistentDataContainer()));
+        return Optional.of(BukkitData.PersistentData.adapt(getPlayer().getPersistentDataContainer()));
     }
 
     boolean isDead();
 
     @NotNull
-    Player getBukkitPlayer();
+    Player getPlayer();
+
+    /**
+     * @deprecated Use {@link #getPlayer()} instead
+     */
+    @Deprecated(since = "3.6")
+    @NotNull
+    default Player getBukkitPlayer() {
+        return getPlayer();
+    }
 
     @NotNull
     default BukkitMapPersister getMapPersister() {