NBT.js

By Sijmen Mulder and a host of wonderful contributors.

NBT.js is a JavaScript parser and serializer for NBT archives, for use with Node.js or the browser.

Usage

After var nbt = require('nbt') or <script src="nbt.js"></script>, you can use nbt.parse(data, callback) to convert NBT data into a regular JavaScript object.

var fs = require('fs'),
    nbt = require('nbt');

var data = fs.readFileSync('fixtures/bigtest.nbt.gz');
nbt.parse(data, function(error, data) {
    if (error) { throw error; }

    console.log(data.value.stringTest.value);
    console.log(data.value['nested compound test'].value);
});

If the data is gzipped, it is automatically decompressed first. When running in the browser, window.zlib is required for this to work.

Tag names are copied verbatim, and as some names are not valid JavaScript names, use of the indexer may be required – such as with the nested compound test in the example above.

API documentation

The full documentation generated with JSDoc is available in the docs/ directory and online:

http://sjmulder.github.io/nbt-js/

Development and testing

npm install  # Install development dependencies
make check   # Check code quality with jshint and run tests
make watch   # Automatically runs 'make check' every few seconds
make doc     # Regenerate the documentation in docs/

Copyright

I, the copyright holder of this work, hereby release it into the public domain. This applies worldwide.

In case this is not legally possible: I grant anyone the right to use this work for any purpose, without any conditions, unless such conditions are required by law.