2017-01-08 21:41:46 +00:00
## OpenMapTiles [![Build Status](https://travis-ci.org/openmaptiles/openmaptiles.svg?branch=master)](https://travis-ci.org/openmaptiles/openmaptiles)
2016-10-05 17:47:00 +00:00
2019-05-07 11:36:07 +00:00
OpenMapTiles is an extensible and open tile schema based on the OpenStreetMap. It is used to generate vector tiles for online zoomable maps. The project is about creating a beautiful basemaps with general layers that contain topographic information. More information [openmaptiles.org ](https://openmaptiles.org/ ) and [openmaptiles.com ](https://openmaptiles.com/ ).
2016-10-30 15:31:38 +00:00
2019-03-22 08:34:00 +00:00
We encourage you to collaborate, reuse and adapt existing layers and add your own layers or use our approach for your own vector tile project. Feel free to fork the repo and experiment. The repository is built on top of the [openmaptiles/openmaptiles-tools ](https://github.com/openmaptiles/openmaptiles-tools ) to simplify vector tile creation.
2017-01-06 12:40:50 +00:00
2019-05-06 12:41:37 +00:00
Please keep in mind that OpenMapTiles schema should stay displaying general topographic content. In case of creating a new layer or expanding an existing one with a specific theme, please create a fork and invite other community members to cooperate on your topic in this separate fork. OpenMapTiles schema is used in many projects all over the world and the size of the final vector tiles needs to be considered in any update.
2019-03-04 15:49:20 +00:00
- :link: Schema https://openmaptiles.org/schema
2019-05-06 12:41:37 +00:00
- :link: Docs https://openmaptiles.org/docs
2019-03-04 15:49:20 +00:00
- :link: Production package: https://openmaptiles.com/production-package/
- :link: Hosting https://www.maptiler.com/cloud/
2019-05-07 11:36:07 +00:00
- :link: Create own layer https://github.com/openmaptiles/openmaptiles-skiing
2019-05-06 12:41:37 +00:00
- :link: Discuss at the #openmaptiles channel at [OSM Slack ](https://osmus-slack.herokuapp.com/ )
2016-11-30 19:40:02 +00:00
## Styles
2017-01-06 12:40:50 +00:00
You can start from several GL styles supporting the OpenMapTiles vector schema.
:link: [Learn how to create Mapbox GL styles with Maputnik and OpenMapTiles ](http://openmaptiles.org/docs/style/maputnik/ ).
2016-11-30 19:40:02 +00:00
- [OSM Bright ](https://github.com/openmaptiles/osm-bright-gl-style )
- [Positron ](https://github.com/openmaptiles/positron-gl-style )
- [Dark Matter ](https://github.com/openmaptiles/dark-matter-gl-style )
- [Klokantech Basic ](https://github.com/openmaptiles/klokantech-basic-gl-style )
2017-01-06 12:40:50 +00:00
- [Klokantech 3D ](https://github.com/openmaptiles/klokantech-3d-gl-style )
- [Fiord Color ](https://github.com/openmaptiles/fiord-color-gl-style )
- [Toner ](https://github.com/openmaptiles/toner-gl-style )
We also ported over our favorite old raster styles (TM2).
:link: [Learn how to create TM2 styles with Mapbox Studio Classic and OpenMapTiles ](http://openmaptiles.org/docs/style/mapbox-studio-classic/ ).
2016-10-06 05:35:10 +00:00
2017-01-06 12:40:50 +00:00
- [Light ](https://github.com/openmaptiles/mapbox-studio-light.tm2/ )
- [Dark ](https://github.com/openmaptiles/mapbox-studio-dark.tm2/ )
- [OSM Bright ](https://github.com/openmaptiles/mapbox-studio-osm-bright.tm2/ )
- [Pencil ](https://github.com/openmaptiles/mapbox-studio-pencil.tm2/ )
- [Woodcut ](https://github.com/openmaptiles/mapbox-studio-woodcut.tm2/ )
- [Pirates ](https://github.com/openmaptiles/mapbox-studio-pirates.tm2/ )
- [Wheatpaste ](https://github.com/openmaptiles/mapbox-studio-wheatpaste.tm2/ )
2016-10-30 15:14:28 +00:00
2017-01-06 12:40:50 +00:00
## Schema
2016-10-30 15:14:28 +00:00
2017-01-06 12:40:50 +00:00
OpenMapTiles consists out of a collection of documented and self contained layers you can modify and adapt.
Together the layers make up the OpenMapTiles tileset.
2016-10-30 15:14:28 +00:00
2017-01-06 12:40:50 +00:00
:link: [Study the vector tile schema ](http://openmaptiles.org/schema )
2016-10-30 15:14:28 +00:00
2017-04-09 20:56:24 +00:00
- [aeroway ](https://openmaptiles.org/schema/#aeroway )
- [boundary ](https://openmaptiles.org/schema/#boundary )
- [building ](https://openmaptiles.org/schema/#building )
- [housenumber ](https://openmaptiles.org/schema/#housenumber )
- [landcover ](https://openmaptiles.org/schema/#landcover )
- [landuse ](https://openmaptiles.org/schema/#landuse )
- [mountain_peak ](https://openmaptiles.org/schema/#mountain_peak )
- [park ](https://openmaptiles.org/schema/#park )
- [place ](https://openmaptiles.org/schema/#place )
- [poi ](https://openmaptiles.org/schema/#poi )
- [transportation ](https://openmaptiles.org/schema/#transportation )
- [transportation_name ](https://openmaptiles.org/schema/#transportation_name )
- [water ](https://openmaptiles.org/schema/#water )
- [water_name ](https://openmaptiles.org/schema/#water_name )
- [waterway ](https://openmaptiles.org/schema/#waterway )
2016-10-30 15:14:28 +00:00
2016-10-30 15:31:38 +00:00
## Develop
2016-10-06 05:35:10 +00:00
2019-03-22 08:34:00 +00:00
To work on OpenMapTiles you need Docker.
2016-10-06 05:35:10 +00:00
2017-05-11 23:34:25 +00:00
- Install [Docker ](https://docs.docker.com/engine/installation/ ). Minimum version is 1.12.3+.
2017-04-14 00:06:46 +00:00
- Install [Docker Compose ](https://docs.docker.com/compose/install/ ). Minimum version is 1.7.1+.
2016-10-23 15:36:48 +00:00
### Build
Build the tileset.
2016-11-02 13:48:32 +00:00
```bash
2016-12-05 12:43:26 +00:00
git clone git@github.com:openmaptiles/openmaptiles.git
2016-12-05 13:01:35 +00:00
cd openmaptiles
2016-10-24 19:49:23 +00:00
# Build the imposm mapping, the tm2source project and collect all SQL scripts
2016-10-23 15:36:48 +00:00
make
```
2016-10-06 05:35:10 +00:00
2017-01-06 11:01:36 +00:00
You can execute the following manual steps (for better understanding)
or use the provided `quickstart.sh` script.
```
./quickstart.sh
```
2016-10-06 05:35:10 +00:00
### Prepare the Database
Now start up the database container.
```bash
2016-11-02 13:48:32 +00:00
docker-compose up -d postgres
2016-10-06 05:35:10 +00:00
```
2019-05-20 09:58:34 +00:00
Import external data from [OpenStreetMapData ](http://osmdata.openstreetmap.de/ ), [Natural Earth ](http://www.naturalearthdata.com/ ) and [OpenStreetMap Lake Labels ](https://github.com/lukasmartinelli/osm-lakelines ).
2016-10-06 05:35:10 +00:00
```bash
docker-compose run import-water
docker-compose run import-natural-earth
2016-10-28 14:54:42 +00:00
docker-compose run import-lakelines
2017-01-20 13:04:49 +00:00
docker-compose run import-osmborder
2016-10-28 14:54:42 +00:00
```
2017-01-26 08:27:05 +00:00
[Download OpenStreetMap data extracts ](http://download.geofabrik.de/ ) and store the PBF file in the `./data` directory.
```bash
cd data
wget http://download.geofabrik.de/europe/albania-latest.osm.pbf
```
2018-03-21 18:11:33 +00:00
[Import OpenStreetMap data ](https://github.com/openmaptiles/import-osm ) with the mapping rules from
2016-11-02 13:48:32 +00:00
`build/mapping.yaml` (which has been created by `make` ).
2016-10-06 06:25:00 +00:00
```bash
docker-compose run import-osm
```
2016-10-23 15:36:48 +00:00
### Work on Layers
2016-10-06 05:35:10 +00:00
2019-03-22 08:34:00 +00:00
Each time you modify layer SQL code run `make` and `make import-sql` .
2016-10-06 05:35:10 +00:00
2016-10-23 15:36:48 +00:00
```
2019-03-22 08:34:00 +00:00
make clean & & make & & make import-sql
2016-10-06 05:35:10 +00:00
```
2017-01-07 14:18:56 +00:00
Now you are ready to **generate the vector tiles** . Using environment variables
2016-10-30 15:31:38 +00:00
you can limit the bounding box and zoom levels of what you want to generate (`docker-compose.yml`).
```
docker-compose run generate-vectortiles
```
2016-10-06 05:55:00 +00:00
## License
2017-06-12 15:53:47 +00:00
All code in this repository is under the [BSD license ](./LICENSE.md ) and the cartography decisions encoded in the schema and SQL are licensed under [CC-BY ](./LICENSE.md ).
2017-01-06 12:40:50 +00:00
2019-05-07 11:36:07 +00:00
Products or services using maps derived from OpenMapTiles schema need to visibly credit "OpenMapTiles.org" or reference "OpenMapTiles" with a link to https://openmaptiles.org/. Exceptions to attribution requirement can be granted on request.
2017-01-07 16:31:33 +00:00
For a browsable electronic map based on OpenMapTiles and OpenStreetMap data, the
credit should appear in the corner of the map. For example:
2019-05-07 11:36:07 +00:00
[© OpenMapTiles ](https://openmaptiles.org/ ) [© OpenStreetMap contributors ](https://www.openstreetmap.org/copyright )
2017-01-07 16:31:33 +00:00
For printed and static maps a similar attribution should be made in a textual
description near the image, in the same fashion as if you cite a photograph.