mapserver/readme.md

77 lines
1.9 KiB
Markdown
Raw Normal View History

2019-01-18 17:25:45 +03:00
Minetest mapserver
=======
2019-03-27 15:27:19 +03:00
[![Dependencies](https://img.shields.io/librariesio/github/thomasrudin-mt/mapserver.svg)](https://github.com/thomasrudin-mt/mapserver)
[![Build Status](https://travis-ci.org/thomasrudin-mt/mapserver.svg?branch=master)](https://travis-ci.org/thomasrudin-mt/mapserver)
2019-03-27 15:30:49 +03:00
![GitHub repo size](https://img.shields.io/github/repo-size/thomasrudin-mt/mapserver.svg)
![GitHub closed issues](https://img.shields.io/github/issues-closed/thomasrudin-mt/mapserver.svg)
2019-03-27 15:27:19 +03:00
2019-02-05 18:33:10 +03:00
Realtime mapserver for [Minetest](https://minetest.net)
2019-05-17 10:32:36 +03:00
Demo: [Pandorabox Server map](https://pandorabox.io/map/#-1782.25/493.5/10)
2019-03-27 15:27:19 +03:00
2019-02-05 18:33:10 +03:00
# Documentation
* [Installation](doc/install.md)
* [Building](doc/building.md)
2019-02-05 18:33:10 +03:00
* [Mapserver mod](doc/mod.md)
* [Parameters](doc/params.md)
2019-05-04 22:13:19 +03:00
* [Search](doc/search.md)
2019-02-05 18:33:10 +03:00
* [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-02-15 12:41:44 +03:00
* [Changelog](doc/changelog.md)
2019-01-18 17:25:45 +03:00
2019-03-19 10:21:47 +03:00
# How it works
See: [Incremental rendering](doc/incrementalrendering.md)
2019-02-22 17:17:19 +03:00
# Compatibility
* Minetest 0.4.15 - 0.4.17.1
* Minetest 5.0
2019-01-27 21:08:11 +03:00
# Features
## Current features
2019-02-22 17:17:19 +03:00
* Click-and-run installation
2019-01-27 21:08:11 +03:00
* Initial and incremental map rendering
2019-02-22 17:17:19 +03:00
* Realtime rendering and map-updating
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-22 17:17:19 +03:00
* POI [markers](doc/mapobjects.md) / [mod](doc/mod.md) 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-22 17:17:19 +03:00
# Supported map-databases
The connection is auto-detected from your `world.mt`:
2019-02-08 00:30:31 +03:00
2019-02-22 17:17:19 +03:00
* Sqlite3
* PostgreSql
2019-02-08 00:30:31 +03:00
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)
2019-02-15 12:41:44 +03:00
See: [mapobjects](doc/mapobjects.md)
2019-02-15 12:33:34 +03:00
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.