Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/protomaps/basemaps
Basemap PMTiles generation and cartographic styles for OpenStreetMap data and more
https://github.com/protomaps/basemaps
cartography maplibre maps openlayers openstreetmap pmtiles
Last synced: 1 day ago
JSON representation
Basemap PMTiles generation and cartographic styles for OpenStreetMap data and more
- Host: GitHub
- URL: https://github.com/protomaps/basemaps
- Owner: protomaps
- License: other
- Created: 2020-04-24T07:46:47.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-24T04:04:11.000Z (9 days ago)
- Last Synced: 2025-01-24T11:01:37.709Z (9 days ago)
- Topics: cartography, maplibre, maps, openlayers, openstreetmap, pmtiles
- Language: Java
- Homepage: https://maps.protomaps.com/
- Size: 3.5 MB
- Stars: 410
- Watchers: 11
- Forks: 56
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Protomaps Basemaps
Build a cartographic "basemap" PMTiles from OpenStreetMap + other datasources, plus MapLibre styles for displaying them in a browser.
To get started, check out some basic examples:
* [display markers on a map](https://maps.protomaps.com/examples/basic.html)
* [change the map theme and language](https://maps.protomaps.com/examples/theme_language.html)
* [sandwich data between map layers](https://maps.protomaps.com/examples/data_sandwich.html)
This repository is organized into parts:
* `app`: A single-page app, [maps.protomaps.com](maps.protomaps.com) for viewing and downloading basemap builds.
* `tiles/`: A [Planetiler](https://github.com/onthegomap/planetiler) build profile that generates `planet.pmtiles` from OpenStreetMap and Natural Earth in 2-3 hours on a modest computer.
* `styles/`: A TypeScript package that generates [MapLibre GL](http://github.com/maplibre) styles, in multiple color themes, that can be used via `npm` or exported as JSON.
Assets such as fonts and sprites are hosted and downloadable at the [basemaps-assets](https://github.com/protomaps/basemaps-assets) repository.
## Development
You will need [Java 21+](https://github.com/onthegomap/planetiler/blob/main/CONTRIBUTING.md) and [Maven](https://maven.apache.org/install.html) installed, which is available in most package managers.
Generate and inspect a basemap PMTiles of any named area:
1. Clone this repository.
```shell
git clone [email protected]:protomaps/basemaps.git
```
2. change to the `tiles` directory, download dependencies and compile the JAR:
```shell
cd basemaps/tiles
mvn clean package
```
3. Download and generate `monaco.pmtiles` in the current directory:
```shell
java -jar target/*-with-deps.jar --download --force --area=monaco
```
4. Switch to the `app/` directory to run the map frontend:
```shell
cd app
nvm use
npm ci
npm run dev
```
The locally generated pmtiles can be fetched from http://localhost:5173/monaco.pmtiles
5. Linting to apply code formatting
```shell
mvn spotless:apply
```
## Licensing and Attribution Guidelines
Summary:
* All code is BSD-3
* Map design is CC0
* Tilesets are ODbL, attribute OSM
* We like shoutouts!
* Name your fork, commercial product or service something different
We kindly request that you attribute the Protomaps project if you use the basemap styles unmodified or with additions, but you are not required to do so. The visual design copyright of the maps is released under a [Creative Commons Zero (CC0) license](https://creativecommons.org/publicdomain/zero/1.0/) to eliminate ambiguity around derivative or combined works of map styling code, and to publish software, such as NPM packages, under the standard BSD-3 license.
The tilesets that power the Protomaps basemap are [Produced Works of the OpenStreetMap dataset](https://osmfoundation.org/wiki/Licence/Community_Guidelines/Produced_Work_-_Guideline) under the [Open Database License](https://www.openstreetmap.org/copyright). Web maps and native apps that use this Produced Work must visibly attribute © OpenStreetMap - for example, in the corner of the map display. If your map only uses the Map Styles with non-OpenStreetMap tilesets, this attribution is not required.
Example web map corner attribution:
```html
Protomaps © OpenStreetMap
```
Tilesets also include data from [Natural Earth](https://www.naturalearthdata.com) and other sources, which does not require corner attribution. Other data sources your map uses may require additional attribution: See [LICENSE_DATA.md](/LICENSE_DATA.md).
Depending on map style, MIT-licensed icons may also be included from the [Tangram Icons repository](https://github.com/tangrams/icons/issues).
The software in this repository is made available under a [BSD 3-Clause License](/LICENSE.md), and includes license notices related to Protomaps LLC, Mapzen, and the Linux Foundation. You must retain these license notices in software source code derived from this repository.
If you distribute a modified “fork” of these basemap styles or tilesets, or provide a tiles API based on them, you must name your product or service something different from Protomaps. Free and unmodified redistributions of tiles and styles are permitted to use the name. No restrictions apply to the underlying technology `.pmtiles` which is an [open specification in the public domain.](https://github.com/protomaps/PMTiles#license)
These guidelines are subject to change with the addition of other open datasets. Any questions can be addressed to [[email protected]](mailto:[email protected]).