Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maputnik/osm-liberty
A free Mapbox GL basemap style for everyone
https://github.com/maputnik/osm-liberty
cartography mapbox-gl mapbox-gl-js maps
Last synced: about 1 month ago
JSON representation
A free Mapbox GL basemap style for everyone
- Host: GitHub
- URL: https://github.com/maputnik/osm-liberty
- Owner: maputnik
- License: other
- Created: 2016-08-06T14:41:20.000Z (over 8 years ago)
- Default Branch: gh-pages
- Last Pushed: 2024-07-15T01:58:42.000Z (5 months ago)
- Last Synced: 2024-08-04T03:01:42.715Z (4 months ago)
- Topics: cartography, mapbox-gl, mapbox-gl-js, maps
- Language: Python
- Homepage:
- Size: 10.4 MB
- Stars: 406
- Watchers: 18
- Forks: 98
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - maputnik/osm-liberty - A free Mapbox GL basemap style for everyone (others)
README
# OSM Liberty [](https://github.com/maputnik/osm-liberty/blob/gh-pages/LICENSE.md) [](https://github.com/maputnik/osm-liberty/actions?query=workflow%3ACI)
A free Maplibre and 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](https://github.com/openmaptiles/openmaptiles).
**[Preview OSM Liberty with Maputnik](https://maplibre.org/maputnik/?style=https://maputnik.github.io/osm-liberty/style.json)**
## Usage
You can use the style in your Maplibre and Mapbox GL maps.
By default, the vector tiles are served from [Maptiler Cloud](https://www.maptiler.com/cloud/) and the relief shading, glyphs and sprites directly from GitHub.
You would need to create a [MapTiler](https://www.maptiler.com) account to get an access key and replace the placeholder {key} for the [vector source](https://github.com/maputnik/osm-liberty/blob/gh-pages/style.json#L11) with your own key.
Other options are:
- Create your own vector tiles with [OpenMapTiles](https://github.com/openmaptiles/openmaptiles) and host the tiles yourself for complete liberty.
- Use another vector tile source that is based on the vector tile schema of [OpenMapTiles](https://github.com/openmaptiles/openmaptiles)
## Data Sources
- [OpenMapTiles](http://openmaptiles.org/) as vector data source
- [Natural Earth Tiles](https://klokantech.github.io/naturalearthtiles/) for relief shading
- [Maki](https://www.mapbox.com/maki-icons/) as icon set
- [Orange Mug](https://github.com/orangemug/font-glyphs) as font glyphs
## 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.
[](https://maputnik.github.io/osm-liberty/)
## Edit the Style
You can [edit the style directly online in Maputnik](https://maplibre.org/maputnik?style=https://maputnik.github.io/osm-liberty/style.json).
This style actually triggered the need for the development of [Maputnik](https://github.com/maplibre/maputnik).
A pre-commit hook is included to validate and format the JSON styles using
[`maplibre-gl-style-spec`](https://www.npmjs.com/package/@maplibre/maplibre-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](https://github.com/mapbox/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. `sources_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 sources_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](https://www.mapbox.com/maki-icons/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](https://github.com/maputnik/osm-liberty/tree/gh-pages/svgs/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](https://github.com/maputnik/osm-liberty/tree/gh-pages/svgs/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](https://inkscape.org).
5. Generate the low and high resolution sprites: `npm run build_sprites`
## Have a look at ...
- [OSM Liberty Topo](https://github.com/nst-guide/osm-liberty-topo) - a topographic fork of OSM Liberty