mapserver/readme.md

60 lines
1.2 KiB
Markdown
Raw Normal View History

2019-01-18 17:25:45 +03:00
Minetest mapserver
=======
2019-02-05 18:33:10 +03:00
Realtime mapserver for [Minetest](https://minetest.net)
# Documentation
* [Installation](doc/install.md)
* [Mapserver mod](doc/mod.md)
* [Parameters](doc/params.md)
* [Configuration](doc/config.md)
* [Contribution](doc/contrib.md)
2019-02-08 00:30:31 +03:00
* [Development](doc/dev.md)
2019-02-08 10:22:48 +03:00
* [License](doc/license.md)
2019-01-18 17:25:45 +03:00
2019-01-27 21:08:11 +03:00
# Features
## Current features
* Initial and incremental map rendering
2019-02-05 18:33:10 +03:00
* Realtime player and world stats
2019-01-27 21:08:11 +03:00
* Configurable layers (default: "Base" from y -16 to 160)
2019-02-08 12:39:18 +03:00
* POI markers / mod integration
2019-02-15 12:33:34 +03:00
* Protector display
2019-02-08 12:39:18 +03:00
* LCD Displays as markers
2019-02-15 12:33:34 +03:00
* Monitoring with [Prometheus](doc/prometheus.md)
2019-01-27 21:08:11 +03:00
## Planned Features
2019-02-05 18:33:10 +03:00
* Player infos (HP, breath, etc)
2019-01-27 21:08:11 +03:00
* Street names / Train stuff
2019-02-05 18:33:10 +03:00
* City borders
2019-01-27 21:08:11 +03:00
2019-02-08 00:30:31 +03:00
# Supported databases
* Sqlite3 (for map and mapobjects)
2019-02-05 18:33:10 +03:00
# Screenshots
2019-01-27 21:08:11 +03:00
2019-02-05 18:33:10 +03:00
## Web interface
<img src="./pics/web.png">
2019-01-27 21:08:11 +03:00
2019-02-05 18:33:10 +03:00
## Terminal
<img src="./pics/terminal.png">
2019-02-15 12:33:34 +03:00
## Map objects (as markers)
Enable/Disable those in the [Configuration](doc/config.md)
<img src="./pics/bones.png">
<img src="./pics/digiterms.png">
<img src="./pics/lcd_display.png">
<img src="./pics/poi.png">
<img src="./pics/protectors.png">
<img src="./pics/travelnet.png">
2019-02-05 18:33:10 +03:00
# Bugs
2019-01-27 21:08:11 +03:00
2019-02-05 18:33:10 +03:00
There will be bugs, please file them in the [issues](./issues) page.