summaryrefslogtreecommitdiff
path: root/README.markdown
blob: 04952321c36daa90da1376ab20a72ebf12b1ed12 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# gomcmap

A library for reading and modifying Minecraft maps.

## Install

	go get github.com/silvasur/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

* Recalculating light data.
* Reading and modifying level.dat and other files (currently only the region files are used).
* Test compatibility with older versions of Minecraft.