update docs

doc/changelog.md

@@ -5,7 +5,11 @@
 * Extended [configuration](config.md)
 * [Monitoring](prometheus.md)
 * [Mod](mod.md)-bridge
+* Player and game-stats display (player-count, lag)
 * More [mapobjects](mapobjects.md)
+* Fixed tile generation glitch
+* Tile-backend is now file-based (needs a complete re-rendering)
+* Postgres map backend
 
 ## 0.1.0 (2019-02-08)
 * Realtime tiles

doc/config.md

@@ -94,7 +94,16 @@ If you make more substantial changes here you may have to remove all
 existing tiles and start rendering from scratch.
 
 #### renderingjobs
-Number of cores to use for rendering, defaults to all available cores
+Number of cores to use for rendering, defaults to all available cores.
+If CPU-limiting is desired, this is a good spot to begin with (Set to 1 for single-thread)
+
+#### renderingfetchlimit
+Number of mapblocks to collect at once while rendering:
+* More means faster but also more RAM usage
+* Less means slower but less RAM usage
+
+For a small system (Raspberry PI) a setting of 1000 is ok.
+Faster system can use the default (10'000)
 
 #### enableprometheus
 Enables the [Prometheus](./prometheus.md) metrics endpoint

doc/install.md

@@ -8,4 +8,4 @@
 * Start the mapserver via command-line: `./mapserver` or `./mapserver.exe`
 * Point your browser to `http://127.0.0.1:8080`
 
-For additional infos (lag,time,players) on the mapserver interface you should install the [mapserver-mod](mod.md)
+For additional infos (lag,time,players => active mode) on the mapserver interface you should install the [mapserver-mod](mod.md)

doc/mapobjects.md

@@ -2,30 +2,30 @@
 # Supported map objects (markers)
 
 ## Player bones
-<img src="./pics/bones.png">
+<img src="../pics/bones.png">
 
 ## Digiterms
 See: https://github.com/Pyrollo/digiterms
 
-<img src="./pics/digiterms.png">
+<img src="../pics/digiterms.png">
 
 ## Digilines
 See: https://github.com/minetest-mods/digilines
 
-<img src="./pics/lcd_display.png">
+<img src="../pics/lcd_display.png">
 
 ## POI
 
-<img src="./pics/poi.png">
+<img src="../pics/poi.png">
 
 ## Protector
 
-<img src="./pics/protectors.png">
+<img src="../pics/protectors.png">
 
 ## Travelnet
 See: https://github.com/Sokomine/travelnet
 
-<img src="./pics/travelnet.png">
+<img src="../pics/travelnet.png">
 
 ## More
 And various more, see: [setup.go](../server/mapobject/setup.go)

readme.md

@@ -14,14 +14,21 @@ Realtime mapserver for [Minetest](https://minetest.net)
 * [License](doc/license.md)
 * [Changelog](doc/changelog.md)
 
+# Compatibility
+
+* Minetest 0.4.15 - 0.4.17.1
+* Minetest 5.0
+
 # Features
 
 ## Current features
 
+* Click-and-run installation
 * Initial and incremental map rendering
+* Realtime rendering and map-updating
 * Realtime player and world stats
 * Configurable layers (default: "Base" from y -16 to 160)
-* POI markers / mod integration
+* POI [markers](doc/mapobjects.md) / [mod](doc/mod.md) integration
 * Protector display
 * LCD Displays as markers
 * Monitoring with [Prometheus](doc/prometheus.md)
@@ -32,9 +39,11 @@ Realtime mapserver for [Minetest](https://minetest.net)
 * Street names / Train stuff
 * City borders
 
-# Supported databases
+# Supported map-databases
+The connection is auto-detected from your `world.mt`:
 
-* Sqlite3 (for map and mapobjects)
+* Sqlite3
+* PostgreSql
 
 # Screenshots
 
@@ -48,13 +57,6 @@ Realtime mapserver for [Minetest](https://minetest.net)
 Enable/Disable those in the [Configuration](doc/config.md)
 See:  [mapobjects](doc/mapobjects.md)
 
-<img src="./pics/bones.png">
-<img src="./pics/digiterms.png">
-<img src="./pics/lcd_display.png">
-<img src="./pics/poi.png">
-<img src="./pics/protectors.png">
-<img src="./pics/travelnet.png">
-
 
 # Bugs