gaviny82/nbttoolkit

A high performance library for reading and writing Minecraft NBT formats

NbtToolkit

NbtToolkit is a high performance C# library for processing Minecraft NBT files and strings.

Features and roadmap

• Read/Write NBT binary data.
• Read/Write compressed NBT formats.
• Read/Write SNBT (planned)
• Serialization (planned)

nbttoolkit's Issues

Detect the compression type of NBT files automatically

The compression type of a NBT file can be determined by the first byte:

• 0x78: ZLib compression
• 0x1F: GZip compression
• 0x09: TAG_List root tag (no compression, bedrock only)
• 0x0A: TAG_Compound root tag (no compression)
• Other: invalid NBT file

Reading level.dat taking too much time for large files on particular platforms

It has been reported that reading some large level.dat files takes longer time than expected.

• This issue can only be reproduced on some platforms.

Sample 1
level.zip
CPU: i7-11800H
Disk: NVMe PC711 NVMe SK hynix 1TB

Sample 2
level.zip
CPU: i7-14700KF
Disk: SSD

Improve NBT file format support for TAG_List root tag and TAG_Compound root tag with other names

From Minecraft Wiki:

All NBT files created by Minecraft have either a compound or sometimes a list‌[Bedrock Edition only] as the root tag, this tag has a name but is often the empty string.
Changes needed:

• Support reading the root tag as a TAG_List
• Allow TAG_Compound root tag with any name

Unit tests for NbtBinaryReader/Writer and NbtReader/Writer