Some documentation fixes & improvements

This commit is contained in:
Rogier 2015-11-26 12:33:18 +01:00
parent 005e69b8c6
commit 3478a87c16
2 changed files with 16 additions and 11 deletions

View File

@ -14,12 +14,11 @@ Major Features
* All colors for regular or height maps are configurable * All colors for regular or height maps are configurable
* Draw player positions * Draw player positions
* Draw different geometric figures, or text on the map * Draw different geometric figures, or text on the map
* Draw the map at a reduced scale. E.g. 1:4. * Draw the map at a reduced scale. E.g. 1:4 (max: 1:16).
* Draw a scale on the left and/or top side of the map, * Draw a scale on the left and/or top side of the map,
and/or a height scale (for height maps) on the bottom. and/or a height scale (for height maps) on the bottom.
* Optionally draw some nodes transparently (e.g. water) * Optionally draw some nodes transparently (e.g. water)
* User manual * Includes a user manual
Build Features Build Features
============== ==============
@ -41,6 +40,7 @@ Minor Features
Differences From Stock Minetestmapper Differences From Stock Minetestmapper
===================================== =====================================
* Support for the new freeminer database format * Support for the new freeminer database format
* Ability to draw height-maps
* Different methods for drawing transparent blocks * Different methods for drawing transparent blocks
(more than transparency on and off) (more than transparency on and off)
* Different colors can be specified for nodes, in the * Different colors can be specified for nodes, in the
@ -60,7 +60,7 @@ Differences From Stock Minetestmapper
directory, or in system directories directory, or in system directories
* Colors files can include others, so that just a few colors can * Colors files can include others, so that just a few colors can
be redefined, and the system colors file used for the others. be redefined, and the system colors file used for the others.
* The map can be draw at a reduced scale. * The map can be drawn at a reduced scale (1:1 - 1:16).
This means that a full world map can now be generated. This means that a full world map can now be generated.
* A grid can be drawn on the map. * A grid can be drawn on the map.
* A number of symbolic colors ('red', ...) are available on the * A number of symbolic colors ('red', ...) are available on the
@ -68,7 +68,7 @@ Differences From Stock Minetestmapper
* The scale can be enabled on the left and top side individually * The scale can be enabled on the left and top side individually
* Major and minor (tick) intervals are configurable for the scale * Major and minor (tick) intervals are configurable for the scale
* Block numbers are shown on the scale as well * Block numbers are shown on the scale as well
* optionally, avoid reading the block list from the database * Optionally, avoid reading the block list from the database
(dramatically speeds up generating maps of small parts of large worlds) (dramatically speeds up generating maps of small parts of large worlds)
In addition a number bugs have been fixed. As bugs are also getting In addition a number bugs have been fixed. As bugs are also getting

View File

@ -4,20 +4,25 @@ It reads from the world database directly, and generates a
map in png format. One world node is rendered as one map pixel. map in png format. One world node is rendered as one map pixel.
Features: Features:
- Standard color mapping file included (which maps node (e.g. default:stone) to desired color) - Standard color mapping file included (which maps a node (e.g. default:stone) to the desired color)
- Use custom color mapping files (user-specific, world-specific, command-line) - Easy creation of custom color mapping files (user-specific, world-specific, command-line)
- Supports sqlite3, leveldb and redis backends - Supports all minetest backends (sqlite3, leveldb and redis)
- Ability to create a regular map or a height-map
- Ability to draw the map at a reduced scale (up to 1:16)
- Supports both minetest and freeminer worlds
Options: Options:
- Limit the area of the world being rendered (and thus the size of the map) - Limit the area of the world being rendered (and thus the size of the map)
- Render nodes transparently or not (e.g. water) - Render nodes transparently or not (e.g. water)
- Draw player positions on the map - Draw player positions on the map
- Draw a scale on the sides of the map - Draw a scale on the sides of the map
- Disable shading (rendering of height differences) - Disable shading (rendering of height differences)
- Draw a grid to the map - Draw a grid on the map
- Draw geometric figures or text on the map - Draw geometric figures or text on the map (circle, rectangle, ...)
- Show actual world and map dimensions and report rendering statistics. - Report actual world and map dimensions and rendering statistics.
Due to limitations of the drawing library, the maximum map size is limited. Due to limitations of the drawing library, the maximum map size is limited.
The following numbers were determined by experimentation, and may vary: The following numbers were determined by experimentation, and may vary:
- On 32-bit platforms, to a little over 570 megapixels (e.g. about 24000 x 24000) - On 32-bit platforms, to a little over 570 megapixels (e.g. about 24000 x 24000)
- On 64-bit platforms, to a little over 2.1 gigapixels (e.g. about 46000 x 46000) - On 64-bit platforms, to a little over 2.1 gigapixels (e.g. about 46000 x 46000)
Website: https://github.com/Rogier-5/minetest-mapper-cpp