Home

Awesome

MapSCII - The Whole World In Your Console. Build Status

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

<a href="https://asciinema.org/a/117813?autoplay=1" target="_blank">asciicast</a>

Try it out!

$ telnet mapscii.me

If you're on Windows, use the open source telnet client PuTTY to connect.

Features

How to run it locally

With a modern node installation available, just start it with

npx mapscii

How to install it locally

With npm

If you haven't already got Node.js >= version 10, 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

With snap

In any of the supported Linux distros:

sudo snap install mapscii

(This snap is maintained by @nathanhaines)

Running

This is pretty simple too.

mapscii

Keyboard shortcuts

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

Discovering the map data

Juggling the vectors and numbers

Handling the flow

TODOs

Special thanks

Licenses

Map data

The Open Data Commons Open Database License (oDbl)

OpenStreetMap is open data, licensed under the Open Data Commons Open Database License (ODbL) by the OpenStreetMap Foundation (OSMF).

You are free to copy, distribute, transmit and adapt our data, as long as you credit OpenStreetMap and its contributors. If you alter or build upon our data, you may distribute the result only under the same licence. The full legal code explains your rights and responsibilities.

The cartography in our map tiles, and our documentation, are licenced under the Creative Commons Attribution-ShareAlike 2.0 licence (CC BY-SA).

MapSCII