extern/mapscii
1
0
Fork 0
mirror of https://github.com/rastapasta/mapscii.git synced 2024-11-21 15:43:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

📖 working on readme

Browse Source
This commit is contained in:
Michael Straßburger 2016-09-18 19:57:47 +02:00
parent e52ae425f6
commit 545b9246c9
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,6 +1,24 @@
# termap - Terminal Map
# termap - Terminal Map Viewer
Discover the world in your console! termap allows you to render and navigate
VectorTile based maps in your console.
* No native dependencies, 100% JavaScript/CoffeeScript
* Use tile servers or local MBTiles and VectorTiles
## How to install it?
`npm install -g termap`
## Behind the scenes
### Libraries
* [`pbf`](https://github.com/mapbox/pbf) for Protobuf parsing
* [`vector-tile`](https://github.com/mapbox/vector-tile-js) for [VectorTile](https://github.com/mapbox/vector-tile-spec/tree/master/2.1) parsing
* [`term-mouse`](https://github.com/CoderPuppy/term-mouse) for mouse handling
* [`keypress`](https://github.com/TooTallNate/keypress) for input handling
* [`node-drawille`](https://github.com/madbence/node-drawille/) for braille rendering (to be replaced)
Discover the world in your console - render vector tile maps from any source!
## TODOs
* [ ] mapping of view to tiles to show