mcmap

- Isometric map visualizer

Original project by Simon Rettberg. All the credit goes to him for the idea and vision.

mcmap

This project is under heavy development, but compatible with newer versions of Minecraft.

Usage

Basic invocation

mcmap  path/to/

The standard save path is different between OSes: - On Linux, it is

$HOME/.minecraft/saves

~/Library/Application\ Support/minecraft/saves

%AppData%\.minecraft\saves

/mnt/c//AppData/Roaming/.minecraft/saves

Native Windows is now supported. Pre-compiled binaries can be downloaded from the releases page. For now, the program can only be used via

terminal

powershell

Options

| Name | Description | |--------------|------------------------------------------| |

-from X Z

-to X Z

-min/max VAL

-file NAME

./output.png

-colors NAME

-nw

-ne

-se

-sw

-marker x z color

x

z

color

red

green

blue

white

-nowater

-nobeacons

-shading

-nether

-end

-dim[ension] [namespace:]id

-mb VAL

-tile VAL

-padding

-h[elp]

-v[erbose]

-dumpcolors

Note: Currently you need both -from and -to to define bounds.

Tips

mcmap

Use

-tile

Use

-tile

Color file format

mcmap

mcmap -dumpcolors

-colors

The accepted format is a

json

namespace:block

Simple block

To define a color for a simple, regular block, provide an entry in a JSON file. The color format is a hexadecimal color code. If the alpha is not specified, it is assumed to be opaque.

"namespace:block": #rrggbbaa (or #rrggbb)

Examples:

{
    "minecraft:dirt":   #7b573b,
    "minecraft:ice":    #7dadff9f, 
    ...
}

Complex block

Some blocks are better looking when drawn in a specific way. To specify that a block has to be drawn differently, you have to provide a

json

"namespace:block": {
    "type":     ,
    "color":    "#rrggbbaa",
    "accent":   "#rrggbbaa" (Optional)
}

The available available block types are:

|Name|Appearance|Accent support| |-|-|-| |

Full

Hide

Clear

Thin

Slab

Stair

Rod

Wire

Head

Plant

UnderwaterPlant

Plant

Fire

Beam

Torch

Ore

Grown

Log

NOTE: Waterlogged blocks will be rendered within water instead of air by default according to their blockstates. However, sea-grass and kelp are hardcoded to be underwater and their blockstates won't reflect this, so they have to be defined as

UnderwaterPlants

Examples:

{
    "minecraft:dirt":   "#7b573b",  // Full block with solid color

"minecraft:grass_block": {
    "type":     "Grown",        // Use a special block type
    "accent":   "#4c7a40",      // Accent supported for `Grown`
    "color":    "#7b573b"
},

"minecraft:water": {
    "type": "Clear"
    "color": "#0734c832",       // Transparency enabled
},
}

Compilation

mcmap

PNG

zlib

gcc

gcc

clang

CMake

Linux

Getting the libraries depends on your distribution:

• Ubuntu:

  apt update && apt install git make g++ libpng-dev cmake

  ;
• Archlinux:

  pacman -S --needed git gcc make libpng cmake

  .

Then get the code and compile:

git clone http://github.com/spoutn1k/mcmap
cd mcmap
cmake .
make -j

macOS

In an Apple environment, you need a developer toolkit recent enough, with the version of

g++ --version

Using

brew

brew install libpng libomp
git clone http://github.com/spoutn1k/mcmap
cd mcmap
cmake .
make -j

Windows

mcmap

libpng

zlib

Qt

You can also download and set up Ubuntu on windows then the steps are the same as Linux/Ubuntu.

Troubleshooting

Compilation fails

Check

g++ --version

g++-Y

CXX=g++-Y make

Compilation fails complaining about OMP something

Try compiling with

OPENMP=NOTHXM8 make

Output has lines in the ocean

This is due to the merging algorithm. Try increasing the tile size with the

-tile

Full