From 707ff46c67fb0ab465e91a301944116b237e12f1 Mon Sep 17 00:00:00 2001 From: NatureFreshMilk Date: Fri, 8 Feb 2019 10:39:18 +0100 Subject: [PATCH] docs --- doc/config.md | 6 ++---- doc/mod.md | 12 +++++++++++- readme.md | 9 ++------- server/mapobject/setup.go | 16 ++++++++-------- 4 files changed, 23 insertions(+), 20 deletions(-) diff --git a/doc/config.md b/doc/config.md index fd57878..39ea47b 100644 --- a/doc/config.md +++ b/doc/config.md @@ -19,11 +19,9 @@ Default colors, see: [colors.txt](../server/static/colors.txt) ## Configuration json All config options reside in the `mapserver.json` file with the default values -Please stop the server if you make any changes there. - The mapserver will generate a fresh `mapserver.json` if there is none at startup. -### Example json +### Example mapserver.json ```json { "port": 8080, @@ -53,7 +51,7 @@ The mapserver will generate a fresh `mapserver.json` if there is none at startup The port on which the server listens to #### webapi.secretkey -The generated secret for the [mod bridge](./install) +The generated secret for the [mod bridge](./mod) #### layers The layers as a list diff --git a/doc/mod.md b/doc/mod.md index b09714c..1c9bf65 100644 --- a/doc/mod.md +++ b/doc/mod.md @@ -8,7 +8,7 @@ you get more realtime-data from within your minetest-world: * Current time and max lag You can use the `mapserver-mod` either passive or active: -* *Passive* Makes some additional markers available (POI, etc) +* *Passive* Makes some additional markers available (POI, Labels, etc) * *Active* Communicates with the mapserver and sends realtime data (players, lag, time) ## Installing and configuring the bridge-mod @@ -16,6 +16,16 @@ You can use the `mapserver-mod` either passive or active: The mod itself is available in the git [repo](./mapserver_mod) or as a zip package in the [releases](./releases) +## Passive mode + +You don't have to set up anything, passive mode is the default. +There are some additional map objects you can use in this mode: + +* **POI** Point of interest +* **Label** A street or city label +* **Border** A border for cities or regions +* **Train** To display train lines on the map, with stations and line-info + ## Active mode The mod communicates via http with the mapserver. diff --git a/readme.md b/readme.md index 1165685..e5c81d1 100644 --- a/readme.md +++ b/readme.md @@ -20,12 +20,12 @@ Realtime mapserver for [Minetest](https://minetest.net) * Initial and incremental map rendering * Realtime player and world stats * Configurable layers (default: "Base" from y -16 to 160) +* POI markers / mod integration +* LCD Displays as markers ## Planned Features -* POI markers / mod integration * Player infos (HP, breath, etc) -* LCD Displays as markers * Street names / Train stuff * City borders @@ -33,11 +33,6 @@ Realtime mapserver for [Minetest](https://minetest.net) * Sqlite3 (for map and mapobjects) -# Development state - -* Working basic features (map rendering) -* Successor of http://github.com/thomasrudin-mt/minetest-tile-server - # Screenshots ## Web interface diff --git a/server/mapobject/setup.go b/server/mapobject/setup.go index 7ec2279..0331bac 100644 --- a/server/mapobject/setup.go +++ b/server/mapobject/setup.go @@ -126,14 +126,14 @@ func Setup(ctx *app.App) { //digiterms digiterms := &DigitermsBlock{} - l.AddMapObject("'digiterms:lcd_monitor", digiterms) - l.AddMapObject("'digiterms:cathodic_beige_monitor", digiterms) - l.AddMapObject("'digiterms:cathodic_white_monitor", digiterms) - l.AddMapObject("'digiterms:cathodic_black_monitor", digiterms) - l.AddMapObject("'digiterms:scifi_glassscreen", digiterms) - l.AddMapObject("'digiterms:scifi_widescreen", digiterms) - l.AddMapObject("'digiterms:scifi_tallscreen", digiterms) - l.AddMapObject("'digiterms:scifi_keysmonitor", digiterms) + l.AddMapObject("digiterms:lcd_monitor", digiterms) + l.AddMapObject("digiterms:cathodic_beige_monitor", digiterms) + l.AddMapObject("digiterms:cathodic_white_monitor", digiterms) + l.AddMapObject("digiterms:cathodic_black_monitor", digiterms) + l.AddMapObject("digiterms:scifi_glassscreen", digiterms) + l.AddMapObject("digiterms:scifi_widescreen", digiterms) + l.AddMapObject("digiterms:scifi_tallscreen", digiterms) + l.AddMapObject("digiterms:scifi_keysmonitor", digiterms) //missions l.AddMapObject("missions:mission", &MissionBlock{})