You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Frédéric Rodrigo a3ce04fe23
Add landuse=salt_pond as water (#1000)
15 hours ago
.github Remove workaround for quickstart.sh (#998) 1 day ago
layers Add landuse=salt_pond as water (#1000) 15 hours ago
qa Removed TOOLS_VERSION, rewritten commands to use only docker-compose with TOOLS_VERSION inside .env. 9 months ago
.env Expose COPY_CONCURRENCY to users (#972) 4 weeks ago
.env-postgres Upgrade to tools v5 - rm import-osm, new downloader... (#785) 4 months ago
.gitignore Use tools v4 with on-the-fly boundary generation (#750) 6 months ago
BENCHMARKING.md fix formatting 1 year ago
CONTRIBUTING.md Use one pass docs image generation (#751) 8 months ago
LICENSE.md Create LICENSE.md 3 years ago
Makefile NOOP: Minor Makefile clean up (#994) 1 week ago
QUICKSTART.md write how to generate dc-config (#982) 2 weeks ago
README.md New generate-dc-config target, rm QUICKSTART_MIN/MAX_ZOOM (#915) 3 months ago
UPDATE.md Upgrade to tools v5 - rm import-osm, new downloader... (#785) 4 months ago
docker-compose-MINGW64.yml Special cache handling for Docker Toolbox on Windows (#957) 1 month ago
docker-compose.yml openmaptiles-tools: consider MIN_ZOOM/MAX_ZOOM env (#992) 6 days ago
openmaptiles.yaml adding hi(hindi),ta(tamil) and te(telugu) language (#973) 4 weeks ago
quickstart.sh Remove workaround for quickstart.sh (#998) 1 day ago

README.md

OpenMapTiles Build Status

OpenMapTiles is an extensible and open tile schema based on the OpenStreetMap. This project is used to generate vector tiles for online zoomable maps. OpenMapTiles is about creating a beautiful basemaps with general layers containing topographic information. More information openmaptiles.org and openmaptiles.com.

We encourage you to collaborate, reuse and adapt existing layers, or add your own layers. You may 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 display general topographic content. If creating a new layer or expanding an existing layer with a specific theme, please create a fork and invite other community members to cooperate on your topic. 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.

Styles

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

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

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

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

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

Develop

To work on OpenMapTiles you need Docker.

Build

Build the tileset.

git clone https://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 to automatically download and import given area. If area is not given, albania will be imported.

./quickstart.sh <area>

Prepare the Database

Now start up the database container.

make start-db

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

make import-data

Download OpenStreetMap data extracts from any source like Geofabrik, and store the PBF file in the ./data directory. To use a specific download source, use download-geofabrik, download-bbbike, or download-osmfr, or use download to make it auto-pick the area. You can use area=planet for the entire OSM dataset (very large). Note that if you have more than one data/*.osm.pbf file, every make command will always require area=... parameter (or you can just export area=... first).

make download area=albania

Import OpenStreetMap data with the mapping rules from build/mapping.yaml (which has been created by make). Run after any change in layers definition. Also create borders table using extra processing with osmborder tool.

make import-osm
make import-borders

Import labels from Wikidata. If an OSM feature has Key:wikidata, OpenMapTiles check corresponding item in Wikidata and use its labels for languages listed in openmaptiles.yaml. So the generated vector tiles includes multi-languages in name field.

This step uses Wikidata Query Service to download just the Wikidata IDs that already exist in the database.

make import-wikidata

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. By default, ./.env specifies the entire planet BBOX for zooms 0-7, but running generate-dc-config will analyze the data file and set the BBOX param to limit tile generation. It will also modify MIN_ZOOM and MAX_ZOOM values based on the .env, but can be changed.

make generate-dc-config  # compute data bbox -- not needed for the whole planet
make generate-tiles      # generate tiles

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.