Merge remote-tracking branch 'upstream/master' into client-vehicle

README.md

@@ -14,7 +14,7 @@ The ultimate goal of this project is to allow Minecraft: Bedrock Edition users t
 
 Special thanks to the DragonProxy project for being a trailblazer in protocol translation and for all the team members who have joined us here!
 
-### Currently supporting Minecraft Bedrock 1.20.80 - 1.21.1 and Minecraft Java 1.21
+### Currently supporting Minecraft Bedrock 1.20.80 - 1.21.2 and Minecraft Java 1.21
 
 ## Setting Up
 Take a look [here](https://wiki.geysermc.org/geyser/setup/) for how to set up Geyser.

core/src/main/java/org/geysermc/geyser/entity/EntityDefinitions.java

@@ -307,11 +307,11 @@ public final class EntityDefinitions {
                     .addTranslator(MetadataType.INT, TNTEntity::setFuseLength)
                     .build();
 
-            EntityDefinition<Entity> displayBase = EntityDefinition.inherited(entityBase.factory(), entityBase)
+            EntityDefinition<DisplayBaseEntity> displayBase = EntityDefinition.inherited(DisplayBaseEntity::new, entityBase)
                     .addTranslator(null) // Interpolation delay
                     .addTranslator(null) // Transformation interpolation duration
                     .addTranslator(null) // Position/Rotation interpolation duration
-                    .addTranslator(null) // Translation
+                    .addTranslator(MetadataType.VECTOR3, DisplayBaseEntity::setTranslation) // Translation
                     .addTranslator(null) // Scale
                     .addTranslator(null) // Left rotation
                     .addTranslator(null) // Right rotation

core/src/main/java/org/geysermc/geyser/entity/type/DisplayBaseEntity.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2024 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.entity.type;
+
+import net.kyori.adventure.text.Component;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.cloudburstmc.math.vector.Vector3f;
+import org.geysermc.geyser.entity.EntityDefinition;
+import org.geysermc.geyser.session.GeyserSession;
+import org.geysermc.geyser.util.EntityUtils;
+import org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata;
+import org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.BooleanEntityMetadata;
+
+import java.util.Optional;
+import java.util.UUID;
+
+public class DisplayBaseEntity extends Entity {
+
+    private @Nullable Vector3f baseTranslation;
+
+    public DisplayBaseEntity(GeyserSession session, int entityId, long geyserId, UUID uuid, EntityDefinition<?> definition, Vector3f position, Vector3f motion, float yaw, float pitch, float headYaw) {
+        super(session, entityId, geyserId, uuid, definition, position, motion, yaw, pitch, headYaw);
+    }
+
+    @Override
+    public void setDisplayNameVisible(BooleanEntityMetadata entityMetadata) {
+        // Don't allow the display name to be hidden - messes with our armor stand.
+        // On JE: Hiding the display name still shows the display entity text.
+    }
+
+    @Override
+    public void setDisplayName(EntityMetadata<Optional<Component>, ?> entityMetadata) {
+        // This would usually set EntityDataTypes.NAME, but we are instead using NAME for the text display.
+        // On JE: custom name does not override text display.
+    }
+
+    public void setTranslation(EntityMetadata<Vector3f, ?> translationMeta){
+        this.baseTranslation = translationMeta.getValue();
+        if (this.baseTranslation == null) {
+            return;
+        }
+        if (this.vehicle == null) {
+            this.setRiderSeatPosition(this.baseTranslation);
+            this.moveRelative(this.baseTranslation.getX(), this.baseTranslation.getY(), this.baseTranslation.getZ(), yaw, pitch, headYaw, false);
+        } else {
+            EntityUtils.updateMountOffset(this, this.vehicle, true, true, false);
+            this.updateBedrockMetadata();
+        }
+    }
+
+    public Vector3f getTranslation() {
+        return baseTranslation;
+    }
+}

core/src/main/java/org/geysermc/geyser/entity/type/TextDisplayEntity.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
+ * Copyright (c) 2024 GeyserMC. http://geysermc.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -32,13 +32,11 @@
 import org.geysermc.geyser.session.GeyserSession;
 import org.geysermc.geyser.translator.text.MessageTranslator;
 import org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata;
-import org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.BooleanEntityMetadata;
 
-import java.util.Optional;
 import java.util.UUID;
 
 // Note: 1.19.4 requires that the billboard is set to something in order to show, on Java Edition
-public class TextDisplayEntity extends Entity {
+public class TextDisplayEntity extends DisplayBaseEntity {
     public TextDisplayEntity(GeyserSession session, int entityId, long geyserId, UUID uuid, EntityDefinition<?> definition, Vector3f position, Vector3f motion, float yaw, float pitch, float headYaw) {
         super(session, entityId, geyserId, uuid, definition, position, motion, yaw, pitch, headYaw);
     }
@@ -51,18 +49,6 @@ protected void initializeMetadata() {
         this.dirtyMetadata.put(EntityDataTypes.NAMETAG_ALWAYS_SHOW, (byte) 1);
     }
 
-    @Override
-    public void setDisplayNameVisible(BooleanEntityMetadata entityMetadata) {
-        // Don't allow the display name to be hidden - messes with our armor stand.
-        // On JE: Hiding the display name still shows the display entity text.
-    }
-
-    @Override
-    public void setDisplayName(EntityMetadata<Optional<Component>, ?> entityMetadata) {
-        // This would usually set EntityDataTypes.NAME, but we are instead using NAME for the text display.
-        // On JE: custom name does not override text display.
-    }
-
     public void setText(EntityMetadata<Component, ?> entityMetadata) {
         this.dirtyMetadata.put(EntityDataTypes.NAME, MessageTranslator.convertMessage(entityMetadata.getValue()));
     }

core/src/main/java/org/geysermc/geyser/item/type/ShulkerBoxItem.java

@@ -29,15 +29,19 @@
 import org.cloudburstmc.nbt.NbtMap;
 import org.cloudburstmc.nbt.NbtMapBuilder;
 import org.cloudburstmc.nbt.NbtType;
+import org.cloudburstmc.protocol.bedrock.data.definitions.ItemDefinition;
+import org.geysermc.geyser.inventory.item.Potion;
 import org.geysermc.geyser.item.Items;
 import org.geysermc.geyser.level.block.type.Block;
 import org.geysermc.geyser.registry.type.ItemMapping;
 import org.geysermc.geyser.session.GeyserSession;
 import org.geysermc.geyser.translator.item.BedrockItemBuilder;
+import org.geysermc.geyser.translator.item.CustomItemTranslator;
 import org.geysermc.geyser.translator.item.ItemTranslator;
 import org.geysermc.mcprotocollib.protocol.data.game.item.ItemStack;
 import org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponentType;
 import org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents;
+import org.geysermc.mcprotocollib.protocol.data.game.item.component.PotionContents;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -64,12 +68,35 @@ public void translateComponentsToBedrock(@NonNull GeyserSession session, @NonNul
             }
             ItemMapping boxMapping = session.getItemMappings().getMapping(item.getId());
 
-            NbtMapBuilder boxItemNbt = BedrockItemBuilder.createItemNbt(boxMapping, item.getAmount(), boxMapping.getBedrockData()); // Final item tag to add to the list
+            int bedrockData = boxMapping.getBedrockData();
+            String bedrockIdentifier = boxMapping.getBedrockIdentifier();
+            DataComponents boxComponents = item.getDataComponents();
+
+            if (boxComponents != null) {
+                // Check for custom items
+                ItemDefinition customItemDefinition = CustomItemTranslator.getCustomItem(boxComponents, boxMapping);
+                if (customItemDefinition != null) {
+                    bedrockIdentifier = customItemDefinition.getIdentifier();
+                    bedrockData = 0;
+                } else {
+                    // Manual checks for potions/tipped arrows
+                    if (boxMapping.getJavaItem() instanceof PotionItem || boxMapping.getJavaItem() instanceof ArrowItem) {
+                        PotionContents potionContents = boxComponents.get(DataComponentType.POTION_CONTENTS);
+                        if (potionContents != null) {
+                            Potion potion = Potion.getByJavaId(potionContents.getPotionId());
+                            if (potion != null) {
+                                bedrockData = potion.getBedrockId();
+                            }
+                        }
+                    }
+                }
+            }
+
+            NbtMapBuilder boxItemNbt = BedrockItemBuilder.createItemNbt(bedrockIdentifier, item.getAmount(), bedrockData); // Final item tag to add to the list
             boxItemNbt.putByte("Slot", (byte) slot);
             boxItemNbt.putByte("WasPickedUp", (byte) 0); // ??? TODO might not be needed
 
             // Only the display name is what we have interest in, so just translate that if relevant
-            DataComponents boxComponents = item.getDataComponents();
             if (boxComponents != null) {
                 String customName = ItemTranslator.getCustomName(session, boxComponents, boxMapping, '7');
                 if (customName != null) {

core/src/main/java/org/geysermc/geyser/level/block/type/DoorBlock.java

@@ -37,9 +37,22 @@ public DoorBlock(String javaIdentifier, Builder builder) {
 
     @Override
     public void updateBlock(GeyserSession session, BlockState state, Vector3i position) {
+        // Needed to check whether we must force the client to update the door state.
+        String doubleBlockHalf = state.getValue(Properties.DOUBLE_BLOCK_HALF);
+
+        if (!session.getGeyser().getWorldManager().hasOwnChunkCache() && doubleBlockHalf.equals("lower")) {
+            BlockState oldBlockState = session.getGeyser().getWorldManager().blockAt(session, position);
+            // If these are the same, it means that we already updated the lower door block (manually in the workaround below),
+            // and we do not need to update the block in the cache/on the client side using the super.updateBlock() method again.
+            // Otherwise, we send the door updates twice which will cause visual glitches on the client side
+            if (oldBlockState == state) {
+                return;
+            }
+        }
+
         super.updateBlock(session, state, position);
 
-        if (state.getValue(Properties.DOUBLE_BLOCK_HALF).equals("upper")) {
+        if (doubleBlockHalf.equals("upper")) {
             // Update the lower door block as Bedrock client doesn't like door to be closed from the top
             // See https://github.com/GeyserMC/Geyser/issues/4358
             Vector3i belowDoorPosition = position.sub(0, 1, 0);

core/src/main/java/org/geysermc/geyser/network/GameProtocol.java

@@ -43,13 +43,17 @@
  */
 public final class GameProtocol {
 
+    // Surprise protocol bump WOW
+    private static final BedrockCodec BEDROCK_V686 = Bedrock_v685.CODEC.toBuilder()
+        .protocolVersion(686)
+        .minecraftVersion("1.21.2")
+        .build();
+
     /**
      * Default Bedrock codec that should act as a fallback. Should represent the latest available
      * release of the game that Geyser supports.
      */
-    public static final BedrockCodec DEFAULT_BEDROCK_CODEC = CodecProcessor.processCodec(Bedrock_v685.CODEC.toBuilder()
-            .minecraftVersion("1.21.1")
-            .build());
+    public static final BedrockCodec DEFAULT_BEDROCK_CODEC = CodecProcessor.processCodec(BEDROCK_V686);
 
     /**
      * A list of all supported Bedrock versions that can join Geyser
@@ -66,9 +70,10 @@ public final class GameProtocol {
         SUPPORTED_BEDROCK_CODECS.add(CodecProcessor.processCodec(Bedrock_v671.CODEC.toBuilder()
             .minecraftVersion("1.20.80/1.20.81")
             .build()));
-        SUPPORTED_BEDROCK_CODECS.add(CodecProcessor.processCodec(DEFAULT_BEDROCK_CODEC.toBuilder()
-            .minecraftVersion("1.21.0/1.20.1")
+        SUPPORTED_BEDROCK_CODECS.add(CodecProcessor.processCodec(Bedrock_v685.CODEC.toBuilder()
+            .minecraftVersion("1.21.0/1.21.1")
             .build()));
+        SUPPORTED_BEDROCK_CODECS.add(DEFAULT_BEDROCK_CODEC);
     }
 
     /**

core/src/main/java/org/geysermc/geyser/translator/item/BedrockItemBuilder.java

@@ -145,8 +145,15 @@ public NbtMap build() {
      * Creates item NBT to nest within NBT with name, count, and damage set.
      */
     public static NbtMapBuilder createItemNbt(ItemMapping mapping, int count, int damage) {
+        return createItemNbt(mapping.getBedrockIdentifier(), count, damage);
+    }
+
+    /**
+     * Creates item NBT to nest within NBT with name, count, and damage set.
+     */
+    public static NbtMapBuilder createItemNbt(String bedrockIdentifier, int count, int damage) {
         NbtMapBuilder builder = NbtMap.builder();
-        builder.putString("Name", mapping.getBedrockIdentifier());
+        builder.putString("Name", bedrockIdentifier);
         builder.putByte("Count", (byte) count);
         builder.putShort("Damage", (short) damage);
         return builder;

core/src/main/java/org/geysermc/geyser/translator/item/ItemTranslator.java

@@ -52,6 +52,7 @@
 import org.geysermc.geyser.text.MinecraftLocale;
 import org.geysermc.geyser.translator.text.MessageTranslator;
 import org.geysermc.geyser.util.InventoryUtils;
+import org.geysermc.mcprotocollib.protocol.data.game.entity.attribute.AttributeType;
 import org.geysermc.mcprotocollib.protocol.data.game.entity.attribute.ModifierOperation;
 import org.geysermc.mcprotocollib.protocol.data.game.item.ItemStack;
 import org.geysermc.mcprotocollib.protocol.data.game.item.component.*;
@@ -209,7 +210,7 @@ private static void addAttributeLore(ItemAttributeModifiers modifiers, BedrockIt
         Map<ItemAttributeModifiers.EquipmentSlotGroup, List<String>> slotsToModifiers = new HashMap<>();
         for (ItemAttributeModifiers.Entry entry : modifiers.getModifiers()) {
             // convert the modifier tag to a lore entry
-            String loreEntry = attributeToLore(entry.getModifier(), language);
+            String loreEntry = attributeToLore(entry.getAttribute(), entry.getModifier(), language);
             if (loreEntry == null) {
                 continue; // invalid or failed
             }
@@ -254,13 +255,13 @@ private static void addAttributeLore(ItemAttributeModifiers modifiers, BedrockIt
     }
 
     @Nullable
-    private static String attributeToLore(ItemAttributeModifiers.AttributeModifier modifier, String language) {
+    private static String attributeToLore(int attribute, ItemAttributeModifiers.AttributeModifier modifier, String language) {
         double amount = modifier.getAmount();
         if (amount == 0) {
             return null;
         }
 
-        String name = modifier.getId().asMinimalString();
+        String name = AttributeType.Builtin.from(attribute).getIdentifier().asMinimalString();
         // the namespace does not need to be present, but if it is, the java client ignores it as of pre-1.20.5
 
         ModifierOperation operation = modifier.getOperation();

core/src/main/java/org/geysermc/geyser/translator/protocol/java/level/JavaBlockUpdateTranslator.java

@@ -100,8 +100,8 @@ private void checkInteract(GeyserSession session, ClientboundBlockUpdatePacket p
                 || lastInteractPos.getZ() != packet.getEntry().getPosition().getZ())) {
             return;
         }
-        String identifier = BlockState.of(packet.getEntry().getBlock()).toString(); // This will be yeeted soon. Thanks Chris.
+        BlockState state = BlockState.of(packet.getEntry().getBlock());
         session.setInteracting(false);
-        BlockSoundInteractionTranslator.handleBlockInteraction(session, lastInteractPos.toFloat(), identifier);
+        BlockSoundInteractionTranslator.handleBlockInteraction(session, lastInteractPos.toFloat(), state);
     }
 }