diff --git a/SETUP.md b/SETUP.md index 569da85..5e764ff 100644 --- a/SETUP.md +++ b/SETUP.md @@ -17,7 +17,7 @@ Experimental: Optionally you can [enable on map tracking of logged in players](# ## Backup your world -MTSatellite is still young. So stop your running Minetest server and make a backup of your world +Stop your running Minetest server and make a backup of your world before you will start crying. ## Convert world database into interleaved format @@ -26,9 +26,9 @@ MTSatellite operates best if the block data of the world is stored in a LevelDB 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 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! +MTSatellite can run on plain LevelDB or SQLite3 world databases but with slightly reduced performance. +This should work but to our knowledge it is not used in productive setups. +Stay with the interleaved format! To convert your original plain SQLite3 or LevelDB database (Redis is not supported atm) to the interleaved LevelDB format you have to use `mtdbconverter`: @@ -40,6 +40,8 @@ Change `-source-backend=sqlite` to `-source-backend=leveldb` if your world is st `mtdbconverter` can also be used to convert your world back to the plain key scheme. Use `mtdbconverter --help` to see all options. +You can skip the conversion if you want to use a plain database. + ## Start mtredisalize `mtredisalize` is the component which serves the block data to Minetest and `mtwebmapper` as a Redis @@ -54,7 +56,7 @@ look-alike server. Start it with: This binds the server to localhost port 6379 the default Redis port. You can shange it with the `-port=` option. The `-interleaved=true` option is **mandatory** if you use the interleaved format of the database. Forgetting it -will end up in the crying mentioned above. +will end up in the crying mentioned above. Set this flag to `false` if you are using a plain database. The `-change-url=` option is a forward reference to the `mtwebmapper` server which will be notified if the world has changed. If it is not configured the tile re-generation is not triggered. As long as the Minetest server is down there will be no changes and therefore it is safe to configure it even if the `mtwebmapper` service is not