wiki:Help/Preferences/Plugins

Preferences > Plugins

Plugins extend the core functionality of JOSM. The list of JOSM plugins explains which plugins are available and with what kind of functionality they extend JOSM.

Most JOSM users don't work with the bare JOSM core only. They usually install several plugins.

Please, install only the plugins you need. Plugins will probably rise the chance of code errors and some combinations might even not been tested.

Automatic installation via Preferences menu

Common steps:

  1. Launch the source:/trunk/images/preference.png Preferences dialog.
  2. Select the tab source:trunk/images/preferences/plugin.png Plugins.

Installing plugins

  1. (optionally) click on source:trunk/images/download.png Download list to download the list of available plugins (if nothing was shown)
  2. Tick the checkbox for every plugin you want to install.
  3. Click on OK.

JOSM will download and install the plugins. Some plugins don't require a restart of JOSM, you will be prompted only if you need to.

Updating plugins

On start-up, JOSM attempts to update the plugins

  • if JOSM itself has been updated since the last plugin update. This is called the version based update mode.
  • if a certain periode of time has elapsed since the last plugin update. This is called the time based updated mode.

In both cases, JOSM offers to update the currently active plugins and you are advised to run the updates by clicking on Update plugins. You may also skip updating, but be warned, that installed plugins could be incompatible with the new JOSM version and that they might either fail to load or fail to work as expected.

Screenshot for automatic update dialog

Select Do not ask again and remember my decision if JOSM should always try the selected action without asking for confirmation. If you select this checkbox, JOSM won't display this dialogue any more.

In the preferences you can define the policy for both updating plugins modes.

  1. same common steps as above
  2. Click the tab Plugin update policy.

policy screenshot

  • Select the radio button Ask before updating if JOSM shall ask before updating plugins in version and/or time based update mode.
  • Select the radio button Always update without asking if JOSM shall automatically update plugins without asking.
  • Select the radio button Never update to disable version or time based automatic update. JOSM will skip automatic update at startup if this policy is selected.

The interval in days for the time based updated mode can be set below the radio buttons (default=30).

Manual installation

In most cases users don't need to do this.

Manually installing plugins

If the automatic way does not work, you can install plugins manually by putting the .jar files in the plugins directory under josm directory.

josm location was covered at Help/Preferences#Defaultlocation.

Now restart JOSM and the plugins should show up in the plugin list under Edit -> Preferences -> source:trunk/images/preferences/plugin.png Plugins.
Activate the Plugins, click on source:/trunk/images/ok.png OK to save the preferences and restart JOSM once more.

Manually updating plugins

  1. Launch the source:trunk/images/preference.png Preferences dialog.
  2. Select the tab source:trunk/images/preferences/plugin.png Plugins.
  3. Click on source:trunk/images/download.png Download list do download the list of available plugins.
  4. Your installed plugins are already selected at the checkboxes
  5. Click on source:trunk/images/dialogs/refresh.png Update plugins.

JOSM will update the selected plugins. You have to restart JOSM to complete the update process.

See also


Back to Preferences
Back to Plugin Help
Back to Main Help

Last modified 8 days ago Last modified on 2016-08-23T16:16:53+02:00

Attachments (1)

Download all attachments as: .zip