Tag 2.14.1

Update Plugins.md

item-nbt-api/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.tr7zw</groupId>
     <artifactId>item-nbt-parent</artifactId>
-    <version>2.14.0</version>
+    <version>2.14.1</version>
   </parent>
 
   <artifactId>item-nbt-api</artifactId>

item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/utils/DataFixerUtil.java

@@ -31,6 +31,7 @@ public class DataFixerUtil {
     public static final int VERSION1_20_5 = 3837;
     public static final int VERSION1_21 = 3953;
     public static final int VERSION1_21_2 = 4080;
+    public static final int VERSION1_21_3 = 4189;
 
     @SuppressWarnings("unchecked")
     public static Object fixUpRawItemData(Object nbt, int fromVersion, int toVersion)
@@ -63,7 +64,9 @@ public class DataFixerUtil {
      * @return
      */
     public static int getCurrentVersion() {
-        if (MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_21_R2)) {
+        if (MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_21_R3)) {
+            return VERSION1_21_3;
+        } else if (MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_21_R2)) {
             return VERSION1_21_2;
         } else if (MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_21_R1)) {
             return VERSION1_21;

item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/utils/MinecraftVersion.java

@@ -24,7 +24,7 @@ public enum MinecraftVersion {
     MC1_13_R1(1131), MC1_13_R2(1132), MC1_14_R1(1141), MC1_15_R1(1151), MC1_16_R1(1161), MC1_16_R2(1162),
     MC1_16_R3(1163), MC1_17_R1(1171), MC1_18_R1(1181, true), MC1_18_R2(1182, true), MC1_19_R1(1191, true),
     MC1_19_R2(1192, true), MC1_19_R3(1193, true), MC1_20_R1(1201, true), MC1_20_R2(1202, true), MC1_20_R3(1203, true),
-    MC1_20_R4(1204, true), MC1_21_R1(1211, true), MC1_21_R2(1212, true);
+    MC1_20_R4(1204, true), MC1_21_R1(1211, true), MC1_21_R2(1212, true), MC1_21_R3(1213, true);
 
     private static MinecraftVersion version;
     private static Boolean hasGsonSupport;
@@ -39,7 +39,7 @@ public enum MinecraftVersion {
     private static Logger logger = Logger.getLogger("NBTAPI");
 
     // NBT-API Version
-    protected static final String VERSION = "2.14.0";
+    protected static final String VERSION = "2.14.1";
 
     private final int versionId;
     private final boolean mojangMapping;
@@ -59,6 +59,7 @@ public enum MinecraftVersion {
             this.put("1.21.1", MC1_21_R1);
             this.put("1.21.2", MC1_21_R2);
             this.put("1.21.3", MC1_21_R2);
+            this.put("1.21.4", MC1_21_R3);
         }
     };
 

item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/utils/NBTJsonUtil.java

@@ -0,0 +1,41 @@
+package de.tr7zw.changeme.nbtapi.utils;
+
+import java.util.Optional;
+
+import org.bukkit.inventory.ItemStack;
+
+import com.google.gson.JsonElement;
+import com.mojang.serialization.Codec;
+import com.mojang.serialization.DataResult;
+import com.mojang.serialization.JsonOps;
+
+import de.tr7zw.changeme.nbtapi.NbtApiException;
+import de.tr7zw.changeme.nbtapi.utils.nmsmappings.ClassWrapper;
+import de.tr7zw.changeme.nbtapi.utils.nmsmappings.MojangToMapping;
+import de.tr7zw.changeme.nbtapi.utils.nmsmappings.ReflectionMethod;
+
+public class NBTJsonUtil {
+
+    /**
+     * 1.20.3+ only. Used to convert items into Json, used in Chat Hover Components.
+     * 
+     * @param itemStack
+     * @return
+     * @throws NbtApiException
+     */
+    @SuppressWarnings("unchecked")
+    public static JsonElement itemStackToJson(ItemStack itemStack) {
+        try {
+            Codec<Object> itemStackCodec = (Codec<Object>) ClassWrapper.NMS_ITEMSTACK.getClazz()
+                    .getField(MojangToMapping.getMapping().get("net.minecraft.world.item.ItemStack#CODEC")).get(null);
+            Object stack = ReflectionMethod.ITEMSTACK_NMSCOPY.run(null, itemStack);
+            DataResult<JsonElement> result = itemStackCodec.encode(stack, JsonOps.INSTANCE,
+                    JsonOps.INSTANCE.emptyMap());
+            Optional<JsonElement> opt = (Optional<JsonElement>) result.getClass().getMethod("result").invoke(result);
+            return opt.orElse(null);
+        } catch (Exception ex) {
+            throw new NbtApiException("Error trying to get Json of an ItemStack.", ex);
+        }
+    }
+
+}

item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/utils/nmsmappings/MojangToMapping.java

@@ -145,6 +145,7 @@ public class MojangToMapping {
             put("net.minecraft.world.entity.Entity#getEncodeId()", "bw");
             put("net.minecraft.world.level.block.entity.BlockEntity#saveWithId()", "p");
             put("net.minecraft.world.level.block.entity.BlockEntity#getBlockState()", "r");
+            put("net.minecraft.world.item.ItemStack#CODEC", "a");
         }
 
     };
@@ -169,6 +170,7 @@ public class MojangToMapping {
             put("net.minecraft.util.datafix.DataFixers#getDataFixer()", "a");
             put("net.minecraft.util.datafix.fixes.References#ITEM_STACK", "t");
             put("net.minecraft.nbt.NbtOps#INSTANCE", "a");
+            put("net.minecraft.world.item.ItemStack#CODEC", "b");
         }
 
     };
@@ -193,14 +195,26 @@ public class MojangToMapping {
             put("net.minecraft.server.MinecraftServer#registryAccess()", "ba");
             put("net.minecraft.world.entity.Entity#getEncodeId()", "bK");
             put("net.minecraft.world.level.block.entity.BlockEntity#getBlockState()", "m");
+            put("net.minecraft.world.item.ItemStack#CODEC", "a");
         }
 
     };
 
+    @SuppressWarnings("serial")
+    private static Map<String, String> MC1_21R3 = new HashMap<String, String>() {
 
+        {
+            putAll(MC1_21R2);
+
+            put("net.minecraft.world.item.component.CustomData#copyTag()", "d");
+        }
+
+    };
 
     public static Map<String, String> getMapping() {
         switch (MinecraftVersion.getVersion()) {
+        case MC1_21_R3:
+            return MC1_21R3;
         case MC1_21_R2:
             return MC1_21R2;
         case MC1_21_R1:

item-nbt-plugin/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>de.tr7zw</groupId>
     <artifactId>item-nbt-parent</artifactId>
-    <version>2.14.0</version>
+    <version>2.14.1</version>
   </parent>
   <artifactId>item-nbt-api-plugin</artifactId>
   <packaging>jar</packaging>
@@ -12,7 +12,7 @@
     <dependency>
       <groupId>de.tr7zw</groupId>
       <artifactId>item-nbt-api</artifactId>
-      <version>2.14.0</version>
+      <version>2.14.1</version>
       <scope>compile</scope>
     </dependency>
     <dependency>

item-nbt-plugin/src/main/java/de/tr7zw/nbtapi/plugin/NBTAPI.java

@@ -41,6 +41,7 @@ import de.tr7zw.nbtapi.plugin.tests.items.DirectApplyMetaTest;
 import de.tr7zw.nbtapi.plugin.tests.items.DirectApplyTest;
 import de.tr7zw.nbtapi.plugin.tests.items.EmptyItemTest;
 import de.tr7zw.nbtapi.plugin.tests.items.ItemConversionTest;
+import de.tr7zw.nbtapi.plugin.tests.items.ItemJsonTest;
 import de.tr7zw.nbtapi.plugin.tests.items.ItemMergingTest;
 import de.tr7zw.nbtapi.plugin.tests.items.ItemStackConversionTest;
 import de.tr7zw.nbtapi.plugin.tests.items.LegacyItemTest;
@@ -111,6 +112,7 @@ public class NBTAPI extends JavaPlugin {
         }
         if (MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_20_R4)) {
             apiTests.add(new LegacyItemTest());
+            apiTests.add(new ItemJsonTest());
         }
         apiTests.add(new ComponentsTest());
         apiTests.add(new EmptyItemTest());

item-nbt-plugin/src/main/java/de/tr7zw/nbtapi/plugin/tests/items/ItemJsonTest.java

@@ -0,0 +1,28 @@
+package de.tr7zw.nbtapi.plugin.tests.items;
+
+import org.bukkit.Material;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.ItemMeta;
+
+import com.google.gson.JsonElement;
+
+import de.tr7zw.changeme.nbtapi.NbtApiException;
+import de.tr7zw.changeme.nbtapi.utils.NBTJsonUtil;
+import de.tr7zw.nbtapi.plugin.tests.Test;
+
+public class ItemJsonTest implements Test {
+
+    @Override
+    public void test() throws Exception {
+        ItemStack item = new ItemStack(Material.STONE);
+        ItemMeta meta = item.getItemMeta();
+        meta.setDisplayName("test");
+        meta.setUnbreakable(true);
+        item.setItemMeta(meta);
+        JsonElement elem = NBTJsonUtil.itemStackToJson(item);
+        if (elem == null) {
+            throw new NbtApiException("Getting the Json didn't work correctly! " + item);
+        }
+    }
+
+}

mappings-parser/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>de.tr7zw</groupId>
     <artifactId>item-nbt-parent</artifactId>
-    <version>2.14.0</version>
+    <version>2.14.1</version>
   </parent>
   <artifactId>mappings-parser</artifactId>
   <packaging>jar</packaging>
@@ -12,7 +12,7 @@
     <dependency>
       <groupId>de.tr7zw</groupId>
       <artifactId>item-nbt-api</artifactId>
-      <version>2.14.0</version>
+      <version>2.14.1</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

mappings-parser/src/main/java/dev/tr7zw/mappingsparser/MappingsParser.java

@@ -24,7 +24,7 @@ public class MappingsParser {
     public static StringBuilder builder = new StringBuilder();
 
     public static void main(String[] args) throws IOException {
-        File input = new File("minecraft_server.1.21.2.txt");
+        File input = new File("minecraft_server.1.21.4.txt");
         List<String> lines = Files.readAllLines(input.toPath());
 
         Map<String, ClassWrapper> classes = new HashMap<>();

nbt-data-api/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.tr7zw</groupId>
     <artifactId>item-nbt-parent</artifactId>
-    <version>2.14.0</version>
+    <version>2.14.1</version>
   </parent>
 
   <artifactId>nbt-data-api</artifactId>
@@ -14,7 +14,7 @@
     <dependency>
       <groupId>de.tr7zw</groupId>
       <artifactId>item-nbt-api</artifactId>
-      <version>2.14.0</version>
+      <version>2.14.1</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

nbt-injector/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>de.tr7zw</groupId>
     <artifactId>item-nbt-parent</artifactId>
-    <version>2.14.0</version>
+    <version>2.14.1</version>
   </parent>
   <artifactId>nbt-injector</artifactId>
   <packaging>jar</packaging>
@@ -12,7 +12,7 @@
     <dependency>
       <groupId>de.tr7zw</groupId>
       <artifactId>item-nbt-api</artifactId>
-      <version>2.14.0</version>
+      <version>2.14.1</version>
       <scope>compile</scope>
     </dependency>
     <dependency>

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>de.tr7zw</groupId>
   <artifactId>item-nbt-parent</artifactId>
-  <version>2.14.0</version>
+  <version>2.14.1</version>
   <packaging>pom</packaging>
   <inceptionYear>2015</inceptionYear>
   <organization>
@@ -110,7 +110,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.10.1</version>
+        <version>3.11.1</version>
         <configuration>
           <source>8</source>
         </configuration>

spigot.bb

@@ -112,7 +112,7 @@ Just use the Plugin as Maven dependency and remember to add "NBTAPI" as dependen
 <dependency>
   <groupId>de.tr7zw</groupId>
   <artifactId>item-nbt-api-plugin</artifactId>
-  <version>2.14.0</version>
+  <version>2.14.1</version>
 </dependency>
 [/CODE]
 [/SPOILER]
@@ -122,7 +122,7 @@ Using this method the API gets copied into your plugin. Server owners don't have
 <dependency>
   <groupId>de.tr7zw</groupId>
   <artifactId>item-nbt-api</artifactId>
-  <version>2.14.0</version>
+  <version>2.14.1</version>
 </dependency>
 ...
     <plugins>

wiki/Plugins.md

@@ -5,6 +5,7 @@
 - [CommandAPI](https://github.com/JorelAli/CommandAPI)
 - [SkBee](https://github.com/ShaneBeee/SkBee/)
 - [Monumenta](https://github.com/TeamMonumenta/monumenta-plugins-public/)
+- [SummonFriendlyMobs](https://github.com/ArmyFury/SummonFriendlyMobs)
 
 ___
 

wiki/Using-the-NBT-API.md

@@ -2,7 +2,7 @@
 
 ### Basics overview
 
-Most of the things are exposed inside the [NBT](https://tr7zw.github.io/Item-NBT-API/v2-api/de/tr7zw/changeme/nbtapi/NBT.html) class. Make sure to explore the Javadoc, or ask your IDE for suggestions!
+Most of the things are exposed inside the [NBT](https://tr7zw.github.io/Item-NBT-API/v2-api/de/tr7zw/changeme/nbtapi/NBT.html) class. Your specific use-case might not yet be covered by the wiki, so make sure to explore the [Javadoc](https://tr7zw.github.io/Item-NBT-API/v2-api/), or ask your IDE for suggestions!
 
 #### Basic getting and setting of data
 
@@ -115,9 +115,13 @@ nbt.resolveOrDefault("list_key[-1]", "fallback_value"); // Get the last value in
 
 
 // NBT compound lists
+// Get the list (will create it if needed)
 ReadWriteNBTCompoundList nbtList = nbt.getOrCreateCompound("foo").getCompoundList("other_key");
-ReadWriteNBT nbtListEntry = addCompound();
+// Add new compound to the list
+ReadWriteNBT nbtListEntry = nbtList.addCompound();
 nbtListEntry.setBoolean("bar", true);
+// Add existing nbt compound to the list
+ReadWriteNBT otherNbtListEntry = nbtList.addCompound(NBT.parseNBT("{foo_bar:1b}"));
 
 // You can fetch compounds in lists
 nbt.resolveCompound("foo.other_key[0]"); // Get the first compound in list, or null
@@ -162,6 +166,27 @@ int someValue = NBT.modify(itemStack, nbt -> {
 
 > [!WARNING]
 > Never mix the usage of ItemMeta and NBT.
+> Setting ItemMeta will override any changes made to item's nbt.
+
+```java
+// WRONG, do not do this!
+ItemMeta meta = itemStack.getItemMeta();
+meta.setDisplayName("Modified!");
+NBT.modify(itemStack, nbt -> nbt.setBoolean("modified", true));
+itemStack.setItemMeta(meta); // Will undo all changes to nbt!
+
+
+// Correct, both ItemMeta and NBT will be applied
+NBT.modify(itemStack, nbt -> nbt.setBoolean("modified", true));
+// Taking ItemMeta snapshot after changes to nbt
+ItemMeta meta = itemStack.getItemMeta();
+meta.setDisplayName("Modified!");
+itemStack.setItemMeta(meta);
+// If making any further changes with NBT & ItemMeta,
+// re-take the item's ItemMeta after changing the nbt!
+```
+
+Alternatively, you may safely modify ItemMeta inside the NBT scope:
 
 ```java
 // Updating ItemMeta using NBT
@@ -184,6 +209,15 @@ NBT.modify(itemStack, nbt -> {
 
 ```java
 // NOTE: This code is only for 1.20.5+!
+
+// Only reading vanilla data
+NBT.getComponents(item, nbt -> {
+    if (nbt.hasTag("minecraft:custom_name")) {
+        String customName = nbt.getString("minecraft:custom_name");
+    }
+});
+
+// Modifying vanilla data
 NBT.modifyComponents(item, nbt -> {
     nbt.setString("minecraft:custom_name", "{\"extra\":[\"foobar\"],\"text\":\"\"}");
 });
@@ -271,20 +305,26 @@ Moreover, since the data is stored inside a Chunk, this will increase the chunk'
 
 ### NBT files
 
-```java
-// Creating nbt file
-// NBTFile will automatically create the file if it does not exist
-NBTFile file = new NBTFile(new File("directory"), "test.nbt"); // Will be created at ./directory/test.nbt
-// Setting data 
-file.setString("foo", "bar");
-// Saving file
-file.save();
+NBTFileHandle allows working with nbt files.
 
-// Alternatively, you may use helper methods in NBTFile class
-// To read the file without creating it if does not exist:
-ReadWriteNBT nbt = NBTFile.readFrom(file);
-// To save nbt to the file:
-NBTFile.saveTo(file, nbt);
+```java
+// Will automatically create the file if it does not exist
+NBTFileHandle nbtFile = NBT.getFileHandle(new File("directory", "test.nbt"));
+// Setting data 
+nbtFile.setString("foo", "bar");
+// Saving the file after applying changes
+nbtFile.save();
+```
+
+Alternatively, you may read the nbt file without maintaining the link to it.
+Unlike NBTFileHandle, the file won't be automatically created if it does not exist.
+
+```java
+File file = new File("directory", "test.nbt");
+// Reading data from file (will return an empty compound if the file does not exist)
+ReadWriteNBT nbt = NBT.readFile(file);
+// Saving nbt to file
+NBT.writeFile(file, nbt);
 ```
 
 ### Converting Minecraft Objects to NBT and Strings