mirror of
https://github.com/minetest/minetestmapper.git
synced 2024-12-26 02:40:37 +01:00
Improve README (fixes #30)
This commit is contained in:
parent
2aa8619777
commit
7c1989a6b2
18
README.rst
18
README.rst
@ -4,7 +4,8 @@ Minetest Mapper C++
|
|||||||
.. image:: https://travis-ci.org/minetest/minetestmapper.svg?branch=master
|
.. image:: https://travis-ci.org/minetest/minetestmapper.svg?branch=master
|
||||||
:target: https://travis-ci.org/minetest/minetestmapper
|
:target: https://travis-ci.org/minetest/minetestmapper
|
||||||
|
|
||||||
A port of minetestmapper.py to C++ from https://github.com/minetest/minetest/tree/master/util
|
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
|
Requirements
|
||||||
------------
|
------------
|
||||||
@ -14,23 +15,28 @@ Requirements
|
|||||||
* leveldb (optional, set ENABLE_LEVELDB=1 in CMake to enable leveldb support)
|
* leveldb (optional, set ENABLE_LEVELDB=1 in CMake to enable leveldb support)
|
||||||
* hiredis (optional, set ENABLE_REDIS=1 in CMake to enable redis 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
|
Compilation
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
cmake .
|
cmake . -DENABLE_LEVELDB=1
|
||||||
make
|
make -j2
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Binary `minetestmapper` has two mandatory paremeters, `-i` (input world path)
|
`minetestmapper` has two mandatory paremeters, `-i` (input world path)
|
||||||
and `-o` (output image path).
|
and `-o` (output image path).
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
./minetestmapper -i ~/.minetest/worlds/my_world/ -o ~/map.png
|
./minetestmapper -i ~/.minetest/worlds/my_world/ -o map.png
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
@ -58,7 +64,7 @@ draworigin:
|
|||||||
Draw origin indicator, `--draworigin`
|
Draw origin indicator, `--draworigin`
|
||||||
|
|
||||||
drawalpha:
|
drawalpha:
|
||||||
Allow blocks to be drawn with transparency, `--drawalpha`
|
Allow nodes to be drawn with transparency, `--drawalpha`
|
||||||
|
|
||||||
noshading:
|
noshading:
|
||||||
Don't draw shading on nodes, `--noshading`
|
Don't draw shading on nodes, `--noshading`
|
||||||
|
Loading…
Reference in New Issue
Block a user