Vuze plugin

User’s guide

1. Installation

  1. Install Azureus/Vuze. Please follow product installation instructions published by the mentioner.
  2. Download current version of the plugin from
  3. From Vuze menu select Plugin -> Installation Wizard… and check Installation method “by file”. Select downloaded osm4garmin.jar and proceed through all Wizard pages. When finished, Vuze will be restarted.

2. Setting up plugin options

After successful installation, new menu item in Plugins menu “OSM for Garmin updater” will appear. Selecting this menu item opens plugin configuration page:

Plugin configuration page


First of all, select directory for saving maps and plugin work files. It is recommended to create a new folder using popup file dialog (click on the icon to the right of the directory field). If you already have some maps downloaded, copy them to this folder BEFORE starting download. The structure must exactly follow maps torrent structure, i.e. [download dir]/maps/[region]/gmapsupp.img .

As a next step, select region(s) you would like to download. You can select as many regions as you need. They will be downloaded sequentionaly from top to bottom.

If older version of the map file is present in the download folder and suitable diff torrent exists, plugin downloads much smaller diff file only and patches your old map to obtain newer version.

Finally, press the “Proceed!” button and maps download/update will start!

At any moment you can stop running download and change regions selection, but do not change content of your download directory if you do not know what are you doing.

Please do not forget to seed downloaded files in order to speed up overall cloud distribution performance for other users.

3. Advanced topics

Continuous instant update

If you check “Automatically repeat download every 24 hours” checkbox, plugin will contact the server every 24 hours and download new version of the maps torrent. If new maps are available, new download is started, i.e. your data are kept as fresh as possible instantly.

You can stop automatic update at any time by pressing the “Proceed!” button. If you press “Proceed!” again, new download starts immediatelly.

Log view

OSM for Garmin update plugin has it’s Log View window containing progress and error messages. Log View window can be opened from the Plugins -> Log views menu. You can use log messages to check progress of the download process and to troubleshoot problems.

Azureus/Vuze restart persistence

Downloading process is persistent between Vuze sessions. In case Vuze is restarted, plugin state is restored to the state immediately before restart, i.e. running download is restarted and continuous update state is persisted between Vuze runs. It is particularly useful in case Vuze is configured to start automatically when system starts up.


Plugin was tested on Vuze version, nevertheless it uses basic API only and should work on most versions of Azureus/Vuze. Plugin should be platform independent.

4. Support

If you need help with plugin, you can use this Contact form to ask questions to the author. General comments, suggestions etc. are welcome as well. Source code of the plugin is included in the jar archive for your reference.

Feel free tu submit comments and suggestions which can be generaly useful to other plugin users as a comment below this article.

5. License

Plugin is licensed under GPL v.2 license. Plugin uses following third party code:

Javaxdelta – Java GDiff implementation library
Trove – hash table library used by Javaxdelta
Jts Topology Suite used for translation between hex and binary hashes

Licenses of foreign packages can be found by following provided links.

  1. #1 by Jim at March 18th, 2012

    The osm4garmin.jar file doesn’t work in vuze, it says it’s not a valid plugin. Anyone have any suggestions?

  2. #2 by František Mantlík at March 18th, 2012

    Most probably, your download is corrupted. Try download the file again.

  3. #3 by Dana Harrison at May 18th, 2012

    Hello Mr. Mantlik,
    Thank you for sharing your OSM mapping tools. I would be happy to make a donation if I can get this to work, and I think I am close.

    I installed Vuze It is a bit different from your instructions but I figured out how to install the osm4garmin plugin. During installation, Vuze gives the following error message:

    ‘OSM for Garmin Updater’ could not be verified as an official Vuze plugin. If it is such a plugin you should NOT continue. Proceed with Installation?
    I selected ‘Yes’ and proceeded.

    The first installation was not successful; the regions were not visible, etc. I deleted the original osm4garmin file and downloaded it again from

    This copy of osm4garmin installed with the following message:

    Downloading: C:\Users\Dana\Downloads\osm4garmin.jar
    Installing plugin ‘OSM for Garmin updater’, version 0.4
    Data verification stage complete
    Can’t write directly to the plugin directroy, installing indirectly
    Version 0.4 of plugin ‘OSM for Garmin updater’ installed successfully

    I restarted Vuze and launched the plugin. This time the plugin appeared functional so I created the following folders and entered the following directory:


    Then I selected the USA West region and clicked the button to Proceed. This started a torrent download in Vuze as expected, but the size is 30.34 GB. I expected the file size to be under 4 GB. Am I doing something wrong?


    – Dana Harrison
    Sandy, UT, USA

  4. #4 by František Mantlík at May 18th, 2012

    Dana, the behavior described is OK. The whole world map coverage is more than 30 Gb. Don’t worry about, he plugin will download regions you have selected only.

  5. #5 by Nate Collins at August 4th, 2012

    I downloaded Vuze V4.7.1.2/4 az3, as well as the OSM for Garmin plugin. Everything ok so far. I selected my map regions and hit proceed. Updater shows “updating list of available diffs” and Vuze shows data downloading. However, no files show up in the specified directory and eventually the message changes to “updating stopped”. I restart and the same sequence starts again. Never seem to download any maps. What am I doing wrong?

    Nate Collins

  6. #6 by František Mantlík at September 20th, 2012

    Depending on settings of your Vuze installation, it can happen that your Maps torrent is downloaded and prepared for processing but not started. The same can happen if you change your data directory after the download was already started.

    Please try the following to fix the problem:

    1. Check whether “Save in:” item in the General tab of the maps torrent details corresponds to your data directory. Double click your maps torrent in the My torrents window to open the torrent details window.

    2. If the download directory does not correspond to your data directory, delete the maps torrent (remove both torrent and data) and restart Vuze. Open OSM for Garmin plugin options, select region(s) to process and click the Proceed! button.

    2. If maps torrent is not started by the plugin when updates are checked, start it manually. Right-click the maps torrent in the My Torrents window and select Force start.

  7. #7 by dave stiles at February 27th, 2013

    minor bug fyi.

    the checkbox label for enabling western us download actually enables eastern us, and checkbox label for enabling eastern u actually enables western us.

    i see that error in lines 14 and 15 of in the jar file.


  8. #8 by František Mantlík at February 27th, 2013

    Hi Dave,

    thank you for your information. The bug will be fixed in the next release of the plugin.

  9. #9 by Linda at March 14th, 2013

    I have downloaded the Vuze plugin and selected two maps to download (USA East and USA West) but it appears to be trying to download the entire 35G set of world maps. It is taking a verrrrry long time! Going on 24 hours now and only 6% downloaded. Anyway to speed up the process?

  10. #10 by František Mantlík at March 15th, 2013

    Hi Linda,

    The map sets are large and it takes very long time to download. Vuze plugin should download checked regions only. You can check the situation at the Files tab of the Maps torrent details. All regions but the checked should have their priority set to “Do not download”.

    Not much can be done to speed up your download, the current speed depends on cloud status, i.e. how many users seed their downloaded data. As soon as you will finish your downloads, you can help other users to speed up their download by seeding your downloaded files for as long as possible.

  11. #11 by Linda at March 15th, 2013

    Thanks for your reply. I do not see where this is:
    “You can check the situation at the Files tab of the Maps torrent details. All regions but the checked should have their priority set to “Do not download”.

    The only place I see the individual regions is on the OSM4Garmin plugin. On the Vuze plugin it says it has 13 files to download, but no individual file names. Thanks again for your help!

  12. #12 by František Mantlík at March 15th, 2013

    Double-click the Maps torrent in the My Torrents table. The details tab will open (with header something like 10% : maps). In the sub-tab Files you can find info concerning individual files.

  13. #13 by Linda at March 16th, 2013

    The version of Vuze that I downloaded does not have the tabs as shown in your screen shot. But anyway, the files are dowloaded and I successfully got the usa east map onto the Garmin. Thanks again!

  14. #14 by Charlie at March 21st, 2013

    I selected usa_west in the Plugin screen, but when I view the Downloading window in main application it appears to be downloading usa_east.

  15. #15 by František Mantlík at March 21st, 2013

    Dear Charlie, there is a bug in the Vuze plugin – see Comment #7. USA East and USA West are switched in region selections window. The problem will be fixed in the next version of the plugin. As a workaround, please select usa_east if you wish to download usa_west. Sorry for inconvenience.

  16. #16 by mark bryson at March 31st, 2013

    I downloaded the central_europe and get this error message when trying to copy to my FAT32 32 GB MicroSD card:
    “The file “gmapsupp” too large for destination file system”. Had no problem copying the USA West file to the same MicroSD/

  17. #17 by František Mantlík at March 31st, 2013

    Last automatic update of the Central Europe area exceeded the FAT32 limit of 4,294,967,295 bytes. As such, the gmapsupp.img file is too large to be processed by GPS or to be copied to a memory card. The only possible workaround would be to split the gmapsupp.img archive with a suitable tool, take rid of several tiles (6 Mbytes only should be sufficient) and compile the rest together with e.g. mkgmap.

    In approx. 2 weeks new update will be generated with reduced boundaries for the Central Europe region and the resulting map will fit the hardware limits again. Please check to find out that new maps are available.

  18. #18 by Robert Ahl at April 18th, 2013

    I have not been able to successfully install the OSM4Garmin plugin. Though I have tried many times I keep getting the same error message:
    Downloading: C:\Documents and Settings\bobbles\My Documents\Downloads\osm4garmin.jar
    Installing plugin ‘OSM for Garmin updater’, version 0.4
    Data verification stage complete
    Plugin initialising, please wait…
    Version 0.4 of plugin ‘OSM for Garmin updater’ failed to install – Error initializing plugin ‘OSM for Garmin updater

  19. #19 by František Mantlík at April 18th, 2013

    Dear Robert, most probably your downloaded file is broken. Current version of the plugin is 0.5. Please download the newest version of the plugin and try install it again. If the above will not help, try to uninstall the Osm for garmin updater plugin, restart Vuze and install it back.

  20. #20 by Curtis Lupo at May 3rd, 2013

    Hi František,
    I’m using the Vuze plugin to download the Central European and Western European maps. I was able to get the downloads started without any problems except that Vuze indicates it will take up to 8 days to download these maps. I’m inexperienced at this so I may have set something up incorrectly. Is there anything I need to set differently to speed up the download? Thanks for your help and your work on this website.

  21. #21 by František Mantlík at May 3rd, 2013

    Dear Curtis, unfortunately, you can’t do much to speed up your download. It is a long process which depends on current state of the cloud. Typically, you are able to download approx. one region per 1-2 days.

    You can help others to speed up their downloads by seeding downloaded data for as long as you can.

  22. #22 by Curtis Lupo at May 3rd, 2013

    Thank you for the information František. I was able to speed up the process by forwarding the appropriate ports in my router and may firewall for Vuze. Now the download is progressing at the expected rate of approx. 1 day.

  23. #23 by Joe at May 30th, 2013

    Hi František,
    I recently lost the micro sd card from my Garmin 705. With the information from your site, I was able to download the maps onto a replacement sd card and get the maps to show on my Garmin. Thank you for the help.
    Question though: my neighborhood was constructed in the 1980’s and 90s and the map (Western US) is not current. Streets constructed several years ago are not showing. Also, I believe the Garmin supplied card had street names that would be visible on the Garmin. Is that something that is available?
    Thank you again.

  24. #24 by František Mantlík at May 30th, 2013

    Hi Joe,
    the OpenStreetMap maps are created by volunteers like you. Quality of the map varies significantly. You can find out how a particular region is covered at . You are welcome to contribute to the map and add missing information, if you can. Maps published here are updated approx. once per two months taking into account all available updates of the OpenStreetMap database.

  25. #25 by Joe at May 31st, 2013

    Hi František,
    Thank you. I was apparently doing something wrong or the transfer to my sd card was bad. I removed the first download from my sd card and re-installed. Maps show beautifully now. I’ll try it out on the road this weekend. Thanks again.

  26. #26 by Donald at March 24th, 2014

    When I run the plug-in, I check the maps I want and hit “proceed!”. However, in Vuze, it is trying to download ALL the maps, and I don’t have space or time… If I delete individual map torrents from the list under “Maps”, Vuze still says that the download will require 37 GB and I have insufficient space! Restarting Vuze does not help — it still says I need 37 GB even if I only have 3 files…

  27. #27 by František Mantlík at March 24th, 2014

    Donald, this is a problem of Vuze and not the plugin. I guess, that hte only way is to provide enough free space. You will download required regions only but free space for the whole set must be reserved.

(will not be published)