README.md

mcmapimg

A command-line utility, web application, and Python library to convert Minecraft in-game maps to image files.

Contents

1. Dependencies
2. Installation
3. Usage

Dependencies

Required

• Python 2.7 or 3
• Python Imaging Library
• PyNBT

Optional

• A CGI-capable web server (to run the web interface)
• Git (to install from GitHub)

Installation

1. Clone this repository into an empty directory:

   git clone https://github.com/joodicator/mcmapimg
   cd mcmapimg
   

Usage

There are three ways to use this tool:

1. Run mcmapimg.py as a command-line program. See the output of:

   ./mcmapimg.py --help
   

2. Using the web interface: make accessible by a web server index.htm and map.cgi - the latter of which is an executable Python script and should be run as a CGI program by the web server - for example, under http://localhost/mcmapimg; then navigate to this URL and follow the instructions there.

3. As a library directly from Python:

   python
   >>> import mcmapimg
   >>> help(mcmapimg)