Mkgmap

From OpenStreetMap Wiki
Jump to navigation Jump to search

OSM Map On Garmin

Mkgmap is a command line utility that converts OpenStreetMap data into vector maps that can be loaded onto a Garmin GPS device. It does the conversion in one step without depending on any other program. Mkgmap only supports the OSM map data format.

Mkgmap main features

mkgmap
Colorado-300-routing-osm-maps-automotive-view.png
License: GNU GPL
Platforms: Windows, Linux, and macOS
Version: 4587 (2020-10-22)
Website: http://www.mkgmap.org.uk
Source code: http://www.mkgmap.org.uk/svn/list
Programming language: Java

Make OSM maps for your Garmin device

Features
Feature Value
Map Display

(Not set)

Routing

(Not set)

Navigating

(Not set)

Tracking

(Not set)

Monitoring

(Not set)

Editing

(Not set)

Rendering

(Not set)

Accessibility

(Not set)

  • Creates maps for Garmin GPS devices using OSM data (see Mkgmap/known issues for notes on compatibility)
  • Full control which OSM data is integrated into the map (style system)
  • Full control how POIs, streets and all other elements are displayed (TYP file compiler)
  • Full address search support
  • Routing support
  • Many options for fine control over the map creation process
  • Can include hill shading using Digital Elevation Model (DEM) data

Download

Get the latest version from the mkgmap download page. To see what has changed recently see the mkgmap news page.

Warning for Ubuntu / Debian / Other linux distributions

Some Linux distros package mkgmap. Be aware that the packaged version often is very old though. You will be better off using one of the versions linked to above. If you experience problems, do yourself a favour and check the version.

Creating a map

Creating a map consists of several steps.

  1. Download OSM data
  2. Split the OSM data into tile using the tile splitter
  3. Create your own map style files (optional)
  4. Compile the tiles with mkgmap
  5. Upload the map to your GPS

information sign

If you are a first time user or if you want to know more in detail what you have to do in the steps above we strongly encourage you to read the short tutorial How to create a map with mkgmap first! You might also be more interested in pre compiled maps, see downloadable maps below.

Command line options

There are several mkgmap options to configure the details of how mkgmap creates the map. For a complete list see the complete option list (which may be outdated) or run

java -jar mkgmap.jar --help

There are some scripts for Unix users which might be helpful: Python Script.

GUI

OSM Map Composer for Windows provides a graphical interface with mkgmap (along with other components) running behind the scenes, thus eliminating the need to deal with the command line.

Known issues

See the known issues page to read the list of currently known issues with mkgmap.

Screenshots of results

Mkgmap4.png Mkgmap-screenshot-6.png Mkgmap-screenshot-9.png Warnemünde.png

Development

If you want to take part in the mkgmap development please start by subscribing to the mkgmap mailing list. The development wiki page gives info about the mkgmap repositories and how to build mkgmap from the scratch.

Licence

The software is licensed under the GPL version 2. The maps it produces are to be licensed according to the data they were derived from: Open Database License (ODbL) for OSM data. There is therefore no licensing conflict that might exist with other approaches.

Help

Main article: Mkgmap/help

If you need help then try the following:

  • Ask a question in the mailing list. The mailing list can be accessed using any newsgroup reader (eg. Thunderbird) using the following settings:
  • Server: news.gmane.org
  • Group name: gmane.comp.gis.openstreetmap.mkgmap.devel
  • There is also an archive of the mailing list.

The mailing list is very active and will usually produce the fastest response.

Alternatively:

Links

More on mkgmap

Related OSM pages

Downloadable Maps

There are several websites that provide ready compiled maps for Garmin devices. The maps differ in region, use case (auto routing, hiking etc.) and visualization.

Miscellaneous