mtcontrib/mtsatellite
1
0
Fork 0
mirror of https://bitbucket.org/s_l_teichmann/mtsatellite synced 2024-12-24 09:10:17 +01:00
Code Issues Projects Releases Wiki Activity

Document the player tracking.

Browse Source
This commit is contained in:
Sascha L. Teichmann 2015-05-31 13:03:08 +02:00
parent 5172e02380
commit 0cbc643e21
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
SETUP.md
View File

@ -13,6 +13,8 @@ Setting up MTSatellite takes six steps:
5. [Start the web server `mtwebmapper`](#markdown-header-start-the-web-server-mtwebmapper) 5. [Start the web server `mtwebmapper`](#markdown-header-start-the-web-server-mtwebmapper)
6. [Configure and restart the Minetest server](#markdown-header-configure-and-restart-the-minetest-server) 6. [Configure and restart the Minetest server](#markdown-header-configure-and-restart-the-minetest-server)
Experimental: Optionally you can enable on map tracking of logged in players(#markdown-header-enable-on-map-tracking-of-logged-in-players).
## Backup your world ## Backup your world
MTSatellite is still young. So stop your running Minetest server and make a backup of your world MTSatellite is still young. So stop your running Minetest server and make a backup of your world
@ -153,3 +155,37 @@ backend with a Redis configuration:
You may have to set `redis_port` too if you run `mtredisalize` not on port 6379. You may have to set `redis_port` too if you run `mtredisalize` not on port 6379.
Now we are all done and you can fire your Minetest server up again. :-) Now we are all done and you can fire your Minetest server up again. :-)
## Enable on map tracking of logged in players
MTSatellite can display logged in players on the map.
This is an experimental feature and its only confirmed working on GNU/Linux systems.
OS X and \*BSD should work, too.
To use it install the [track_players](https://bitbucket.org/s_l_teichmann/mtsatellite/src/default/mods/track_players)
mod. Simple add a checkout to your mods folder and activate it in your world.mt file.
...
load_mod_track_players = true
...
This minetest mod writes players position to a [named pipe aka FIFO](http://en.wikipedia.org/wiki/Named_pipe).
`mtwebmapper` is able to read from this file and serve these positions as GeoJSON to the browser.
The FIFO has to be created _before_ the start of the minetest server.
$ mkfifo /tmp/mt_players_fifo
The path to the FIFO can be changed in track_players/init.lua
...
local fifo_path = "/tmp/mt_players_fifo"
...
To use the feature in `mtwebmapper` add the argument `-players=/tmp/mt_players_fifo` to the list
of command arguments.
*Caution*: Please start `mtwebmapper` before the minetest server! Caused by the nature of FIFOs and the
single threaded execution of minetest mods the minetest server will block if there is no consumer
reading the player positions.
The player tracking is well integrated with the websocket support. If you enable websockets you will
be able to see the players moving on the map.