Go to file
Rogier a2205eb9fb Geometry: w and h are the map dimensions
For a 100x100 map, the w and h parameters would have to be
specified as +99+99. This is not intuitive. Changed this,
so that +100+100 results in a 100x100 map.
2014-03-26 11:51:48 +01:00
.gitignore LevelDB support 2014-03-05 21:42:21 +01:00
AUTHORS Document and (attempt to) clarify licensing situation 2014-03-26 11:04:29 +01:00
CMakeLists.txt Actually use the xxd binary that was found 2014-03-14 22:50:27 +01:00
COPYING Document and (attempt to) clarify licensing situation 2014-03-26 11:04:29 +01:00
LICENSE Document and (attempt to) clarify licensing situation 2014-03-26 11:04:29 +01:00
LICENSE.BSD-2clause Document and (attempt to) clarify licensing situation 2014-03-26 11:04:29 +01:00
LICENSE.LGPLv2.1 Document and (attempt to) clarify licensing situation 2014-03-26 11:04:29 +01: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 Fix itemized list in README file (should display correctly on github now) 2014-03-26 08:56:33 +01:00
TileGenerator.cpp Geometry: w and h are the map dimensions 2014-03-26 11:51:48 +01:00
TileGenerator.h Set default map geometry to the maximum world size (i.e. 4096x4096) 2014-03-26 08:55:20 +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 Remove leveldb block-id cache 2014-03-26 08:57:45 +01:00
db-leveldb.h Remove leveldb block-id cache 2014-03-26 08:57:45 +01:00
db-sqlite3.cpp Database performance tweaks 2014-03-26 00:23:33 +01:00
db-sqlite3.h Database performance tweaks 2014-03-26 00:23:33 +01:00
db.h Database performance tweaks 2014-03-26 00:23:33 +01:00
mapper.cpp Database performance tweaks 2014-03-26 00:23:33 +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.

sqlite-cacheworldrow:
    When using sqlite, read an entire world row at one, instead of reading
    one block at a time.
    This may improve performance when a large percentage of the world is mapped.

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.