From d99bb70358a61a8f1b8aedbb6f60c23e90f268f5 Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Sat, 4 Oct 2014 20:56:01 +0200 Subject: [PATCH] Start writing how to setup MTSatellite. Not done, yet. --- README.md | 5 ++++- SETUP.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 SETUP.md diff --git a/README.md b/README.md index 0317297..4b3cc93 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,9 @@ on YouTube. See [COMPILE](https://bitbucket.org/s_l_teichmann/mtsatellite/src/default/COMPILE.md) how to compile MTSatellite. Essentially you need Go 1.3 (or higher) and a GNU/Linux system. +See [SETUP](https://bitbucket.org/s_l_teichmann/mtsatellite/src/default/COMPILE.md) how to bring +MTSatellite to life. + 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 @@ -37,4 +40,4 @@ the map has to be pre-rendered with **mtseeder**. This is Free Software under the terms of the MIT license. See [LICENSE](LICENSE) file for details. -(c) 2014 by Sascha L. Teichmann \ No newline at end of file +(c) 2014 by Sascha L. Teichmann diff --git a/SETUP.md b/SETUP.md new file mode 100644 index 0000000..ff6975e --- /dev/null +++ b/SETUP.md @@ -0,0 +1,32 @@ +# SETUP MTSatellite \[WIP\] + +You will need a Minetest server with Redis support compiled in. Consult the Minetest documentation to figure out how to get such build. +Furthermore you need the binaries `mtdbconverter`, `mtseeder`, `mtredisalize` and `mtwebmapper` in your **PATH**. +Consult [COMPILE](https://bitbucket.org/s_l_teichmann/mtsatellite/src/default/COMPILE.md) how to build these. + +Setting up MTSatellite takes six steps: + +1. [Convert world database into interleaved format](#mtdbconverter) +2. [Configure the Minetest server](#cfg_minetest) +3. [Start `mtredisalize`](#mtredisalize) +4. [Pre-compute the map tiles with `mtseeder`](#mtseeder) +5. [Start the web server `mtwebmapper`](#mtwebmapper) +6. [Start the Minetest server](#start_minetest) + +

Convert world database into interleaved format

+**TODO: Write me!** + +

Configure the Minetest server

+**TODO: Write me!** + +

Start mtredisalize

+**TODO: Write me!** + +

Pre-compute the map tiles with mtseeder

+**TODO: Write me!** + +

Start the web server mtwebmapper

+**TODO: Write me!** + +

Start the Minetest server

+**TODO: Write me!**