Registry encoding compression

Author: ZsoltMolnarrr

CHANGELOG.md

@@ -4,6 +4,7 @@ Functional Changes:
 - Fix Combat Roll not cancelling attack properly
 - Increase attack range (slightly) on all built-in weapon attribute presets
 - Improve idle animation handling with server side logic
+- Add registry encoding compression to avoid transmission issues
 - Add support `player.entity_interaction_range` attribute, to serve as attack range
 - Add support for weapon attributes resolved from item data component. For example:
 

common/src/main/java/net/bettercombat/config/ServerConfig.java

@@ -102,6 +102,8 @@ Entities struck (+1) in a swing more than this, won't get weakened any further.
     public boolean fallback_compatibility_enabled = true;
     @Comment("Allow printing the content of weapon attributes registry")
     public boolean weapon_registry_logging = false;
+    @Comment("Compress the weapon attributes registry for transmission")
+    public boolean weapon_registry_compression = true;
 
     public float getUpswingMultiplier() {
         return Math.max(0.2F, Math.min(1, upswing_multiplier));

common/src/main/java/net/bettercombat/logic/WeaponRegistry.java

@@ -11,6 +11,7 @@
 import net.bettercombat.api.WeaponAttributesHelper;
 import net.bettercombat.api.component.BetterCombatDataComponents;
 import net.bettercombat.network.Packets;
+import net.bettercombat.utils.CompressionHelper;
 import net.minecraft.item.Item;
 import net.minecraft.item.ItemStack;
 import net.minecraft.registry.Registries;
@@ -137,7 +138,8 @@ public static void resolveAndRegisterAttributes(Identifier itemId, AttributesCon
 
     // NETWORK SYNC
 
-    private static Packets.WeaponRegistrySync encodedRegistrations = new Packets.WeaponRegistrySync(List.of());
+    private static Encoded encodedRegistrations = new Encoded(true, List.of());
+    public record Encoded(boolean compressed, List<String> chunks) {}
     private static final int CHUNK_SIZE = 10000;
     private static final Gson gson = new GsonBuilder().create();
     public static class SyncFormat {
@@ -146,8 +148,8 @@ public static class SyncFormat {
     }
 
     public static void encodeRegistry() {
+        var compressed = BetterCombatMod.config.weapon_registry_compression;
         List<String> chunks = new ArrayList<>();
-
         var syncContent = new SyncFormat();
         containers.forEach((key, value) -> {
             syncContent.attributes.put(key.toString(), value);
@@ -157,31 +159,38 @@ public static void encodeRegistry() {
         });
 
         var json = gson.toJson(syncContent);
+        if (compressed) {
+            json = CompressionHelper.gzipCompress(json);
+        }
         if (BetterCombatMod.config.weapon_registry_logging) {
             LOGGER.info("Weapon Attribute assignments loaded: " + json);
         }
         for (int i = 0; i < json.length(); i += CHUNK_SIZE) {
             chunks.add(json.substring(i, Math.min(json.length(), i + CHUNK_SIZE)));
         }
 
-        encodedRegistrations = new Packets.WeaponRegistrySync(chunks);
+        encodedRegistrations = new Encoded(compressed, chunks);
+
+        var referencePacket = new Packets.WeaponRegistrySync(compressed, chunks);
         var buffer = Platform.createByteBuffer();
-        encodedRegistrations.write(buffer);
+        referencePacket.write(buffer);
         LOGGER.info("Encoded Weapon Attribute registry size (with package overhead): " + buffer.readableBytes()
                 + " bytes (in " + chunks.size() + " string chunks with the size of "  + CHUNK_SIZE + ")");
     }
 
     public static void decodeRegistry(Packets.WeaponRegistrySync syncPacket) {
+        var compressed = syncPacket.compressed();
         String json = "";
         for (var chunk : syncPacket.chunks()) {
             json = json.concat(chunk);
         }
+        if (compressed) {
+            json = CompressionHelper.gzipDecompress(json);
+        }
         LOGGER.info("Decoded Weapon Attribute registry in " + syncPacket.chunks().size() + " string chunks");
         if (BetterCombatMod.config.weapon_registry_logging) {
             LOGGER.info("Weapon Attribute registry received: " + json);
         }
-        LOGGER.info("Weapon Attribute registry received (pretty printed): ");
-        LOGGER.info(json);
 
         SyncFormat sync = gson.fromJson(json, SyncFormat.class);
         containers.clear();
@@ -194,7 +203,7 @@ public static void decodeRegistry(Packets.WeaponRegistrySync syncPacket) {
         });
     }
 
-    public static Packets.WeaponRegistrySync getEncodedRegistry() {
+    public static Encoded getEncodedRegistry() {
         return encodedRegistrations;
     }
 }

common/src/main/java/net/bettercombat/network/Packets.java

@@ -117,25 +117,27 @@ public Id<? extends CustomPayload> getId() {
         }
     }
 
-    public record WeaponRegistrySync(List<String> chunks) implements CustomPayload {
+    public record WeaponRegistrySync(boolean compressed, List<String> chunks) implements CustomPayload {
         public static Identifier ID = Identifier.of(BetterCombatMod.ID, "weapon_registry");
         public static final CustomPayload.Id<WeaponRegistrySync> PACKET_ID = new CustomPayload.Id<>(ID);
         public static final PacketCodec<PacketByteBuf, WeaponRegistrySync> CODEC = PacketCodec.of(WeaponRegistrySync::write, WeaponRegistrySync::read);
 
         public void write(PacketByteBuf buffer) {
+            buffer.writeBoolean(compressed);
             buffer.writeInt(chunks.size());
             for (var chunk: chunks) {
                 buffer.writeString(chunk);
             }
         }
 
         public static WeaponRegistrySync read(PacketByteBuf buffer) {
+            var compressed = buffer.readBoolean();
             var chunkCount = buffer.readInt();
             var chunks = new ArrayList<String>();
             for (int i = 0; i < chunkCount; ++i) {
                 chunks.add(buffer.readString());
             }
-            return new WeaponRegistrySync(chunks);
+            return new WeaponRegistrySync(compressed, chunks);
         }
 
         @Override

common/src/main/java/net/bettercombat/utils/CompressionHelper.java

@@ -0,0 +1,47 @@
+package net.bettercombat.utils;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.util.zip.GZIPInputStream;
+import java.util.zip.GZIPOutputStream;
+
+import java.util.Base64;
+
+public class CompressionHelper {
+
+    // Compresses a string using GZIP and returns the result as a Base64 encoded string
+    public static String gzipCompress(String uncompressed) {
+        if (uncompressed == null || uncompressed.isEmpty()) {
+            return uncompressed;
+        }
+        try (ByteArrayOutputStream byteStream = new ByteArrayOutputStream();
+             GZIPOutputStream gzipStream = new GZIPOutputStream(byteStream)) {
+            gzipStream.write(uncompressed.getBytes());
+            gzipStream.close(); // Ensure all data is flushed
+            return Base64.getEncoder().encodeToString(byteStream.toByteArray());
+        } catch (IOException e) {
+            throw new RuntimeException("Failed to compress string", e);
+        }
+    }
+
+    // Decompresses a Base64 encoded GZIP string back into the original string
+    public static String gzipDecompress(String compressed) {
+        if (compressed == null || compressed.isEmpty()) {
+            return compressed;
+        }
+        try (ByteArrayInputStream byteStream = new ByteArrayInputStream(Base64.getDecoder().decode(compressed));
+             GZIPInputStream gzipStream = new GZIPInputStream(byteStream);
+             ByteArrayOutputStream resultStream = new ByteArrayOutputStream()) {
+
+            byte[] buffer = new byte[1024];
+            int length;
+            while ((length = gzipStream.read(buffer)) > 0) {
+                resultStream.write(buffer, 0, length);
+            }
+            return resultStream.toString();
+        } catch (IOException e) {
+            throw new RuntimeException("Failed to decompress string", e);
+        }
+    }
+}

fabric/src/main/java/net/bettercombat/fabric/network/FabricServerNetwork.java

@@ -37,7 +37,7 @@ public static void init() {
                     throw new AssertionError("Weapon registry is empty!");
                 }
                 // System.out.println("Starting WeaponRegistrySyncTask, chunks: " + WeaponRegistry.getEncodedRegistry().chunks().size());
-                handler.addTask(new WeaponRegistrySyncTask(WeaponRegistry.getEncodedRegistry().chunks()));
+                handler.addTask(new WeaponRegistrySyncTask(WeaponRegistry.getEncodedRegistry()));
             } else {
                 handler.disconnect(Text.literal("Network configuration task not supported: " + WeaponRegistrySyncTask.name));
             }
@@ -84,7 +84,7 @@ public void sendPacket(Consumer<Packet<?>> sender) {
         }
     }
 
-    public record WeaponRegistrySyncTask(List<String> encodedRegistry) implements ServerPlayerConfigurationTask {
+    public record WeaponRegistrySyncTask(WeaponRegistry.Encoded encodedRegistry) implements ServerPlayerConfigurationTask {
         public static final String name = BetterCombatMod.ID + ":" + "weapon_registry";
         public static final Key KEY = new Key(name);
 
@@ -95,7 +95,7 @@ public Key getKey() {
 
         @Override
         public void sendPacket(Consumer<Packet<?>> sender) {
-            var packet = new Packets.WeaponRegistrySync(encodedRegistry);
+            var packet = new Packets.WeaponRegistrySync(encodedRegistry.compressed(), encodedRegistry.chunks());
             sender.accept(ServerConfigurationNetworking.createS2CPacket(packet));
         }
     }

neoforge/src/main/java/net/bettercombat/neoforge/network/NetworkEvents.java

@@ -107,7 +107,8 @@ public Key getKey() {
 
         @Override
         public void run(Consumer<CustomPayload> sender) {
-            var packet = new Packets.WeaponRegistrySync(WeaponRegistry.getEncodedRegistry().chunks());
+            var encodded = WeaponRegistry.getEncodedRegistry();
+            var packet = new Packets.WeaponRegistrySync(encodded.compressed(), encodded.chunks());
             sender.accept(packet);
         }
     }