by Plethora777

MCPE Viz is a command-line tool that parses Minecraft Pocket Edition (MCPE) world files. It creates overview images from the world files, and reports lots of details on your world.

It can also create a powerful Google Maps-like Web App for viewing your world.

Additional Features:

• Create a powerful Google Maps-like web app viewer for your world.

• Create images of individual layers of your world

• Create an image of the biomes in your world

• Create an image of block light in your world (kind of like an image from space at night)

• Create an image of the block height in your world (kind of like a topographic map)

• Create an image of the grass color in your world (it's pretty interesting!)

• Create movies of all layers from bedrock to build limit (ffmpeg required)

• Dump a huge amount of info about your world including:

  • Dumps detailed information about all mobs, players and items in your world
  • For each 16x16 block chunk:
    • Top blocks (block type, block data, biome)
    • Histogram of all blocks in the chunk
    • And more...
  • For each world type (e.g. overworld, nether):
    • Histogram of biomes (per-block column)

Here are example images: http://imgur.com/a/YiIWe

Here's an example of movie output: https://www.youtube.com/watch?v=kBCOrctFIGM

• Download the zip file: https://github.com/Plethora777/mcpe_viz/archive/master.zip

• Unzip that file.

• Inside you will find "mcpe_viz.win32.zip" (windows 32-bit) and "mcpe_viz.win64.zip" (windows 64-bit). Choose one that is appropriate for your system. Unzip it.

• Inside you will find mcpe_viz.exe

• Open a command prompt and run it something like this:

mcpe_viz.exe --db path-to-your-world-file-dir/ --out out1 --html-most

Note: Replace "path-to-your-world-file-dir/" with the actual directory which contains your world files -- it wants the directory that has level.dat in it.

DO NOT RUN THIS ON YOUR ORIGINAL MCPE DATA FILES; MAKE A BACKUP COPY OF YOUR DATA AND RUN THIS AGAINST THAT COPY ONLY!

This will produce a bunch of image files and "out1.html". Open "out1.html" in your browser.

You can create a browser-based viewer for your world files. It will allow you to pan, zoom and switch between the different images. It's pretty spiffy!

To make a quick viewer (with all regular images, but without indvidual layers), do something like this:

> ./mcpe_viz --db ./mcpe/another1/ --out ./mcpe/output/out1 --html-most

To make a complete viewer (with all images and all layers), do something like this:

> ./mcpe_viz --db ./mcpe/another1/ --out ./mcpe/output/out1 --html-all

This will create a LOT of images -- individual images for each layer of the overworld and nether, as well as all the regular images. It will also create "./mcpe/output/out1.html". Load this file in your browser and you will have an Openlayers-based viewer for your world! Openlayers (http://openlayers.org/) is a powerful javascript library for mapping.

Web App Usage Notes:

• Zoom in with double click or press the "+" button (upper left)
• Zoom out with shift-double click or press the "-" button (upper left)
• Move with click and drag
• Rotate with shift-alt click and drag
• Your mouse position is shown in the upper right in world coordinates and image coordinates
• You can go full-screen (button under mouse position window)
• Tool bar at the bottom of the screen:
  • Choose Overworld or Nether
  • Scroll through the layers from 0 (bedrock) to 127 (build limit)
  • Choose Overview, Biome etc
  • Show Mobs and Objects -- click on an entry and the map will be updated with labeled points. You can toggle on as many different types as you like. Click on the points or labels to get more info on the item. Note that labels are not drawn when you are zoomed out.
  • Enable elevation overlay (shaded relief)
  • Enable chunk grid overlay

If you are loading the web app from a local file -- that is, not accessing it from a web server -- your browser may impose restrictions on image loading and access to image pixels which makes it very difficult for the web app to deliver the best experience. Currently, Firefox appears to be the browser most willing to play nicely. The web app will let you know if you are impacted by this issue. For example, on Chrome, you will not see block information on mouse over, or be able to see the elevation overlay -- both of which are totally cool :)

If you are running Firefox or serving the files from a web server, you can make the web app load a little bit faster by adding the option "--no-force-geojson" to your command line. This prevents mcpe_viz from using a workaround for the above issue.

DO NOT RUN THIS ON YOUR ORIGINAL MCPE DATA FILES

DO NOT RUN THIS ON YOUR ONLY BACKUP OF MCPE DATA FILES

MAKE A COPY OF YOUR DATA AND RUN THIS AGAINST THAT COPY ONLY!

See "./mcpe_viz --help" for the most up-to-date usage info

Here's an example invocation:

> ./mcpe_viz --grid --db ./mcpe/another1/ --out ./mcpe/output/out1

This will read the leveldb from "./mcpe/another1" and name output files starting with "./mcpe/output/out1", and it will draw chunk boundaries on your output image. This also dumps the voluminous output to "out1.log". The log file has a ton of interesting information about your world. "grep" is your friend.

Please note that --db expects the directory which contains "level.dat".

You can copy mcpe_viz.cfg to ~/.mcpe_viz/mcpe_viz.cfg and then edit that file to customize the way mcpe_viz works.

You can copy mcpe_viz.xml to ~/.mcpe_viz/mcpe_viz.xml and then edit that file to set custom colors for blocks and biomes.

If you just want to run the software on windows, see above :) If you would like to compile it for Linux (or Windows), read on.

• You know how to compile things :)
• Mojang's LevelDB from github (see below) (https://github.com/Mojang/leveldb-mcpe.git)
• libnbt++ from github (see below) (https://github.com/ljfa-ag/libnbtplusplus.git)
• [Optional] ffmpeg for creating movies

The code uses Mojang's modified version of LevelDB. Here's how to compile it (from the top dir of mcpe_viz):

> git clone https://github.com/Mojang/leveldb-mcpe.git
> chdir leveldb-mcpe
> make

If all goes well, there will be a "libleveldb.a" in leveldb-mcpe/

To get it to compile on Fedora, I found that I needed to do this from leveldb-mcpe/:

> ln -s /usr/include include/zlib

If you have compile errors, check the README* files from leveldb-mcpe for prerequisites

The code uses libnbt++. Here's how to compile it (from the top dir of mcpe_viz):

> git clone https://github.com/ljfa-ag/libnbtplusplus.git
> chdir libnbtplusplus
> mkdir build
> chdir build
> cmake .. -DNBT_BUILD_TESTS=OFF
> make

If all goes well, there will be a "libnbt++.a" in libnbtplusplus/build/

If you have compile errors, check the README* files from libnbtplusplus for prerequisites

From the top directory of mcpe_viz:

> make

If all goes well, you will have "mcpe_viz" in build/

There is lots still todo. Search on 'todo' in the code to see what needs attention.