extern/mapscii
1
0
Fork 0
mirror of https://github.com/rastapasta/mapscii.git synced 2024-11-24 17:13:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

📝 replacing animated gif with link to assciicast

Browse Source
This commit is contained in:
Michael Straßburger 2017-04-27 13:12:56 +02:00
parent 1e545aa85a
commit 4b3f47753c
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -2,11 +2,10 @@
A node.js based [Vector Tile](http://wiki.openstreetmap.org/wiki/Vector_tiles) to [Braille](http://www.fileformat.info/info/unicode/block/braille_patterns/utf8test.htm) and [ASCII](https://de.wikipedia.org/wiki/American_Standard_Code_for_Information_Interchange) renderer for [xterm](https://en.wikipedia.org/wiki/Xterm)-compatible terminals. A node.js based [Vector Tile](http://wiki.openstreetmap.org/wiki/Vector_tiles) to [Braille](http://www.fileformat.info/info/unicode/block/braille_patterns/utf8test.htm) and [ASCII](https://de.wikipedia.org/wiki/American_Standard_Code_for_Information_Interchange) renderer for [xterm](https://en.wikipedia.org/wiki/Xterm)-compatible terminals.
<img src="docs/berlin_cbase.gif" width="100%" /> [![asciicast](https://cloud.githubusercontent.com/assets/1259904/25480718/497a64e2-2b4a-11e7-9cf0-ed52ee0b89c0.png)](https://asciinema.org/a/117813?autoplay=1)
## Features ## Features
* Use your mouse to drag and zoom in and out
* Discover Point-of-Interests around any given location * Discover Point-of-Interests around any given location
* Highly customizable layer styling with [Mapbox Styles](https://www.mapbox.com/mapbox-gl-style-spec/) support * Highly customizable layer styling with [Mapbox Styles](https://www.mapbox.com/mapbox-gl-style-spec/) support
* Connect to any public or private vector tile server * Connect to any public or private vector tile server
@ -14,6 +13,7 @@ A node.js based [Vector Tile](http://wiki.openstreetmap.org/wiki/Vector_tiles) t
* Work offline and discover local [VectorTile](https://github.com/mapbox/vector-tile-spec)/[MBTiles](https://github.com/mapbox/mbtiles-spec) * Work offline and discover local [VectorTile](https://github.com/mapbox/vector-tile-spec)/[MBTiles](https://github.com/mapbox/mbtiles-spec)
* Compatible with most Linux and OSX terminals * Compatible with most Linux and OSX terminals
* Highly optimizied algorithms for a smooth experience * Highly optimizied algorithms for a smooth experience
* Use your mouse to drag and zoom in and out (WIP)
* 100% pure Coffee-/JavaScript! :sunglasses: * 100% pure Coffee-/JavaScript! :sunglasses:
## How to install ## How to install
@ -79,16 +79,18 @@ If your terminal supports mouse events you can drag the map and use your scroll
* [ ] demo mode? * [ ] demo mode?
* [ ] mouse control * [ ] mouse control
* [ ] get hover lat/lng
* [ ] accurate mouse drag&drop with instant update * [ ] accurate mouse drag&drop with instant update
* [ ] hover POIs/labels * [ ] hover POIs/labels
* [ ] hover maybe even polygons/-lines? * [ ] hover maybe even polygons/-lines?
* [ ] get hover lat/lng
* [ ] zoom into mouse pos * [ ] zoom into mouse pos
* Styler * Styler
* [ ] respect zoom based style ranges * [ ] respect zoom based style ranges
* Renderer * Renderer
* [ ] download and process tiles in a different thread ([#3](https://github.com/rastapasta/mapscii/issues/3))
* [ ] optimize renderer for large areas ([#6](https://github.com/rastapasta/mapscii/issues/6))
* [ ] label drawing * [ ] label drawing
* [ ] multi line label? * [ ] multi line label?