TypeScript icon, indicating that this package has built-in type declarations

3.0.2 • Public • Published

Nbt Module

npm version Downloads Install size npm Build Status

Provide function to read NBT binary format to json.


Read and Write NBT

You can simply deserialize/serialize nbt.

import { serialize, deserialize } from "@xmcl/nbt";
const fileData: Buffer;
// compressed = undefined will not perform compress algorithm
// compressed = true will use gzip algorithm
const compressed: true | "gzip" | "deflate" | undefined;
const readed: any = await deserialize(fileData, { compressed });
// The deserialize return object contain NBTPrototype property which define its nbt type
// After you do the modification on it, you can serialize it back to NBT
const buf: Buffer = await serialize(readed, { compressed });

You can use class with annotation (decorator) to serialize/deserialize the type consistently.

Suppose you are reading the servers.dat. You can have:

import { serialize, deserialize, TagType } from "@xmcl/nbt";

class ServerInfo {
    icon: string = "";
    ip: string = "";
    name: string = "";
    acceptTextures: number = 0;

class Servers {
    servers: ServerInfo[] = []

// read
// explict tell the function to deserialize into the type Servers
const servers = await deserialize(data, { type: Servers });
const infos: ServerInfo[] = servers.servers;

// write
const servers: Servers;
const binary = await serialize(servers);

Package Sidebar


npm i @xmcl/nbt

Weekly Downloads






Unpacked Size

455 kB

Total Files


Last publish


  • ci010