Home

The VM SDK helps you add wayfinding and turn by turn directions to your web application.

Supported platforms

VMSDK supports the latest, stable releases of all major browsers. Consult your map provider’s documentation for their own supported platforms.

Get started

With the Venue Maps SDK Reference App, you’ll see how to:

  • Show a map using a specific map provider, and display your custom map tiles
  • Load the VMD file with wayfinding data
  • Allow custom styling for your map tiles
  • Handle errors that may occur
First, install and run the reference app:
  1. Download and install a Java SDK (version 1.8.0)
    1. The reference app backend is built with Grails 2.5.6, which requires the Java 8 SDK. However, this is not a requirement of the core VMSDK.
  2. Extract the web VMSDK zip file.
  3. The reference app uses Mapbox as an example map provider, so you will need to generate a Mapbox Access token
  4. Once you have a Mapbox access token, edit the reference-app/web-app/js/demo_aegirh.js file and update the accessToken variable.
  5. In a command prompt or shell, change to the reference-app/ subdirectory and run the reference app by executing this command: 
    grailsw run-app
  6. After the app builds and starts, browse to http://localhost:8080/web-reference-app/ to interact with the reference app.
The reference app provides basic samples of how one might use the SDK components. It is not intended to be used in a production setting, nor should it be considered as a template for production code.

See the full VM-SDK Guide here: SDK Guide