Jackson NBT Data Format
Implements Mojang's NBT format in jackson.
Usage
Using this format works just like regular jackson, but with the ObjectMapper replaced with NBTMapper.
Java
public class Example {
public static void main(String[] args) {
// creating the mapper
NBTMapper mapper = new NBTMapper();
// serialize
byte[] bytes = mapper.writeValueAsBytes(value);
// deserialize
MyType value = mapper.readValue(bytes, MyType.class);
}
}
Kotlin
// creating the mapper
val mapper = NBTMapper()
mapper.registerKotlinModule()
// serialize
val bytes = mapper.writeValueAsBytes(value)
// deserialize
val value = mapper.readValue<MyType>(bytes)
The functions
registerKotlinModule()andreadValue<T>(...)are from the kotlin module, which we highly recommend for working with jackson in kotlin.
Dependency Information
You can find the latest version and the corresponding dependency snippets here.
Big Test
Something that must not be absent from any decent NBT library, the "bigtest".
This is a mapping that can serialize and deserialize the "bigtest" file:
class BigTest(
val shortTest: Short,
val longTest: Long,
val byteTest: Byte,
@JsonProperty("byteArrayTest (the first 1000 values of (n*n*255+n*7)%100, starting with n=0 (0, 62, 34, 16, 8, ...))")
val byteArrayTest: ByteArray,
@JsonProperty("listTest (long)")
val longListTest: List<Long>,
val floatTest: Float,
val doubleTest: Double,
val intTest: Int,
@JsonProperty("listTest (compound)")
val compoundListTest: List<CompoundListTest>,
@JsonProperty("nested compound test")
val nestedCompounds: Map<String, NestedCompound>,
val stringTest: String,
) {
class CompoundListTest(
@JsonProperty("created-on")
val createdOn: Long,
val name: String,
)
class NestedCompound(
val name: String,
val value: Float,
)
}
And this is how you can create the exact value:
BigTest(
32767,
9223372036854775807,
127,
ByteArray(1000) { ((it * it * 255 + it * 7) % 100).toByte() },
listOf(11L, 12L, 13L, 14L, 15L),
0.49823147f,
0.4931287132182315,
2147483647,
listOf(
BigTest.CompoundListTest(1264099775885, "Compound tag #0"),
BigTest.CompoundListTest(1264099775885, "Compound tag #1"),
),
buildMap {
put("egg", BigTest.NestedCompound("Eggbert", 0.5f))
put("ham", BigTest.NestedCompound("Hampus", 0.75f))
},
"HELLO WORLD THIS IS A TEST STRING ÅÄÖ!",
)
Note: The root tag of the original "bigtest" file is named
Level. Parsing this is should work, however the generator will write the root tag name as an empty string, as that is how minecraft also behaves.
69 Nov 9, 2022
11 Nov 15, 2022
15 May 28, 2021
48 Dec 15, 2022
187 Nov 10, 2022
8 Nov 8, 2022
36 Aug 25, 2022
11 Oct 16, 2021
171 Oct 31, 2022
76 Oct 26, 2022
7 Dec 15, 2022
8 Jun 11, 2022
7.9k Dec 31, 2022
139 Dec 21, 2022
41 Dec 21, 2022
12 Dec 27, 2022
3 Dec 13, 2021
331 Nov 20, 2022
161 Nov 25, 2022