Network synced registries

api/build.gradle.kts

@@ -48,7 +48,11 @@ mappingCompression {
         compress("block/legacy_block_mappings.json")
         compress("block/modern_block_mappings.json")
 
+        compress("enchantment/enchantment_type_data.json")
+
         compress("stats/statistics.json")
+
+        compress("world/biome_data.json")
     }
 
     with<JsonArrayCompressionStrategy> {
@@ -61,13 +65,19 @@ mappingCompression {
 
         compress("command/argument_parser_mappings.json")
 
+        compress("damage/damagetype_mappings.json")
+
+        compress("enchantment/effect_component_type.json")
+
         compress("entity/entity_data_type_mappings.json")
         compress("entity/painting_mappings.json")
+        compress("entity/wolf_variant_mappings.json")
 
         compress("item/item_armor_material_mappings.json")
         compress("item/item_banner_pattern_mappings.json")
         compress("item/item_component_mappings.json")
         compress("item/item_instrument_mappings.json")
+        compress("item/item_jukebox_song_mappings.json")
         compress("item/item_map_decoration_type_mappings.json")
         compress("item/item_potion_mappings.json")
         compress("item/item_trim_material_mappings.json")
@@ -78,6 +88,7 @@ mappingCompression {
 
         compress("sound/sound_mappings.json")
 
+        compress("world/biome_mappings.json")
         compress("world/world_position_source_mappings.json")
     }
 
@@ -89,6 +100,8 @@ mappingCompression {
         compress("entity/legacy_entity_type_mappings.json")
 
         compress("item/item_type_mappings.json")
+
+        compress("world/dimension_type_mappings.json")
     }
 }
 

api/src/main/java/com/github/retrooper/packetevents/manager/InternalPacketListener.java

@@ -26,31 +26,21 @@
 import com.github.retrooper.packetevents.manager.protocol.ProtocolManager;
 import com.github.retrooper.packetevents.manager.server.ServerVersion;
 import com.github.retrooper.packetevents.protocol.ConnectionState;
-import com.github.retrooper.packetevents.protocol.nbt.NBTCompound;
-import com.github.retrooper.packetevents.protocol.nbt.NBTInt;
-import com.github.retrooper.packetevents.protocol.nbt.NBTList;
-import com.github.retrooper.packetevents.protocol.nbt.NBTString;
-import com.github.retrooper.packetevents.protocol.nbt.NBTType;
 import com.github.retrooper.packetevents.protocol.packettype.PacketType;
 import com.github.retrooper.packetevents.protocol.player.ClientVersion;
 import com.github.retrooper.packetevents.protocol.player.User;
 import com.github.retrooper.packetevents.protocol.player.UserProfile;
-import com.github.retrooper.packetevents.resources.ResourceLocation;
+import com.github.retrooper.packetevents.util.mappings.SynchronizedRegistriesHandler;
 import com.github.retrooper.packetevents.wrapper.configuration.server.WrapperConfigServerRegistryData;
-import com.github.retrooper.packetevents.wrapper.configuration.server.WrapperConfigServerRegistryData.RegistryElement;
 import com.github.retrooper.packetevents.wrapper.handshaking.client.WrapperHandshakingClientHandshake;
 import com.github.retrooper.packetevents.wrapper.login.server.WrapperLoginServerLoginSuccess;
 import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerJoinGame;
 import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerRespawn;
 
 import java.net.InetSocketAddress;
-import java.util.List;
 
 public class InternalPacketListener extends PacketListenerAbstract {
 
-    private static final ResourceLocation DIMENSION_TYPE_REGISTRY_KEY =
-            ResourceLocation.minecraft("dimension_type");
-
     public InternalPacketListener() {
         this(PacketListenerPriority.LOWEST);
     }
@@ -92,94 +82,37 @@ public void onPacketSend(PacketSendEvent event) {
             }
         }
 
-        // The server sends dimension information in configuration phase >= 1.20.2
+        // The server sends dimension information in configuration phase, since 1.20.2
         else if (event.getPacketType() == PacketType.Configuration.Server.REGISTRY_DATA) {
-            WrapperConfigServerRegistryData registryData = new WrapperConfigServerRegistryData(event);
-
-            // Store world data
-            NBTCompound registryDataTag = registryData.getRegistryData();
-            NBTList<NBTCompound> list = null;
-            if (registryDataTag != null) { // <1.20.5
-                //Handle dimension type
-                NBTCompound dimensionTypes = registryDataTag
-                        .getCompoundTagOrNull(DIMENSION_TYPE_REGISTRY_KEY.toString());
-                if (dimensionTypes == null) {
-                    dimensionTypes = registryDataTag
-                            .getCompoundTagOrNull(DIMENSION_TYPE_REGISTRY_KEY.getKey());
-                }
-                if (dimensionTypes != null) {
-                    list = dimensionTypes.getCompoundListTagOrNull("value");
-                }
-                if (list == null) {
-                    list = new NBTList<>(NBTType.COMPOUND);
-                    PacketEvents.getAPI().getLogger().warning("Can't find dimension type registry in registry data, "
-                            + "this may cause issues; available registries: " + registryDataTag.getTags().keySet());
-                }
-            } else if (DIMENSION_TYPE_REGISTRY_KEY.equals(registryData.getRegistryKey())) { // >=1.20.5
-                // remap to legacy format
-                list = new NBTList<>(NBTType.COMPOUND);
-                List<RegistryElement> elements = registryData.getElements();
-                if (elements != null) {
-                    int i = 0;
-                    for (RegistryElement element : elements) {
-                        NBTCompound tag = new NBTCompound();
-                        tag.setTag("name", new NBTString(element.getId().toString()));
-                        tag.setTag("id", new NBTInt(i++));
-                        if (element.getData() != null) { // may be null because of known packs not being sent
-                            tag.setTag("element", element.getData());
-                        }
-                        list.addTag(tag);
-                    }
-                }
+            WrapperConfigServerRegistryData packet = new WrapperConfigServerRegistryData(event);
+
+            if (packet.getElements() != null) { // 1.20.2 to 1.20.5
+                SynchronizedRegistriesHandler.handleRegistry(user, packet.getServerVersion().toClientVersion(),
+                        packet.getRegistryKey(), packet.getElements());
             }
-            if (list != null) {
-                user.setWorldNBT(list);
+            if (packet.getRegistryData() != null) { // since 1.20.5
+                SynchronizedRegistriesHandler.handleLegacyRegistries(user, packet.getServerVersion()
+                        .toClientVersion(), packet.getRegistryData());
             }
         }
 
-        // The server sends dimension information in login packet for >= 1.17 and < 1.20.2
+        // The server sends registry info in login packet for 1.16 to 1.20.1
         else if (event.getPacketType() == PacketType.Play.Server.JOIN_GAME) {
             WrapperPlayServerJoinGame joinGame = new WrapperPlayServerJoinGame(event);
             user.setEntityId(joinGame.getEntityId());
-            user.setDimension(joinGame.getDimension());
-            if (event.getServerVersion().isOlderThanOrEquals(ServerVersion.V_1_16_5)) {
-                return; // Fixed world height, no tags are sent to the client
-            }
 
-            // Store world data
-            NBTCompound dimensionCodec = joinGame.getDimensionCodec();
-            if (dimensionCodec != null) {
-                NBTList<NBTCompound> types = null;
-                NBTCompound dimensionTypes = dimensionCodec
-                        .getCompoundTagOrNull(DIMENSION_TYPE_REGISTRY_KEY.toString());
-                if (dimensionTypes == null) {
-                    dimensionTypes = dimensionCodec
-                            .getCompoundTagOrNull(DIMENSION_TYPE_REGISTRY_KEY.getKey());
-                }
-                if (dimensionTypes != null) { // account for dimension type registry somehow going missing
-                    types = dimensionTypes.getCompoundListTagOrNull("value");
-                }
-                if (types == null) {
-                    types = new NBTList<>(NBTType.COMPOUND);
-                    PacketEvents.getAPI().getLogger().warning("Can't find dimension type registry in join packet, "
-                            + "this may cause issues; available registries: " + dimensionCodec.getTags().keySet());
-                }
-                user.setWorldNBT(types);
+            if (joinGame.getDimensionCodec() != null) { // 1.16 to 1.20.1
+                SynchronizedRegistriesHandler.handleLegacyRegistries(user, joinGame.getServerVersion().toClientVersion(),
+                        joinGame.getDimensionCodec());
             }
 
-            // Update world height
-            user.switchDimensionType(joinGame.getServerVersion(), joinGame.getDimension());
+            user.setDimensionType(joinGame.getDimensionType());
         }
 
         // Respawn is used to switch dimensions
         else if (event.getPacketType() == PacketType.Play.Server.RESPAWN) {
-            WrapperPlayServerRespawn respawn = new WrapperPlayServerRespawn(event);
-            user.setDimension(respawn.getDimension());
-            if (event.getServerVersion().isOlderThanOrEquals(ServerVersion.V_1_16_5)) {
-                return; // Fixed world height, no tags are sent to the client
-            }
-
-            user.switchDimensionType(respawn.getServerVersion(), respawn.getDimension());
+            WrapperPlayServerRespawn packet = new WrapperPlayServerRespawn(event);
+            user.setDimensionType(packet.getDimensionType());
         } else if (event.getPacketType() == PacketType.Play.Server.CONFIGURATION_START) {
             user.setEncoderState(ConnectionState.CONFIGURATION);
         } else if (event.getPacketType() == PacketType.Configuration.Server.CONFIGURATION_END) {

api/src/main/java/com/github/retrooper/packetevents/manager/server/ServerManager.java

@@ -18,6 +18,10 @@
 
 package com.github.retrooper.packetevents.manager.server;
 
+import com.github.retrooper.packetevents.protocol.player.ClientVersion;
+import com.github.retrooper.packetevents.protocol.player.User;
+import org.jetbrains.annotations.Nullable;
+
 public interface ServerManager {
     /**
      * Get the server version.
@@ -34,4 +38,20 @@ public interface ServerManager {
     default SystemOS getOS() {
         return SystemOS.getOS();
     }
+
+    /**
+     * Gets a platform-specific network-synchronized-registries cache key.
+     * <p>
+     * This tells packetevents, if a registry should be cached or read again. On
+     * backend servers with global registries, this may be a constant value. On
+     * proxy servers with per-server registries, this may be a value which depends
+     * on the current server the {@link User} is on.
+     *
+     * @param user    the {@link User} for which the registry gets read
+     * @param version the version the packet is for
+     * @return some value or null for no caching at all
+     */
+    default @Nullable Object getRegistryCacheKey(User user, ClientVersion version) {
+        return null; // no caching
+    }
 }

api/src/main/java/com/github/retrooper/packetevents/protocol/chat/ChatType.java

@@ -19,17 +19,31 @@
 package com.github.retrooper.packetevents.protocol.chat;
 
 import com.github.retrooper.packetevents.protocol.chat.message.ChatMessage_v1_19_1;
+import com.github.retrooper.packetevents.protocol.mapper.CopyableEntity;
 import com.github.retrooper.packetevents.protocol.mapper.MappedEntity;
+import com.github.retrooper.packetevents.protocol.nbt.NBT;
+import com.github.retrooper.packetevents.protocol.nbt.NBTCompound;
+import com.github.retrooper.packetevents.protocol.nbt.NBTString;
+import com.github.retrooper.packetevents.protocol.player.ClientVersion;
+import com.github.retrooper.packetevents.util.mappings.TypesBuilderData;
 import com.github.retrooper.packetevents.wrapper.PacketWrapper;
 import net.kyori.adventure.text.Component;
+import net.kyori.adventure.util.Index;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Nullable;
 
-public interface ChatType extends MappedEntity {
+public interface ChatType extends MappedEntity, CopyableEntity<ChatType> {
 
     ChatTypeDecoration getChatDecoration();
 
+    @ApiStatus.Obsolete(since = "1.19.1")
+    ChatTypeDecoration getOverlayDecoration();
+
     ChatTypeDecoration getNarrationDecoration();
 
+    @ApiStatus.Obsolete(since = "1.19.1")
+    NarrationPriority getNarrationPriority();
+
     static ChatType readDirect(PacketWrapper<?> wrapper) {
         ChatTypeDecoration chatDecoration = ChatTypeDecoration.read(wrapper);
         ChatTypeDecoration narrationDecoration = ChatTypeDecoration.read(wrapper);
@@ -41,9 +55,75 @@ static void writeDirect(PacketWrapper<?> wrapper, ChatType chatType) {
         ChatTypeDecoration.write(wrapper, chatType.getNarrationDecoration());
     }
 
+    static ChatType decode(NBT nbt, ClientVersion version, @Nullable TypesBuilderData data) {
+        NBTCompound compound = (NBTCompound) nbt;
+        NBTCompound chatTag = compound.getCompoundTagOrThrow("chat");
+        NBTCompound narrationTag = compound.getCompoundTagOrThrow("narration");
+
+        ChatTypeDecoration overlay = null;
+        NarrationPriority narrationPriority = null;
+        if (version.isOlderThan(ClientVersion.V_1_19_1)) {
+            overlay = ChatTypeDecoration.decode(compound.getCompoundTagOrThrow("overlay"), version);
+            narrationPriority = NarrationPriority.ID_INDEX.valueOrThrow(
+                    narrationTag.getStringTagValueOrThrow("priority"));
+            chatTag = chatTag.getCompoundTagOrThrow("description");
+            narrationTag = narrationTag.getCompoundTagOrThrow("description");
+        }
+
+        ChatTypeDecoration chat = ChatTypeDecoration.decode(chatTag, version);
+        ChatTypeDecoration narration = ChatTypeDecoration.decode(narrationTag, version);
+        return new StaticChatType(data, chat, overlay, narration, narrationPriority);
+    }
+
+    static NBT encode(ChatType chatType, ClientVersion version) {
+        NBTCompound compound = new NBTCompound();
+        NBT chatTag = ChatTypeDecoration.encode(chatType.getChatDecoration(), version);
+        NBT narrationTag = ChatTypeDecoration.encode(chatType.getNarrationDecoration(), version);
+
+        if (version.isOlderThan(ClientVersion.V_1_19_1)) {
+            if (chatType.getOverlayDecoration() != null) {
+                compound.setTag("overlay",
+                        ChatTypeDecoration.encode(chatType.getOverlayDecoration(), version));
+            }
+            NBTCompound narrationCompound = new NBTCompound();
+            narrationCompound.setTag("description", narrationTag);
+            if (chatType.getNarrationPriority() != null) {
+                narrationCompound.setTag("priority", new NBTString(chatType.getNarrationPriority().getId()));
+            }
+            narrationTag = narrationCompound;
+            NBTCompound chatCompound = new NBTCompound();
+            chatCompound.setTag("description", chatTag);
+            chatTag = chatCompound;
+        }
+
+        compound.setTag("chat", chatTag);
+        compound.setTag("narration", narrationTag);
+        return compound;
+    }
+
     class Bound extends ChatMessage_v1_19_1.ChatTypeBoundNetwork {
         public Bound(ChatType type, Component name, @Nullable Component targetName) {
             super(type, name, targetName);
         }
     }
+
+    @ApiStatus.Obsolete(since = "1.19.1")
+    enum NarrationPriority {
+
+        CHAT("chat"),
+        SYSTEM("system");
+
+        public static final Index<String, NarrationPriority> ID_INDEX = Index.create(
+                NarrationPriority.class, NarrationPriority::getId);
+
+        private final String id;
+
+        NarrationPriority(String id) {
+            this.id = id;
+        }
+
+        public String getId() {
+            return this.id;
+        }
+    }
 }