Code Monkey home page Code Monkey logo

osm-liberty's Introduction

OSM Liberty BSD licensed GitHub CI status

OSM Liberty

A free Mapbox GL basemap style for everyone with complete liberty to use and self host. OSM Liberty is a fork of OSM Bright based on free data sources with a mission for a clear good looking design for the everyday user. It is based on the vector tile schema of OpenMapTiles.

Preview OSM Liberty with Maputnik

Usage

You can use the style in your Mapbox GL maps.

By default, the vector tiles are served from OSM Americana Community Vector Tile Server and the raster tiles and sprites and glyphs directly from GitHub.

Another option is to create your own vector tiles with OpenMapTiles and host the tiles and assets yourself for complete liberty.

<!DOCTYPE html>
<html>
<head>
  <meta charset=utf-8 />
  <title>OSM Liberty</title>
  <meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />
  <style>
    body { margin:0; padding:0; }
    #map { position:absolute; top:0; bottom:0; width:100%; }
  </style>
  <script src='https://api.mapbox.com/mapbox-gl-js/v1.10.1/mapbox-gl.js'></script>
  <link href='https://api.mapbox.com/mapbox-gl-js/v1.10.1/mapbox-gl.css' rel='stylesheet' />
</head>
<body>
  <div id='map'></div>
  <script>
  var map = new mapboxgl.Map({
      container: 'map',
      style: 'https://maputnik.github.io/osm-liberty/style.json',
      center: [8.538961,47.372476],
      zoom: 5,
      hash: true
  });
  </script>
</body>
</html>

Data Sources

Map Design

The map design originates from OSM Bright but strives to reach a unobtrusive and clean design for everyday use. Colored relief shading from Natural Earth make the low zoom levels look good.

OSM Liberty Map demo

Edit the Style

You can edit the style directly online in Maputnik.

This style actually triggered the need for the development of Maputnik.

A pre-commit hook is included to validate and format the JSON styles using mapbox-gl-style-spec. To use, just install the NPM dev dependencies:

npm install

and then validate or format the style with

npm run validate
npm run format

Validation and reformatting will happen automatically on commit if you have the dependencies installed.

Icon Design

A Maki icon set using colors to distinguish between icon categories.

Maki is a living project and adds new icons over time, which means that there could be new icons that OSM Liberty could use for POIs. maki_list.py is a simple script to list both the names in OSM Liberty's iconset that don't map to any valid Maki name, and the Maki names that are not currently used in OSM Liberty's iconset. You can run the script with python3 maki_list.py.

Color Palette

Color Name Hex Value
Blue #5d60be
Light Blue #4898ff
Orange #d97200
Red #ba3827
Brown #725a50
Green #76a723

Modify Icons

When submitting a PR, no need to include the sprites. They will be automatically created when merging a PR.
The size 11 icons are included in the sprites for backward compatability. Please don't include new size 11 icons.

  1. Take the iconset.json and import it to the Maki Editor.
  2. Apply your changes and download the icons in SVG format and the iconset in JSON format. Save the downloaded SVGs from Maki Editor to the folder svgs_iconset.
  3. Mandatory if the updated iconset.json should become part of this repo: Format the JSON with cat iconset.json | jq -MS '.' for better legibility.
  4. There are also SVGs in the folder svgs_not_in_iconset. These are the SVGs for road shields, the dot used for city and town layers and the road area pattern which could not be modified using the Maki Editor. To modify these you could use e.g. Inkscape.
  5. Install the NPM dev dependencies: npm install to have spritezero-cli available (we're using a fork of https://github.com/mapbox/spritezero-cli ).
  6. Generate the low and high resolution sprites: npm run build_sprites

Have a look at ...

osm-liberty's People

Contributors

pathmapper avatar lukasmartinelli avatar orangemug avatar caerbannog avatar dschep avatar eva-j avatar dependabot[bot] avatar spinf avatar ldgeo avatar kylebarron avatar nlehuby avatar hywan avatar tityron avatar maxammann avatar klokan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.