2016-09-18 19:57:47 +02:00
# termap - Terminal Map Viewer
2016-09-20 23:02:21 +02:00
No web browser around? No worries - discover the planet in your console!
2016-09-18 19:57:47 +02:00
2016-09-29 01:25:47 +02:00
< img src = "http://i.imgur.com/yYVt7No.png" width = "100%" / >
2016-09-20 23:02:21 +02:00
* Use your mouse or keys to navigate
2016-09-21 23:40:08 +02:00
* Discover the globe or zoom in to explore your neighbourhood
2016-09-20 23:02:21 +02:00
* See Point-of-Interest around any given location
* Use an online map server or work offline with VectorTile/MBTiles
* Highly customizable styling (colors, feature visibility, ...)
* Compatible with Linux and OS X (Windows to be tested)
* 99% pure Coffee-/JavaScript! :sunglasses:
2016-09-18 19:57:47 +02:00
2016-09-29 01:25:47 +02:00
2016-09-18 21:15:21 +02:00
## How to get it?
2016-09-18 19:57:47 +02:00
2016-09-20 23:02:21 +02:00
* Make sure to have at least [node.js ](https://nodejs.org/ ) version 4 installed
2016-09-19 09:19:31 +02:00
* Install `termap` with
`npm install -g termap`
## How to use it?
2016-09-20 23:02:21 +02:00
#### Basic usage
2016-09-19 09:19:31 +02:00
* Start `termap` with
` termap`
2016-09-18 19:57:47 +02:00
2016-09-20 23:02:21 +02:00
2016-09-18 19:57:47 +02:00
## Behind the scenes
### Libraries
2016-09-20 22:36:22 +02:00
#### Mastering the console
2016-09-27 14:53:47 +02:00
* [`x256` ](https://github.com/substack/node-x256 ) for converting RGB values to closest xterm-256 [color code ](https://en.wikipedia.org/wiki/File:Xterm_256color_chart.svg )
2016-09-20 22:36:22 +02:00
* [`term-mouse` ](https://github.com/CoderPuppy/term-mouse ) for mouse handling
* [`keypress` ](https://github.com/TooTallNate/keypress ) for input handling
#### Discovering the map data
* [`node-mbtiles` ](https://github.com/mapbox/node-mbtiles ) for [MBTiles ](https://github.com/mapbox/mbtiles-spec/blob/master/1.2/spec.md ) parsing
* [`pbf` ](https://github.com/mapbox/pbf ) for [Protobuf ](https://developers.google.com/protocol-buffers/ ) decoding
2016-09-19 09:19:31 +02:00
* [`vector-tile-js` ](https://github.com/mapbox/vector-tile-js ) for [VectorTile ](https://github.com/mapbox/vector-tile-spec/tree/master/2.1 ) parsing
2016-09-20 22:36:22 +02:00
#### Juggling the vectors and numbers
2016-09-27 13:57:59 +02:00
* [`earcut` ](https://github.com/mapbox/earcut ) for polygon triangulation
2016-09-20 22:36:22 +02:00
* [`rbush` ](https://github.com/mourner/rbush ) for 2D spatial indexing based label and mouse collision detection
2016-09-21 17:35:16 +02:00
* [`gl-matrix` ](https://github.com/toji/gl-matrix ) for vector and matrix operations
2016-09-27 13:57:59 +02:00
* [`breseham` ](https://github.com/madbence/node-bresenham ) for line calculations
2016-09-20 22:40:25 +02:00
* [`sphericalmercator` ](https://github.com/mapbox/node-sphericalmercator ) for [EPSG:3857 ](http://spatialreference.org/ref/sr-org/6864/ ) < > [WGS84 ](http://spatialreference.org/ref/epsg/wgs-84/ ) conversions
2016-09-18 02:44:31 +02:00
2016-09-18 21:15:21 +02:00
### TODOs
2016-09-19 09:19:31 +02:00
* [ ] cli linking
2016-09-18 02:44:31 +02:00
* [ ] mapping of view to tiles to show
2016-09-21 23:40:08 +02:00
* [x] abstracted MapBox style JSON support
* [ ] giving render priority to features across layers (collect before render vs. direct)?
2016-09-21 06:19:36 +02:00
* [ ] line drawing
* [ ] support for stroke width
2016-09-21 23:40:08 +02:00
* [ ] support for dashed/dotted lines?
2016-09-18 02:44:31 +02:00
* [ ] label drawing
2016-09-19 09:19:31 +02:00
* [x] support for point labels
2016-09-20 20:52:49 +02:00
* [x] dynamic decluttering of labels
2016-09-21 15:41:44 +02:00
* [x] centering text labels
2016-09-27 14:53:47 +02:00
* [x] clipping fix when x< 0 after repositioning
2016-09-21 15:41:44 +02:00
* [ ] multi line label
* [ ] label margin to avoid POI overlap?
* [ ] translatable raster fonts
2016-09-21 00:50:40 +02:00
* [x] filled polygons
* [x] convert polygons to triangles
* [x] implement fillTriangle into drawille-canvas-blessed-contrib
2016-09-21 17:35:16 +02:00
* [ ] respect fill/line style file based setting
2016-09-18 15:26:09 +02:00
* [ ] lat/lng-center + zoom based viewport
2016-09-20 20:52:49 +02:00
* [ ] bbox awareness
* [ ] zoom -> scale calculation
2016-09-21 23:40:08 +02:00
* [ ] Tile parsing
* [ ] directly throw away features that aren't covered by any style
2016-09-18 15:26:09 +02:00
* [ ] TileSource class (abstracting URL, mbtiles, single vector tile source)
2016-09-19 09:19:31 +02:00
* [ ] tile request system
* [ ] from local mbtiles
* [ ] from remote url
* [ ] permanent caching of received files
2016-09-18 02:44:31 +02:00
* [ ] zoom while keeping center
* [ ] API
* [ ] setCenter
* [ ] setZoom
2016-09-20 21:46:31 +02:00
* [x] start with zoom level which shows full vector tile
2016-09-18 02:44:31 +02:00
* [x] accurate mouse drag& drop
2016-09-18 04:20:35 +02:00
* [x] handle console resize
2016-09-21 23:40:08 +02:00
* [x] styling
2016-09-19 09:19:31 +02:00
## License
2016-09-20 22:40:25 +02:00
#### The MIT License (MIT)
2016-09-19 09:19:31 +02:00
Copyright (c) 2016 Michael Straßburger
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
