Go to file
Rogier 4ca967d40d Add new options to README, and include some extra example cmake commands 2014-03-26 00:21:31 +01:00
.gitignore LevelDB support 2014-03-05 21:42:21 +01:00
AUTHORS Add license (BSD license) 2014-03-05 21:49:08 +01:00
CMakeLists.txt Actually use the xxd binary that was found 2014-03-14 22:50:27 +01:00
COPYING Add license (BSD license) 2014-03-05 21:49:08 +01:00
LICENSE Added license. 2012-09-02 19:25:15 +02:00
PixelAttributes.cpp Small refactoring. 2012-09-01 16:17:58 +02:00
PixelAttributes.h Small refactoring. 2012-09-01 16:17:58 +02: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 Add new options to README, and include some extra example cmake commands 2014-03-26 00:21:31 +01:00
TileGenerator.cpp Optimize database access - load only blocks that are needed 2014-03-24 22:43:32 +01:00
TileGenerator.h Optimize database access - load only blocks that are needed 2014-03-24 22:43:32 +01:00
ZlibDecompressor.cpp Fixed LLVM support. 2012-09-18 12:46:15 +02:00
ZlibDecompressor.h Zlib moved into separate module. 2012-09-18 10:43:34 +02:00
autogenerating-colors.txt Added better (automatically generated) colors.txt 2014-03-14 22:05:35 +01:00
cmake_config.h.in LevelDB support 2014-03-05 21:42:21 +01:00
colors.txt Added better (automatically generated) colors.txt 2014-03-14 22:05:35 +01:00
config.h LevelDB support 2014-03-05 21:42:21 +01:00
db-leveldb.cpp Optimize database access - load only blocks that are needed 2014-03-24 22:43:32 +01:00
db-leveldb.h Optimize database access - load only blocks that are needed 2014-03-24 22:43:32 +01:00
db-sqlite3.cpp Optimize database access - load only blocks that are needed 2014-03-24 22:43:32 +01:00
db-sqlite3.h Optimize database access - load only blocks that are needed 2014-03-24 22:43:32 +01:00
db.h Optimize database access - load only blocks that are needed 2014-03-24 22:43:32 +01:00
mapper.cpp Optimize database access - load only blocks that are needed 2014-03-24 22:43:32 +01:00

README.rst

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

A port of minetestmapper.py to C++ from https://github.com/minetest/minetest/tree/master/util

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

* libgd
* sqlite3
* xxd binary (You can get xxd from your distribution packages or use '' wget -O xxd.c http://www.opensource.apple.com/source/vim/vim-43/vim/src/xxd/xxd.c?txt && gcc xxd.c -o xxd '')

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

Plain:

::

    cmake .
    make

With levelDB support:

::

    cmake -DENABLE_LEVELDB=true .
    make

Debug version:

::

    cmake -DCMAKE_BUILD_TYPE:STRING=Debug .
    make

Release version:

::

    cmake -DCMAKE_BUILD_TYPE:STRING=Release .
    make


Usage
-----

Binary `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, `--bgcolor #ffffff`

scalecolor:
    Color of scale, `--scalecolor #000000`

playercolor:
    Color of player indicators, `--playercolor #ff0000`

origincolor:
    Color of origin indicator, `--origincolor #ff0000`

drawscale:
    Draw tick marks, `--drawscale`

drawplayers:
    Draw player indicators, `--drawplayers`

draworigin:
    Draw origin indicator, `--draworigin`

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

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

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

backend:
    Use specific map backend, supported: sqlite3, leveldb, `--backend leveldb`

geometry:
    Limit area to specific geometry, `--geometry -800:-800+1600+1600`

forcegeometry:
    Generate a map of the requested size, even if the world is smaller.

verbose:
    report some useful/ interesting information:
    - maximum coordinates of the world
    - world coordinates included the map being generated
    - number of blocks: in the world, and in the map area.
    - database access statistics.

Customization of colors.txt
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Default `colors.txt` is included in binary. Color definitions can be redefined
using external `colors.txt` file.