diff --git a/README.md b/README.md index 5cc2795..fee22ca 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ MTSatellite is "realtime" web mapping system for [Minetest](http://minetest.net) worlds. With this system you can play your world and you instantly have an online map of it which -can be share on the web. +can be shared on the web. To get a glimpse what it does watch [Realtime Webmapping for Minetest worlds](http://youtu.be/iYEROGPj7RI) on YouTube. diff --git a/SETUP.md b/SETUP.md index 7bc12f8..9763992 100644 --- a/SETUP.md +++ b/SETUP.md @@ -6,20 +6,25 @@ Consult [COMPILE](https://bitbucket.org/s_l_teichmann/mtsatellite/src/default/CO Setting up MTSatellite takes six steps: -1. [Convert world database into interleaved format](#markdown-header-convert-world-database-into-interleaved-format) -2. [Configure the Minetest server](#markdown-header-configure-the-minetest-server) +1. [Backup your world](#markdown-header-backup-your-world) +2. [Convert world database into interleaved format](#markdown-header-convert-world-database-into-interleaved-format) 3. [Start `mtredisalize`](#markdown-header-start-mtredisalize) 4. [Pre-compute the map tiles with `mtseeder`](#markdown-header-pre-compute-the-map-tiles-with-mtseeder) 5. [Start the web server `mtwebmapper`](#markdown-header-start-the-web-server-mtwebmapper) -6. [Start the Minetest server](#markdown-header-start-the-minetest-server) +6. [Configure and restart the Minetest server](#markdown-header-configure-and-restart-the-minetest-server) + +## Backup your world + +MTSatellite is still young. So stop your running Minetest server and make a backup of your world +before you will start crying. ## Convert world database into interleaved format MTSatellite operates best if the block data of the world is stored in a LevelDB database with a key scheme called interleaved. With this key scheme you can pick up sets of neighbored blocks a lot quicker than with a plain database. -See [Z-order curve](http://en.wikipedia.org/wiki/Z-order_curve) at Wikipedia for grasping the core ideas. -MTSatellite can run on plain LevelDB or SQlite3 world databases but this reduces the performance significantly. +See [Z-order curve](http://en.wikipedia.org/wiki/Z-order_curve) at Wikipedia to grasp the core ideas. +MTSatellite can run on plain LevelDB or SQLite3 world databases but this reduces the performance significantly. This is also not tested very well and will likely break your database. So do not use it! Stay with the interleaved format! @@ -28,13 +33,10 @@ LevelDB format you have to use `mtdbconverter`: mtdbconverter -source-backend=sqlite /path/to/your/world/map.sqlite /path/to/your/world/map.db -Depending on the size of your world and the speed this conversion will take some time. +Depending on the size of your world and the speed of your computer system this conversion will take some time. Change `-source-backend=sqlite` to `-source-backend=leveldb` if your world is stored as a LevelDB. `mtdbconverter` can also be used to convert your world back to the plain key scheme. -See `mtdbconverter --help` for all options. - -## Configure the Minetest server -**TODO: Write me!** +Use `mtdbconverter --help` to see all options. ## Start mtredisalize **TODO: Write me!** @@ -45,5 +47,5 @@ See `mtdbconverter --help` for all options. ## Start the web server mtwebmapper **TODO: Write me!** -## Start the Minetest server +## Configure and restart the Minetest server **TODO: Write me!**