mtcontrib
/
mtsatellite
mirror of https://bitbucket.org/s_l_teichmann/mtsatellite
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Start writing how to setup MTSatellite. Not done, yet.

This commit is contained in:
Sascha L. Teichmann 2014-10-04 20:56:01 +02:00
parent 600a6001ba
commit d99bb70358
2 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -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
(c) 2014 by Sascha L. Teichmann

32
SETUP.md Normal file
View File

@ -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)
<h2 id="mtdbconverter">Convert world database into interleaved format</h2>
**TODO: Write me!**
<h2 id="cfg_minetest">Configure the Minetest server</h2>
**TODO: Write me!**
<h2 id="mtredisalize">Start <code>mtredisalize</code></h2>
**TODO: Write me!**
<h2 id="mtseeder">Pre-compute the map tiles with <code>mtseeder</code></h2>
**TODO: Write me!**
<h2 id="mtwebmapper">Start the web server <code>mtwebmapper</code></h2>
**TODO: Write me!**
<h2 id="start_minetest">Start the Minetest server</h2>
**TODO: Write me!**