README.md

OpenMapTiles

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 and openmaptiles.com.

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 to simplify vector tile creation.

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.

• 🔗 Schema https://openmaptiles.org/schema
• 🔗 Docs https://openmaptiles.org/docs
• 🔗 Production package: https://openmaptiles.com/production-package/
• 🔗 Hosting https://www.maptiler.com/cloud/
• 🔗 Create own layer https://github.com/openmaptiles/openmaptiles-skiing
• 🔗 Discuss at the #openmaptiles channel at OSM Slack

Styles

You can start from several GL styles supporting the OpenMapTiles vector schema.

🔗 Learn how to create Mapbox GL styles with Maputnik and OpenMapTiles.

• OSM Bright
• Positron
• Dark Matter
• Klokantech Basic
• Klokantech 3D
• Fiord Color
• Toner
• OSM Liberty

We also ported over our favorite old raster styles (TM2).

🔗 Learn how to create TM2 styles with Mapbox Studio Classic and OpenMapTiles.

• Light
• Dark
• OSM Bright
• Pencil
• Woodcut
• Pirates
• Wheatpaste

Schema

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.

🔗 Study the vector tile schema

• aeroway
• boundary
• building
• housenumber
• landcover
• landuse
• mountain_peak
• park
• place
• poi
• transportation
• transportation_name
• water
• water_name
• waterway

Develop

To work on OpenMapTiles you need Docker.

• Install Docker. Minimum version is 1.12.3+.
• Install Docker Compose. Minimum version is 1.7.1+.

Build

Build the tileset.

git clone git@github.com:openmaptiles/openmaptiles.git
cd openmaptiles
# Build the imposm mapping, the tm2source project and collect all SQL scripts
make

You can execute the following manual steps (for better understanding) or use the provided quickstart.sh script.

./quickstart.sh

Prepare the Database

Now start up the database container.

docker-compose up -d postgres

Import external data from OpenStreetMapData, Natural Earth and OpenStreetMap Lake Labels.

docker-compose run import-water
docker-compose run import-natural-earth
docker-compose run import-lakelines
docker-compose run import-osmborder

Download OpenStreetMap data extracts and store the PBF file in the ./data directory.

cd data
wget http://download.geofabrik.de/europe/albania-latest.osm.pbf

Import OpenStreetMap data with the mapping rules from build/mapping.yaml (which has been created by make).

docker-compose run import-osm

Work on Layers

Each time you modify layer SQL code run make and make import-sql.

make clean && make && make import-sql

Now you are ready to generate the vector tiles. Using environment variables you can limit the bounding box and zoom levels of what you want to generate (docker-compose.yml).

docker-compose run generate-vectortiles

License

All code in this repository is under the BSD license and the cartography decisions encoded in the schema and SQL are licensed under CC-BY.

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.

For a browsable electronic map based on OpenMapTiles and OpenStreetMap data, the credit should appear in the corner of the map. For example:

© OpenMapTiles © OpenStreetMap contributors

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.