source: osm/applications/editors/josm/plugins/MicrosoftStreetside/README.md@ 36228

Last change on this file since 36228 was 36228, checked in by taylor.smock, 8 months ago

StreetSide: Update to official API

This also moves the plugin to Java 21 (mostly for virtual threads), reformats the
code to match the JOSM standard (4 spaces), and fixes a bunch of lint issues.

Additionally, a lot of cruft from when this plugin was copied from Mapillary was
removed. That was largely related to image import, uploading, and login.

File size: 2.8 KB
Line 
1Microsoft Streetside JOSM Plugin
2======
3
4The Microsoft JOSM Streetside (https://www.microsoft.com/en-us/maps/streetside) Plugin enables the viewing of Microsoft Streetside 360 degree imagery in the JOSM editor. It is based on the implementation of the Mapillary plugin (https://wiki.openstreetmap.org/wiki/JOSM/Plugins/Mapillary).
5
6Once JOSM is started and the MicrosoftStreetside plugin is selected in the JOSM Preferences, available Streetside imagery can be display within the boundary of the downloaded JOSM area, by selecting Imagery -> Streetside, from the main menu. Once blue bubbles appear on the map signifying Streetside imagery, clicking on a bubble results in the 360 degree imagery being displayed in the 360 degree viewer, which can be undocked and enlarged to allow for better viewing.
7
8## Documentation
9
10You can find out more about how to use the plugin and how it works in the [project Wiki](https://github.com/JOSM/MicrosoftStreetside/wiki).
11
12If you want to know how to configure the plugin, you can look at the [Configuration Wiki page](https://github.com/JOSM/MicrosoftStreetside/wiki/Configuration).
13
14## Building from source
15Checkout the JOSM source, compile it and checkout the plugin source (the last gradle command is optional, but contains code checking and unit test functionality - requires a Gradle installation):
16
17 svn co http://svn.openstreetmap.org/applications/editors/josm josm
18 cd josm/core
19 ant
20 cd ../plugins
21 rm -rf MicrosoftStreetside
22 git clone https://github.com/JOSM/MicrosoftStreetside.git MicrosoftStreetside
23 cd MicrosoftStreetside
24 ant clean
25 ant dist
26 gradle build
27
28Now Restart JOSM and activate the MicrosoftStreetside plugin in your preferences.
29The MicrosoftStreetside menu items will appear in the JOSM main menu after JOSM is
30restarted.
31
32Details about plugin development can be found [in the JOSM wiki](https://josm.openstreetmap.de/wiki/DevelopersGuide/DevelopingPlugins).
33
34## License
35
36This plugin is based on the Mapillary developed by developed and maintained by nokutu (nokutu@openmailbox.org) and extended to display Streetside imagery by Rene Rhodes (renerr18) You can contact Rene on GitHub.
37
38This software is licensed under [GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html).
39
40### Third party resources
41
42The MicrosoftStreetside plugin used JavaFX to implement the Streetside 360 degree viewer [JavaFX](https://en.wikipedia.org/wiki/JavaFX), which, while bundled in the Oracle Java SE 1.8, is not an official part of the
43Java SE 1.8 specification, and may not function properly with alternative JDKs (e.g. OpenJDK is not currently supported). JavaFX is licensed under the same terms as Java SE (http://www.oracle.com/technetwork/java/javase/terms/license/index.html).
44
45Third-party JDKs such as Azul have versions with JavaFX included. Please use those.
Note: See TracBrowser for help on using the repository browser.