Skip to content

Latest commit

 

History

History
138 lines (103 loc) · 4.96 KB

README.md

File metadata and controls

138 lines (103 loc) · 4.96 KB
Raw

tilepack

Download tiles for offline use, camping, hiking, marine navigation, etc.

Take a XYZ tile URL and pack the tile images into a MBTiles file.

gif

Installation Options

Homebrew (macOS/Linux)

brew tap eknowles/tools
brew install tilepack

Binary

Download the latest release from the releases page (Windows, macOS, Linux)

  • darwin (amd64)
  • darwin (arm64)
  • linux (x64)
  • windows (amd64)

Build from source

Requires Bun

git clone git@github.com:eknowles/tilepack.git
bun run build

Example

Download tiles for a bounding box in Monaco and create a PMTiles file. Max zoom level is 17 (enough to see streets), concurrency is 20 requests at a time.

tilepack \
  --input "https://tile.openstreetmap.org/{z}/{x}/{y}.png" \
  --output monoco.mbtiles \
  --minzoom 0 \
  --maxzoom 17 \
  --bbox=7.3915,43.714,7.4613,43.7598 \
  --concurrency 20

pmtiles convert monoco.mbtiles monoco.pmtiles
Duration 4.1s 
Processing zoom level 0 (1 tiles)
Processing zoom level 1 (1 tiles)
Processing zoom level 2 (1 tiles)
Processing zoom level 3 (1 tiles)
Processing zoom level 4 (1 tiles)
Processing zoom level 5 (1 tiles)
Processing zoom level 6 (1 tiles)
Processing zoom level 7 (1 tiles)
Processing zoom level 8 (1 tiles)
Processing zoom level 9 (1 tiles)
Processing zoom level 10 (1 tiles)
Processing zoom level 11 (1 tiles)
Processing zoom level 12 (1 tiles)
Processing zoom level 13 (4 tiles)
Processing zoom level 14 (16 tiles)
Processing zoom level 15 (56 tiles)
Processing zoom level 16 (182 tiles)
Processing zoom level 17 (624 tiles)
Finished processing all zoom levels
2024/08/18 09:02:45 convert.go:265: Pass 1: Assembling TileID set
2024/08/18 09:02:45 convert.go:296: Pass 2: writing tiles
100% |████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| (895/895, 42014 it/s)
2024/08/18 09:02:45 convert.go:350: # of addressed tiles:  895
2024/08/18 09:02:45 convert.go:351: # of tile entries (after RLE):  647
2024/08/18 09:02:45 convert.go:352: # of tile contents:  581
2024/08/18 09:02:45 convert.go:374: Total dir bytes:  1945
2024/08/18 09:02:45 convert.go:375: Average bytes per addressed tile: 2.17
2024/08/18 09:02:45 convert.go:345: Finished in  24.71ms

Usage

tilepack -i <input_url> [options]

Options

Option Description Default
-i, --input <input_url> The base URL for the XYZ tiles (required) N/A
-o, --output <output_file> The path where the MBTiles file will be saved output.mbtiles
--minzoom <min_zoom> The minimum zoom level to fetch tiles N/A
--maxzoom <max_zoom> The maximum zoom level to fetch tiles N/A
--bbox <bounding_box> The bounding box for the tile fetching in the format minLon,minLat,maxLon,maxLat N/A
--header <header> HTTP headers to include in tile requests. Use this option for each header N/A
--token <api_token> An API token for authenticated requests. Used in input URL N/A
--retry <retry_count> The number of retry attempts for failed requests 0
--format <image_format> The format of the tiles (e.g., png, jpeg) png
--concurrency <concurrent_requests> The number of concurrent requests to fetch tiles 15
-v, --version Show the version number N/A
-h, --help Show this help message N/A

Bounding box can be created using https://norbertrenner.de/osm/bbox.html

Converting to PMTiles

Once the MBTiles file is generated, you can convert it to a PMTiles.

pmtiles convert example.mbtiles example.pmtiles

Where to find map tile servers

You can find many tile servers tile services online, such as OSM, ArcGIS, Mapbox.

A google dork will help you find many tile servers such as weather radar, satellite imagery etc.

Disclaimer: Do not download tiles from a tile server without permission, read the terms of service or license agreement.

Contributing

Make an issue or PR if you have any suggestions or improvements.

Alternatives