Files
pupmap/www/basemaps-assets-main/README.md

32 lines
1.4 KiB
Markdown

# basemaps-assets
Fonts and sprites for [basemaps](https://github.com/protomaps/basemaps).
## Directory Structure
* `fonts/`: Contains PBF glyphs generated by [font-maker](https://github.com/maplibre/font-maker)
* Current fonts: `Noto Sans Regular`, `Noto Sans Medium`, `Noto Sans Italic`
* `sprites/v3`: Contains spritesheets generated by [spreet](https://github.com/flother/spreet), for each major version
* `light@x.png` - light and dark themed spritesheets at 1x and 2x pixel densities
## Fonts
The typefaces and font variants hosted and downloadable here are limited to only those used by [basemaps](https://github.com/protomaps/basemaps) and a Noto Sans alternate. It is not meant to include all possible variations or other fonts. If you want to generate fonts for your own use, use the examples in `scripts` and maintain your own repository.
## Linking to Assets in Styles
```
glyphs:'https://protomaps.github.io/basemaps-assets/fonts/{fontstack}/{range}.pbf'
```
## Downloading Assets
Use the `Code > Download ZIP` button on this repository page, or [this direct link](https://github.com/protomaps/basemaps-assets/archive/refs/heads/main.zip).
## License
The license for each group of assets is contained within that directory:
* `fonts/`: [SIL Open Font License](fonts/OFL.txt)
* `sprites/`: derived from [MIT-licensed tangrams/icons](https://github.com/tangrams/icons/blob/master/LICENSE.md)