Go to file
sfan5 97c5dc0a83
Fix typo in manpage
closes #64
2018-11-11 13:20:07 +01:00
include Add a flag to never output empty images. 2018-11-01 13:10:28 +01:00
util Add Windows build script 2018-03-25 17:30:19 +02:00
.gitignore Add CPack files to .gitignore 2014-04-15 16:11:41 -04:00
.travis.yml Update travis build process 2018-03-25 13:58:18 +02:00
AUTHORS Add license (BSD license) 2014-03-05 21:49:08 +01:00
BlockDecoder.cpp Refactoring (2) 2018-03-25 15:19:48 +02:00
CMakeLists.txt Refactoring (2) 2018-03-25 15:19:48 +02:00
COPYING Clarify license situation (closes #26) 2016-08-09 16:18:04 +02:00
Image.cpp Fix subtly broken libgd version check 2018-03-24 18:40:21 +01:00
PixelAttributes.cpp Small refactoring. 2012-09-01 16:17:58 +02:00
PlayerAttributes.cpp Finish refactor 2018-03-25 16:25:41 +02:00
README.rst Add a flag to never output empty images. 2018-11-01 13:10:28 +01:00
TileGenerator.cpp Add a flag to never output empty images. 2018-11-01 13:10:28 +01:00
ZlibDecompressor.cpp Don't use a temporary table for block positions 2014-04-19 02:13:34 -04:00
autogenerating-colors.txt Update colors.txt 2018-03-25 13:40:19 +02:00
colors.txt Update colors.txt 2018-03-25 13:40:19 +02:00
db-leveldb.cpp Better error reporting for LevelDB backend 2014-05-13 14:15:44 +02:00
db-postgresql.cpp Fix postgres build failure, closes #57 2018-03-28 17:45:35 +02:00
db-redis.cpp Refactoring (1) 2018-03-25 14:32:11 +02:00
db-sqlite3.cpp DBSQLite3: Do not raise in destructor 2016-10-08 22:02:36 +02:00
mapper.cpp Add a flag to never output empty images. 2018-11-01 13:10:28 +01:00
minetestmapper.6 Fix typo in manpage 2018-11-11 13:20:07 +01:00
util.cpp Refactoring (1) 2018-03-25 14:32:11 +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)
* hiredis library (optional, set ENABLE_REDIS=1 in CMake to enable)
* Postgres libraries (optional, set ENABLE_POSTGRES=1 in CMake to enable)

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

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

Windows
^^^^^^^
Minetestmapper for Windows can be downloaded here: https://github.com/minetest/minetestmapper/releases

After extracting the archive, minetestmapper can be invoked from cmd.exe:
::

	cd C:\Users\yourname\Desktop\example\path
	minetestmapper.exe --help

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 marks and text, e.g. ``--scalecolor '#000000'``

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

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

drawscale:
    Draw scale(s) with tick marks and numbers, ``--drawscale``

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

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

drawalpha:
    Allow nodes to be drawn with transparency (e.g. water), ``--drawalpha``

extent:
    Don't output any imagery, just print the extent of the full map, ``--extent``

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

noemptyimage:
    Don't output anything when the image would be empty, ``--noemptyimage``

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:
    Override auto-detected map backend; supported: *sqlite3*, *leveldb*, *redis*, *postgresql*, e.g. ``--backend leveldb``

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

zoom:
    Apply zoom to drawn nodes by enlarging them to n*n squares, e.g. ``--zoom 4``

colors:
    Override auto-detected path to colors.txt, e.g. ``--colors ../minetest/mycolors.txt``

scales:
    Draw scales on specified image edges (letters *t b l r* meaning top, bottom, left and right), e.g. ``--scales tbr``