daanv2 / daanv2.nbt.net

A NBT library for reading and writing nbt files/data, with support for little or big endian

DaanV2-NBT.Net

An NBT library for reading and writing NBT files/data Nuget package

Usage

Read a file

var Compound = NBTReader.ReadFile("Path to file", Endian.Little, NBTCompression.Auto);
var age = Compound.GetChild("Age");

//Retrieve value if you know what type it should be
Int32 item = age.GetValue<Int32>();

//OR
if (age is NBTTagInt a) {
    Assert.IsTrue(a.Value == 256, "Hello set wrong")
}

//OR
if (age.TryGetValue(out Int32 item)) {
    Assert.IsTrue(item == 256, "Hello set wrong")
}

//OR
var item = Compound.GetChild<Int32>("Age");

Writes to a file

ITag Tag;

//Writes the tag to the specified file using GZIP compression and little-endian methods
NBTWriter.WriteFile("Path to file", Tag, NBTCompression.Gzip, Endian.Little);

//Writes the tag to the specified file using no compression and little-endian methods
NBTWriter.WriteFile("Path to file", Tag, Endian.Little);

Building a structure

CompoundBuilder Builder = new CompoundBuilder("Root", 10);
Builder.Add("IsDetermined", true);
Builder.Add("Amount", 5);

ITag = Builder.GetResult();

Installation

Check that the NuGet packages have been downloaded.

Dependencies:

Solved with NuGet

• Zlib
• DaanV2.Essentials.Net

daanv2.nbt.net's Issues

Incomplete Documentation

I was trying to use this library but apparently it lacks sufficient documentation. For example, the NBTReader returns an ITag but how do I go about getting the tags I wrote to the file?

I wrote with this based on what I found:

CompoundBuilder bldNBT = new CompoundBuilder(ROOT);
                bldNBT.Add(ROOT_APP, "title");
                bldNBT.Add(ROOT_MOD, "module");
                bldNBT.Add(ROOT_VER, "1.0.0.0");
                bldNBT.Add(ROOT_USR, System.Security.Principal.WindowsIdentity.GetCurrent().Name);
                bldNBT.Add(ROOT_AUT, 1);
                bldNBT.Add(ROOT_DTC, ticks);
                bldNBT.Add(ROOT_DTM, ticks);
                ITag tag = bldNBT.GetResult();
                NBTWriter.WriteFile(fsScanAuto, tag, NBTCompression.Auto, DaanV2.Binary.Endianness.LittleEndian);

that I hope is correct. But then I am stumped at this part:

ITag obj = NBTReader.ReadFile("filename", Endianness.LitleEndian);

there is no documentation explaining how I retrieve the values I wrote and there is no Intellisense or anything that could shed some light into this stuff. How about updating a Tag value on ITag