Go to file
sfan5 3e2b327167 Update colors.txt 2016-10-08 13:31:03 +02:00
util/travis Automatically use C++11 features when available and remove USE_CXX11 flag 2016-10-06 00:09:06 +02:00
.gitignore Add CPack files to .gitignore 2014-04-15 16:11:41 -04:00
.travis.yml Automatically use C++11 features when available and remove USE_CXX11 flag 2016-10-06 00:09:06 +02:00
AUTHORS Add license (BSD license) 2014-03-05 21:49:08 +01:00
CMakeLists.txt Automatically use C++11 features when available and remove USE_CXX11 flag 2016-10-06 00:09:06 +02:00
COPYING Clarify license situation (closes #26) 2016-08-09 16:18:04 +02:00
PixelAttributes.cpp Small refactoring. 2012-09-01 16:17:58 +02:00
PixelAttributes.h Rename some variables to make their purpose clearer 2015-03-18 22:49:19 +01:00
PlayerAttributes.cpp Player attributes moved to separate class. 2012-09-01 16:40:18 +02:00
PlayerAttributes.h Player attributes moved to separate class. 2012-09-01 16:40:18 +02:00
README.rst Clarify format of --geometry in README 2016-09-18 13:32:26 +02:00
TileGenerator.cpp Allow specifying location of colors.txt file 2016-08-09 16:45:39 +02:00
TileGenerator.h Automatically use C++11 features when available and remove USE_CXX11 flag 2016-10-06 00:09:06 +02:00
ZlibDecompressor.cpp Don't use a temporary table for block positions 2014-04-19 02:13:34 -04:00
ZlibDecompressor.h Don't use a temporary table for block positions 2014-04-19 02:13:34 -04:00
autogenerating-colors.txt Update colors.txt 2016-10-08 13:31:03 +02:00
cmake_config.h.in Automatically use C++11 features when available and remove USE_CXX11 flag 2016-10-06 00:09:06 +02:00
colors.txt Update colors.txt 2016-10-08 13:31:03 +02:00
config.h Automatically use C++11 features when available and remove USE_CXX11 flag 2016-10-06 00:09:06 +02:00
db-leveldb.cpp Better error reporting for LevelDB backend 2014-05-13 14:15:44 +02:00
db-leveldb.h Don't use a temporary table for block positions 2014-04-19 02:13:34 -04:00
db-redis.cpp Read backend from world.mt, closes #6 2014-07-08 15:08:07 +02:00
db-redis.h Add redis database backend 2014-04-26 15:03:32 +02:00
db-sqlite3.cpp Fix getting MapBlocks for abs(z) > 2048 with sqlite3 backend (fixed #31) 2016-09-18 14:33:13 +02:00
db-sqlite3.h Don't use a temporary table for block positions 2014-04-19 02:13:34 -04:00
db.h Fix getting MapBlocks for abs(z) > 2048 with sqlite3 backend (fixed #31) 2016-09-18 14:33:13 +02:00
mapper.cpp Fix crash on unknown option 2016-09-29 21:11:58 +02:00
types.h Don't use a temporary table for block positions 2014-04-19 02:13:34 -04:00
util.cpp Improve error reporting if setting is not found 2014-07-08 15:31:01 +02:00
util.h Read backend from world.mt, closes #6 2014-07-08 15:08:07 +02:00

README.rst

Minetest Mapper C++
===================

.. image:: https://travis-ci.org/minetest/minetestmapper.svg?branch=master
    :target: https://travis-ci.org/minetest/minetestmapper

A port of minetestmapper.py to C++ from https://github.com/minetest/minetest/tree/master/util.
This version is both faster and provides more features than the now deprecated Python script.

Requirements
------------

* libgd
* sqlite3
* leveldb (optional, set ENABLE_LEVELDB=1 in CMake to enable leveldb support)
* hiredis (optional, set ENABLE_REDIS=1 in CMake to enable redis support)

e.g. on Debian:
^^^^^^^^^^^^^^^

	sudo apt-get install libgd-dev libsqlite3-dev libleveldb-dev libhiredis-dev

Compilation
-----------

::

    cmake . -DENABLE_LEVELDB=1
    make -j2

Usage
-----

`minetestmapper` has two mandatory paremeters, `-i` (input world path)
and `-o` (output image path).

::

    ./minetestmapper -i ~/.minetest/worlds/my_world/ -o map.png


Parameters
^^^^^^^^^^

bgcolor:
    Background color of image, e.g. ``--bgcolor #ffffff``

scalecolor:
    Color of scale, e.g. ``--scalecolor #000000``

playercolor:
    Color of player indicators, e.g. ``--playercolor #ff0000``

origincolor:
    Color of origin indicator, e.g. ``--origincolor #ff0000``

drawscale:
    Draw tick marks, ``--drawscale``

drawplayers:
    Draw player indicators, ``--drawplayers``

draworigin:
    Draw origin indicator, ``--draworigin``

drawalpha:
    Allow nodes to be drawn with transparency, ``--drawalpha``

noshading:
    Don't draw shading on nodes, ``--noshading``

min-y:
    Don't draw nodes below this y value, e.g. ``--min-y -25``

max-y:
    Don't draw nodes above this y value, e.g. ``--max-y 75``

backend:
    Use specific map backend, supported: *sqlite3*, *leveldb*, *redis*, e.g. ``--backend leveldb``

geometry:
    Limit area to specific geometry (*x:y+w+h* where x and y specify the lower left corner), e.g. ``--geometry -800:-800+1600+1600``

zoom:
    "Zoom" the image by using more than one pixel per node, e.g. ``--zoom 4``

colors:
    Forcefully set path to colors.txt file (it's autodetected otherwise), e.g. ``--colors ../minetest/mycolors.txt``