Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
djfun committed Dec 17, 2012
0 parents commit f551ca2
Show file tree
Hide file tree
Showing 9 changed files with 1,400 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/*
45 changes: 45 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
==================
node-nbt is licensed under the MIT License
==================

Copyright (c) 2012 Martin Kaistra

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall
be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS IN THE SOFTWARE.

===================
===================
External libraries:

goog/long.js: https://closure-library.googlecode.com/svn/docs/closure_goog_math_long.js.html

Copyright 2009 The Closure Library Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS-IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
node-nbt
=============

[nodejs](http://nodejs.org) library for reading and writing NBT files

How to use
---------
Here is a simple example how you can read a gzipped NBT file into a Javascript object.

var NbtReader = require('./nbt').NbtReader;

var fs = require('fs');
fs.readFile('a_nbt_file.dat', function(err, data) {
zlib.gunzip(data, function(err, buffer) {
if (!err) {
var d = NbtReader.readTag(buffer);
d = NbtReader.removeBufferKey(d);
} else {
console.log(err);
}
});
});

If you want to print that Javascript object to the console you can use the `NbtReader.printAscii(d);` function.

TODO: More examples on how to write NBT files with `NbtWriter`.



Tests
-----
In the `test` folder there are some unit tests that can be run with [nodeunit](https://github.com/caolan/nodeunit).
Loading

0 comments on commit f551ca2

Please sign in to comment.