mapscii/README.md

MapSCII - The Whole World In Your Console.

A node.js based Vector Tile to Braille and ASCII renderer for xterm-compatible terminals.

Features

• Use your mouse to drag and zoom in and out
• Discover Point-of-Interests around any given location
• Highly customizable layer styling with Mapbox Styles support
• Connect to any public or private vector tile server
• Or just use the supplied and optimized OpenStreetMap based one
• Work offline and discover local VectorTile/MBTiles
• Compatible with most Linux and OSX terminals
• Highly optimizied algorithms for a smooth experience
• 100% pure Coffee-/JavaScript! 😎

How to install

If you haven't already got Node.js >= version 4, then go get it.

npm install -g mapscii

If you're on OSX, or get an error about file permissions, you may need to do sudo npm install -g mapscii

Running

This is pretty simple too.

mapscii

Keyboard shortcuts

• Arrows up, down, left, right to scroll around
• Press a or z to zoom in and out
• Press q to quit

Mouse control

If your terminal supports mouse events you can drag the map and use your scroll wheel to zoom in and out.

Behind the scenes

Libraries

Mastering the console

• x256 for converting RGB values to closest xterm-256 color code
• term-mouse for mouse handling
• keypress for input handling

Discovering the map data

• vector-tile for VectorTile parsing
• pbf for Protobuf decoding
• mbtiles for MBTiles parsing

Juggling the vectors and numbers

• earcut for polygon triangulation
• rbush for 2D spatial indexing based label and mouse collision detection
• breseham for line calculations
• sphericalmercator for EPSG:3857 <> WGS84 conversions
• tilebelt for some slippy map tilename calculations

Handling the flow

• bluebird for all the asynchronous Promise magic
• request-promise for promisified HTTP request handling
• userhome to determine where to persist downloaded tiles

TODOs

• MapSCII

  • CLI support

    • startup parameters
      • TileSource
      • Style
      • center position
      • zoom
      • demo mode?

  • mouse control

    • accurate mouse drag&drop with instant update
    • hover POIs/labels
    • hover maybe even polygons/-lines?
    • get hover lat/lng
    • zoom into mouse pos

• Styler

  • respect zoom based style stops

• Renderer

  • polygons

    • holes
    • use rbush?

  • label drawing

    • multi line label?

• TileSource

  • implement single vector-tile handling

License

The MIT License (MIT)

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.