https://github.com/rastapasta/mapscii Skip to content Sign up Sign up * Why GitHub? Features - + Mobile - + Actions - + Codespaces - + Packages - + Security - + Code review - + Project management - + Integrations - + GitHub Sponsors - + Customer stories- * Team * Enterprise * Explore + Explore GitHub - Learn and contribute + Topics - + Collections - + Trending - + Learning Lab - + Open source guides - Connect with others + The ReadME Project - + Events - + Community forum - + GitHub Education - + GitHub Stars program - * Marketplace * Pricing Plans - + Compare plans - + Contact Sales - + Education - [ ] [search-key] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this user All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up Sign up {{ message }} rastapasta / mapscii * Notifications * Star 5k * Fork 186 MapSCII is a Braille & ASCII world map renderer for your console - enter => telnet mapscii.me <= on Mac and Linux, connect with PuTTY on Windows MIT License 5k stars 186 forks Star Notifications * Code * Issues 28 * Pull requests 2 * Actions * Security * Insights More * Code * Issues * Pull requests * Actions * Security * Insights master Switch branches/tags [ ] Branches Tags Nothing to show {{ refName }} default View all branches Nothing to show {{ refName }} default View all tags 4 branches 8 tags Code Clone HTTPS GitHub CLI [https://github.com/r] Use Git or checkout with SVN using the web URL. [gh repo clone rastap] Work fast with our official CLI. Learn more. * Open with GitHub Desktop * Download ZIP Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Go back Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Go back Launching Xcode If nothing happens, download Xcode and try again. Go back Launching Visual Studio If nothing happens, download the GitHub extension for Visual Studio and try again. Go back Latest commit @dependabot dependabot Bump node-notifier from 8.0.0 to 8.0.1 (#96) ... 9be22c8 Dec 22, 2020 Bump node-notifier from 8.0.0 to 8.0.1 (#96) Bumps [node-notifier](https://github.com/mikaelbr/node-notifier) from 8.0.0 to 8.0.1. - [Release notes](https://github.com/mikaelbr/node-notifier/releases) - [Changelog](https://github.com/mikaelbr/node-notifier/blob/v8.0.1/CHANGELOG.md) - [Commits](mikaelbr/node-notifier@v8.0.0...v8.0.1) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 9be22c8 Git stats * 273 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github/ISSUE_TEMPLATE Stylize name as MapSCII Nov 19, 2018 bin optimizing select order of node installations Oct 25, 2017 snap Add the packaging metadata to build the mapscii snap Aug 9, 2017 src Remove bluebird (#94) Sep 8, 2020 styles optimizing draw order based on zoom level Nov 9, 2016 .eslintrc.js Make ESLint pass the current codebase Oct 10, 2019 .gitignore adding animated c-base demo to readme Apr 26, 2017 .npmignore [?] adding dependency check for node >=4.5 Apr 26, 2017 .travis.yml Raise the minimum NodeJS version to 10 (#84) May 28, 2020 AUTHORS Add lennonhill to the AUTHORS file Aug 11, 2020 LICENSE Start a dedicated AUTHORS file for copyright purposes Mar 25, 2019 README.md Remove bluebird (#94) Sep 8, 2020 main.js Change the unit of width and length options to full characters Aug 11, 2020 package-lock.json Bump node-notifier from 8.0.0 to 8.0.1 (#96) Dec 22, 2020 package.json Upgrade dependencies Sep 8, 2020 View code MapSCII - The Whole World In Your Console. Try it out! Features How to run it locally How to install it locally With npm With snap Running Keyboard shortcuts Mouse control 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) MapSCII README.md MapSCII - The Whole World In Your Console. Build Status A node.js based Vector Tile to Braille and ASCII renderer for xterm -compatible terminals. asciicast Try it out! $ telnet mapscii.me If you're on Windows, use the open source telnet client PuTTY to connect. 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 OSM2VectorTiles based one * Work offline and discover local VectorTile/MBTiles * Compatible with most Linux and OSX terminals * Highly optimized algorithms for a smooth experience * 100% pure JavaScript! 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 * Arrows up, down, left, right to scroll around * Press a or z to zoom in and out * Press c to switch to block character mode * 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 * string-width to determine visual string lengths 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 of geo and label data * bresenham for line point calculations * simplify-js for polyline simplifications Handling the flow * node-fetch for HTTP requests * env-paths to determine where to persist downloaded tiles TODOs * MapSCII + [ ] GeoJSON support via geojson-vt + [ ] CLI support o [-] startup parameters # [*] TileSource # [*] Style # [*] center position # [*] zoom # [ ] demo mode? + [ ] mouse control o [ ] hover POIs/labels o [ ] hover maybe even polygons/-lines? * Styler + [ ] respect zoom based style ranges * Renderer + [ ] download and process tiles in a different thread (#3) + [ ] optimize renderer for large areas (#6) + [ ] label drawing o [ ] multi line label? * TileSource + [ ] implement single vector-tile handling Special thanks * lukasmartinelli & manuelroth for all their work on OSM2VectorTiles (global vector tiles from OSM Planet) * mourner for all his work on mindblowing GIS algorithms (like the used earcut, rbush, simplify-js, ..) 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 * License * Authors About MapSCII is a Braille & ASCII world map renderer for your console - enter => telnet mapscii.me <= on Mac and Linux, connect with PuTTY on Windows Topics map console vector-tiles openstreetmap ascii-art braille console-application Resources Readme License MIT License Releases 8 Upstream fix for escape key handling Latest Feb 18, 2020 + 7 releases Packages 0 No packages published Used by 3 * @jisantuc @jisantuc / stac-repl * @carstenmichel @carstenmichel / ebaCliWeatherClient Contributors 11 * * * * * * * * * * * Languages * JavaScript 99.6% * Shell 0.4% * (c) 2021 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.