diff --git a/README.md b/README.md new file mode 100644 index 0000000..8edc970 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# MTSatellite + +MTSatellite is "realtime" web mapping system for [Minetest](http://minetest.net) worlds. +To use it you have to configure your Minetest server to use the Redis backend data store. +Instead of a real Redis server you have to run **mtredisalize**. This server stores the data +in an optimized form and collects changes made to the world over a configurable amount +of time periodically. After a cycle of collection the web server **mtwebmapper** is triggered +to regenerate the map. To not fully regenerate the whole world map but only the differences +the map has to be pre-rendered with **mtseeder**. + +* [mtredisalize](cmd/mtredisalize) is a server which has to be configured a Redis backend to the + Minetest server. It stores the data in an opitimized form to make updates of the pre-rendered map fast. + It is also used to track the changes made to the world. They are aggregated over + a defined time interval and then send to the mtwebmapper server. + +* [mtwebmapper](cmd/mtwebmapper) Web server that serves [Leaflet](http://leafletjs.com) compatible tiles to a + web browser. Running in the background this server updates the pre-computed map tiles. + +* [mtdbconverter](cmd/mtdbconverter) is converter between Minetest databases. mtredisalize works + best if you use a special interleaved LevelDB key schema. To bring your old database (LevelBD or SQLite3) + into this format this tool does the job. It can also be used to convert the interleaved database + back to a plain LevelDB or SQLite3 one. + +* [mtseeder](cmd/mtseeder) pre-computes all tiles of the map of the world plus a set of pyramidal overview images. + Even playing in a dynamic and fully changeable world most of the data is pretty constant over time. Therefore + it make sense to do only small updates on pre-calculated images instead of generating + the map entirely on the fly. + +This is Free Software under the terms of the MIT license. +See [LICENSE](LICENSE) file for details. +(c) 2014 by Sascha L. Teichmann diff --git a/README b/cmd/mtredisalize/README similarity index 88% rename from README rename to cmd/mtredisalize/README index 7b691c3..d106345 100644 --- a/README +++ b/cmd/mtredisalize/README @@ -34,7 +34,7 @@ it is only tested on Ubuntu 14.04/amd64. Obtain: - $ go get bitbucket.org/s_l_teichmann/mtredisalize/cmd/mtredisalize + $ go get bitbucket.org/s_l_teichmann/mtsatellite/cmd/mtredisalize Development: @@ -42,8 +42,8 @@ Development: $ go install github.com/mattn/go-sqlite3 $ go get -u github.com/jmhodges/levigo $ go install github.com/jmhodges/levigo - $ hg clone https://s_l_teichmann@bitbucket.org/s_l_teichmann/mtredisalize - $ cd mtredisalize/cmd/mtredisalize + $ hg clone https://s_l_teichmann@bitbucket.org/s_l_teichmann/mtsatellite + $ cd mtsatellite/cmd/mtredisalize $ go build Usage: @@ -78,6 +78,3 @@ would e.g. matches: The mandatory path is the path to the database file: map.sqlite in case of SQLite3 and the directory map.db in case of LevelDB right beside the world.mt file. - -This is Free Software under the terms of the MIT license. See LICENSE file for details. -(c) 2014 by Sascha L. Teichmann