Installation

  • Download and install the required .NET Runtime from the downloads page
  • Download the latest uNmINeD-cli ZIP package from the downloads page, and extract all contents into any empty folder. It’s ready to run.

Linux users: use chmod +x unmined-cli to make unmined-cli executable.

Overview

uNmINeD-cli is a command line application. You have to open a command line prompt and type commands to use it.

How to open a command line prompt in Windows:

  • Find the folder where you have extracted the downloaded ZIP. It’s something like “unmined-cli_0.12.4-dev_net472-win7”, and there are a bunch of program files in it.
  • Right click on the folder while holding down the Shift key on keyboard to open an extended context menu.
  • Win7: Click on the “Open command window here” command.
  • Win10: Click on the “Open PowerShell window here” command, then type “cmd” without the quotes, and hit Return.
  • Now you have a command prompt in the folder where you have unmined-cli.

Creating a single image

To render a single image of your Minecraft world, use the following command:

unmined-cli image render --trim --world="%APPDATA%\.minecraft\saves\New World" --output="%USERPROFILE%\Desktop\MyMap.png"
  • Change the --world parameter to the path of your Minecraft world.
  • Change the --output parameter to the output image file name.

The --trim parameter is optional. When used, uNmINeD will trim the sorrounding transparent pixels from the output image.

Note that the size of the rendered image is limited by image formats and available system memory. This can lead to errors when rendering large worlds.

Creating a web based map

To create a web based map of your Minecraft world, use the following command:

unmined-cli web render --world="%APPDATA%\.minecraft\saves\New World" --output="%USERPROFILE%\Desktop\MyMap"
  • Change the --world parameter to the path of your Minecraft world.
  • Change the --output parameter to the output folder (should be an empty folder).

Open the generated unmined.index.html file in the output folder to view the map using a web browser.

Rendering giant worlds can take minutes or hours. The process can be interrupted by pressing Ctrl+C or closing the window. You can run the same command again to continue an unfinished process, or update a generated map to the current state of your world. This will render changed and new regions only.

Close Menu