No description, website, or topics provided.
Perl
Latest commit 1dc8e05 Dec 16, 2016 @cgutteridge committed on GitHub Merge pull request #15 from ldodds/improve-readme
Improve README

README.md

Geocraft Minecraft Map Generator

Generate minecraft maps of real locations using UK LIDAR data (laser scans of terrain) and information from OpenStreetMap.

Installation

This software uses Perl and is dependent on the following modules:

  • Archive::Zip
  • Image::Magick

You'll need to ensure those are installed before using the software.

Generating a World

The generate-world command is used to create your minecraft world. It provides a number of options for customising the location of the world and how it is generated.

Internet access is essential at all times whilst generating a world as it will be downloading lots of data.

The following generates a minecraft world called "Highfield" which will be stored in the /saves/subdirectory. It's centred on a postcode in Southampton and will be 1km square (1000 blocks wide, 500 blocks either side of the central point)

./generate-world --postcode SO171BJ --size 1000 Highfield

It's recommended that while you are testing that you generate smaller worlds. Obviously the larger the map, the longer it will take to generate.

You may find it handy to symlink the /saves/ directory to your minecraft saves location. You can also generate the map in a different location using the --saves option:

./generate-world --saves /path/to/.minecraft/saves --postcode SO171BJ --size 1000 Highfield

If a world of the given name already exists then the script will refuse to overwrite it. Use the --replace option to force overwriting of an existing world. Again, useful whilst testing your configuration:

./generate-world --replace --postcode SO171BJ --size 1000 Highfield

Instead of a postcode you can specify the central point of the map using a specific location. You can use either an easting and northing, or a latitude and longitude. By default the script assumes you're providing easting and northing, but the --ll allows you to switch:

./generate-world --centre 375046,164145 --size 1000 Highfield
./generate-world --ll --centre 51.375801,-2.3599039 --size 1000 Highfield

The generation of the world can be customised by tweaking the configuration given in the config directory. It's possible to override these to use different configuration files using the --blocks and --colours parameters.

For example in Bath you may want to use sandstone instead of brick for generating buildings. The blocks.winter and blocks.nether configure allow you to generate worlds winter biome or as part of the nether.

The blocks.hollow config generates hollow buildings. It's worth using but takes much longer to generate a world.

Attribution & Copyright

This software is provided under the GPLv3. Please feel free to alter and share it.

This version was written by Christopher Gutteridge at the University of Southampton. (c) 2015 Christopher Gutteridge

LIDAR data (c) Defra under the Open Government License. Map data (c) Open Streetmap Contributors under Creative Commons Attribution ShareAlike License.

Contact Details

Github: https://github.com/cgutteridge/geocraft Facebook: https://www.facebook.com/magic.minecraft.map.maker/

Author contact info: Email: cjg@ecs.soton.ac.uk Twitter: cgutteridge