{"id":13403219,"url":"https://github.com/rastapasta/mapscii","last_synced_at":"2026-10-18T22:25:47.981Z","repository":{"id":39737983,"uuid":"68485692","full_name":"rastapasta/mapscii","owner":"rastapasta","description":"🗺  MapSCII is a Braille \u0026 ASCII world map renderer for your console - enter =\u003e telnet mapscii.me \u003c= on Mac (brew install telnet) and Linux, connect with PuTTY on Windows","archived":false,"fork":false,"pushed_at":"2024-11-03T16:02:52.000Z","size":13940,"stargazers_count":9259,"open_issues_count":54,"forks_count":299,"subscribers_count":114,"default_branch":"master","last_synced_at":"2026-10-15T02:49:26.226Z","etag":null,"topics":["ascii-art","braille","console","console-application","map","openstreetmap","vector-tiles"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rastapasta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-09-18T00:40:43.000Z","updated_at":"2026-10-14T16:50:15.000Z","dependencies_parsed_at":"2024-11-25T16:05:48.249Z","dependency_job_id":"f82ad491-b21a-4e26-b7f6-cc257b961a9d","html_url":"https://github.com/rastapasta/mapscii","commit_stats":{"total_commits":254,"total_committers":14,"mean_commits":"18.142857142857142","dds":"0.42913385826771655","last_synced_commit":"4fe9a60a0c9da952dadc5214a9ca5c68c447fdf8"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/rastapasta/mapscii","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rastapasta%2Fmapscii","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rastapasta%2Fmapscii/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rastapasta%2Fmapscii/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rastapasta%2Fmapscii/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rastapasta","download_url":"https://codeload.github.com/rastapasta/mapscii/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rastapasta%2Fmapscii/sbom","scorecard":{"id":762494,"data":{"date":"2025-08-11","repo":{"name":"github.com/rastapasta/mapscii","commit":"4fe9a60a0c9da952dadc5214a9ca5c68c447fdf8"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 1/12 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":1,"reason":"0 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":["Info: Possibly incomplete results: error parsing shell code: \"foo(\" must be followed by ): bin/mapscii.sh:0"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":5,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'master'","Info: 'force pushes' disabled on branch 'master'","Info: 'branch protection settings apply to administrators' is required to merge on branch 'master'","Warn: 'stale review dismissal' is disabled on branch 'master'","Warn: required approving review count is 1 on branch 'master'","Warn: codeowners review is not required on branch 'master'","Warn: 'last push approval' is disabled on branch 'master'","Warn: no status checks found to merge onto branch 'master'","Info: PRs are required in order to make changes on branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 22 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"14 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T23:48:45.899Z","repository_id":39737983,"created_at":"2025-08-22T23:48:45.899Z","updated_at":"2025-08-22T23:48:45.899Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38342752,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ascii-art","braille","console","console-application","map","openstreetmap","vector-tiles"],"created_at":"2024-07-30T19:01:26.979Z","updated_at":"2026-10-18T22:25:46.801Z","avatar_url":"https://github.com/rastapasta.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Utilities","User Interaction","Geography and maps","Applications","others","Interaction","CoffeeScript","Miscellaneous","Clients","\\*nix/\\*nux","Table of Contents","\u003ca name=\"graphics\"\u003e\u003c/a\u003eGraphics","Other","ASCII UI/UX Apps"],"sub_categories":["Browser Replacement","Command Line Interface","Looking for software, projects, courses or inspiration?","Utilities","Command Line","Fancy stuff","Productivity","Mathematics"],"readme":"# MapSCII - The Whole World In Your Console. [![Build Status](https://travis-ci.com/rastapasta/mapscii.svg?branch=master)](https://travis-ci.com/rastapasta/mapscii)\n\nA node.js based [Vector Tile](http://wiki.openstreetmap.org/wiki/Vector_tiles) to [Braille](http://www.fileformat.info/info/unicode/block/braille_patterns/utf8test.htm) and [ASCII](https://de.wikipedia.org/wiki/American_Standard_Code_for_Information_Interchange) renderer for [xterm](https://en.wikipedia.org/wiki/Xterm)-compatible terminals.\n\n\u003ca href=\"https://asciinema.org/a/117813?autoplay=1\" target=\"_blank\"\u003e![asciicast](https://cloud.githubusercontent.com/assets/1259904/25480718/497a64e2-2b4a-11e7-9cf0-ed52ee0b89c0.png)\u003c/a\u003e\n\n## Try it out!\n\n```sh\n$ telnet mapscii.me\n```\n\nIf you're on Windows, use the open source telnet client [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) to connect.\n\n## Features\n\n* Use your mouse to drag and zoom in and out!\n* Discover Point-of-Interests around any given location\n* Highly customizable layer styling with [Mapbox Styles](https://www.mapbox.com/mapbox-gl-style-spec/) support\n* Connect to any public or private vector tile server\n* Or just use the supplied and optimized [OSM2VectorTiles](https://github.com/osm2vectortiles) based one\n* Work offline and discover local [VectorTile](https://github.com/mapbox/vector-tile-spec)/[MBTiles](https://github.com/mapbox/mbtiles-spec)\n* Compatible with most Linux and OSX terminals\n* Highly optimized algorithms for a smooth experience\n* 100% pure JavaScript! :sunglasses:\n\n## How to run it locally\n\nWith a modern node installation available, just start it with\n\n```\nnpx mapscii\n```\n\n## How to install it locally\n\n### With npm\n\nIf you haven't already got Node.js \u003e= version 10, then [go get it](http://nodejs.org/).\n\n```\nnpm install -g mapscii\n```\n\nIf you're on OSX, or get an error about file permissions, you may need to do ```sudo npm install -g mapscii```\n\n### With snap\n\nIn any of the [supported Linux distros](https://snapcraft.io/docs/core/install):\n\n    sudo snap install mapscii\n    \n(This snap is maintained by [@nathanhaines](https://github.com/nathanhaines/))\n\n## Running\n\nThis is pretty simple too.\n\n```\nmapscii\n```\n\n## Keyboard shortcuts\n\n* Arrows **up**, **down**, **left**, **right** to scroll around\n* Press **a** or **z** to zoom in and out\n* Press **c** to switch to block character mode\n* Press **q** to quit\n\n## Mouse control\n\nIf your terminal supports mouse events you can drag the map and use your scroll wheel to zoom in and out.\n\n## Behind the scenes\n### Libraries\n#### Mastering the console\n  * [`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)\n  * [`term-mouse`](https://github.com/CoderPuppy/term-mouse) for mouse handling\n  * [`keypress`](https://github.com/TooTallNate/keypress) for input handling\n  * [`string-width`](https://github.com/sindresorhus/string-width) to determine visual string lengths\n\n#### Discovering the map data\n* [`vector-tile`](https://github.com/mapbox/vector-tile-js) for [VectorTile](https://github.com/mapbox/vector-tile-spec/tree/master/2.1) parsing\n* [`pbf`](https://github.com/mapbox/pbf) for [Protobuf](https://developers.google.com/protocol-buffers/) decoding\n* [`mbtiles`](https://github.com/mapbox/node-mbtiles) for [MBTiles](https://github.com/mapbox/mbtiles-spec/blob/master/1.2/spec.md) parsing\n\n#### Juggling the vectors and numbers\n* [`earcut`](https://github.com/mapbox/earcut) for polygon triangulation\n* [`rbush`](https://github.com/mourner/rbush) for 2D spatial indexing of geo and label data\n* [`bresenham`](https://github.com/madbence/node-bresenham) for line point calculations\n* [`simplify-js`](https://github.com/mourner/simplify-js) for polyline simplifications\n\n#### Handling the flow\n* [`node-fetch`](https://github.com/bitinn/node-fetch) for HTTP requests\n* [`env-paths`](https://github.com/sindresorhus/env-paths) to determine where to persist downloaded tiles\n\n### TODOs\n* MapSCII\n  * [ ] GeoJSON support via [geojson-vt](https://github.com/mapbox/geojson-vt)\n  * [ ] CLI support\n    * [-] startup parameters\n      * [X] TileSource\n      * [X] Style\n      * [X] center position\n      * [X] zoom\n      * [ ] demo mode?\n\n  * [ ] mouse control\n    * [ ] hover POIs/labels\n    * [ ] hover maybe even polygons/-lines?\n\n* Styler\n  * [ ] respect zoom based style ranges\n\n* Renderer\n  * [ ] download and process tiles in a different thread ([#3](https://github.com/rastapasta/mapscii/issues/3))\n  * [ ] optimize renderer for large areas ([#6](https://github.com/rastapasta/mapscii/issues/6))\n  * [ ] label drawing\n    * [ ] multi line label?\n\n* TileSource\n  * [ ] implement single vector-tile handling\n\n## Special thanks\n\n* [lukasmartinelli](https://github.com/lukasmartinelli) \u0026 [manuelroth](https://github.com/manuelroth) for all their work on [OSM2VectorTiles](https://github.com/osm2vectortiles) (global vector tiles from [OSM Planet](https://wiki.openstreetmap.org/wiki/Planet.osm))\n* [mourner](https://github.com/mourner) for all his work on mindblowing GIS algorithms (like the used [earcut](https://github.com/mapbox/earcut), [rbush](https://github.com/mourner/rbush), [simplify-js](https://github.com/mourner/simplify-js), ..)\n\n## Licenses\n\n### Map data\n\n#### The Open Data Commons Open Database License (oDbl)\n\n[OpenStreetMap](https://www.openstreetmap.org) is open data, licensed under the [Open Data Commons Open Database License](http://opendatacommons.org/licenses/odbl/) (ODbL) by the [OpenStreetMap Foundation](http://osmfoundation.org/) (OSMF).\n\nYou 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](http://opendatacommons.org/licenses/odbl/1.0/) explains your rights and responsibilities.\n\nThe cartography in our map tiles, and our documentation, are licenced under the [Creative Commons Attribution-ShareAlike 2.0](http://creativecommons.org/licenses/by-sa/2.0/) licence (CC BY-SA).\n\n### MapSCII\n* [License](./LICENSE)\n* [Authors](./AUTHORS)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frastapasta%2Fmapscii","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frastapasta%2Fmapscii","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frastapasta%2Fmapscii/lists"}