minecraft.js

NOTE: This is in its early stages, and not much of it is functional. If you want to use it, you may either help me or wait for an indefinite amount of time. All contributions are welcome, so fork this and give me some pull requests.

What is this?

minecraft.js is a library for Minecraft written in javascript. It contains classes which represent data seen in Minecraft, ways to (de)serialize map data, and Minecraft network code. It could possibly be used to make a server that runs in node.js, a HTML5 map viewer/editor, etc. I aim for it to be faster than the official Mojang code.

A browser-compatible version of this library will be made eventually. That will be easy if we can get/make code that follows the node API.

What still needs to be done?

• NBT serialization/deserialization to/from Buffers
• Use a test suite
• Document all the things!

File Organization

• lib contains the built minecraft.js module.
• src contains the unbuilt source (edit stuff here).
• test will contain the test suite, once I get around to making it.
• make is a bash makefile script for building minecraft.js. Use the make command to build (outputs to the lib directory).
• README.md is the readme (this file).
• package.json is the npm package metadata.

Conventions and Style

• For all coordinates, +X is east, +Y is up, and +Z is south.
• Names and terms are the same as in official Mojang code (chunk, region, etc.). However, names are changed to a uniform convention when possible.
• I try to follow the Google javascript style guidelines as much as possible

Building

Just hit make, and the script should concatenate the files to lib/minecraft.js.