diff options
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..3404f41 --- /dev/null +++ b/README.markdown @@ -0,0 +1,27 @@ +# gomcmap + +A library for reading and modifying Minecraft maps. + +## Install + + go get github.com/kch42/gomcmap/mcmap + +## Examples + +See `mcmap/examples` + +## Compatibility + +Currently only the Anvil map format is supported. Tested with Minecraft 1.6.2, will probably work with older versions too, but I haven't tested it. + +## WARNING + +Although I tested the library with some maps, I can't guarantee that everything always works (especially if you use mods in your Minecraft installation). So make a backup of your maps, just in case! + +## Wishlist / TODO + +* Adding / removing chunks. +* Recalculating light data. +* Recalculating height map. +* Reading and modifying level.dat and other files (currently only the region files are used). +* Test compatibility with older versions of Minecraft. |