[![Maven Central](https://img.shields.io/maven-central/v/org.mapsforge/vtm.svg)](https://repo1.maven.org/maven2/org/mapsforge/)
[![](https://jitpack.io/v/mapsforge/vtm.svg)](https://jitpack.io/#mapsforge/vtm)

# Integration guide

This article describes how to integrate the library in your project with Maven and [JitPack](https://jitpack.io/#mapsforge/vtm) repositories.

### Maven

Package: `org.mapsforge`

### JitPack

Package: `com.github.mapsforge.vtm`

```groovy
repositories {
    maven { url 'https://jitpack.io' }
}
```

## Map

```groovy
implementation '[PACKAGE]:vtm:[CURRENT-VERSION]'
implementation '[PACKAGE]:vtm-themes:[CURRENT-VERSION]'
```

## Android

```groovy
implementation '[PACKAGE]:vtm-android:[CURRENT-VERSION]'
runtimeOnly '[PACKAGE]:vtm-android:[CURRENT-VERSION]:natives-armeabi-v7a'
runtimeOnly '[PACKAGE]:vtm-android:[CURRENT-VERSION]:natives-arm64-v8a'
runtimeOnly '[PACKAGE]:vtm-android:[CURRENT-VERSION]:natives-x86'
runtimeOnly '[PACKAGE]:vtm-android:[CURRENT-VERSION]:natives-x86_64'
implementation 'com.caverock:androidsvg:1.4'
```

## Desktop

```groovy
implementation '[PACKAGE]:vtm-gdx:[CURRENT-VERSION]'
implementation '[PACKAGE]:vtm-desktop:[CURRENT-VERSION]'
runtimeOnly '[PACKAGE]:vtm-desktop:[CURRENT-VERSION]:natives-linux'
runtimeOnly '[PACKAGE]:vtm-desktop:[CURRENT-VERSION]:natives-osx'
runtimeOnly '[PACKAGE]:vtm-desktop:[CURRENT-VERSION]:natives-windows'
implementation 'com.badlogicgames.gdx:gdx:1.11.0'
runtimeOnly 'com.badlogicgames.gdx:gdx-platform:1.11.0:natives-desktop'
implementation 'guru.nidi.com.kitfox:svgSalamander:1.1.3'
implementation 'net.sf.kxml:kxml2:2.3.0'
```

### LWJGL 2

```groovy
implementation '[PACKAGE]:vtm-desktop-lwjgl:[CURRENT-VERSION]'
implementation 'com.badlogicgames.gdx:gdx-backend-lwjgl:1.11.0'
implementation 'org.lwjgl.lwjgl:lwjgl:2.9.3'
runtimeOnly 'org.lwjgl.lwjgl:lwjgl-platform:2.9.3:natives-linux'
runtimeOnly 'org.lwjgl.lwjgl:lwjgl-platform:2.9.3:natives-osx'
runtimeOnly 'org.lwjgl.lwjgl:lwjgl-platform:2.9.3:natives-windows'
```

### LWJGL 3

```groovy
implementation '[PACKAGE]:vtm-desktop-lwjgl3:[CURRENT-VERSION]'
implementation 'com.badlogicgames.gdx:gdx-backend-lwjgl3:1.11.0'
implementation 'org.lwjgl:lwjgl:3.3.1'
runtimeOnly 'org.lwjgl:lwjgl:3.3.1:natives-linux'
runtimeOnly 'org.lwjgl:lwjgl:3.3.1:natives-macos'
runtimeOnly 'org.lwjgl:lwjgl:3.3.1:natives-windows'
```

## Features

### Hillshading

```groovy
implementation '[PACKAGE]:vtm-hillshading:[CURRENT-VERSION]'
implementation 'org.mapsforge:mapsforge-core:0.25.0'
implementation 'org.mapsforge:mapsforge-map:0.25.0'
implementation 'org.mapsforge:mapsforge-map-android:0.25.0'
```

### Overlays

```groovy
implementation '[PACKAGE]:vtm-jts:[CURRENT-VERSION]'
implementation 'org.locationtech.jts:jts-core:1.20.0'
```

### Online tiles

```groovy
implementation '[PACKAGE]:vtm-http:[CURRENT-VERSION]'
implementation 'com.squareup.okhttp3:okhttp:4.12.0'
implementation 'com.squareup.okio:okio:3.6.0'
implementation 'com.squareup.okio:okio-jvm:3.6.0'
```

### MBTiles

```groovy
implementation '[PACKAGE]:vtm-android-mvt:[CURRENT-VERSION]'
implementation '[PACKAGE]:vtm-mvt:[CURRENT-VERSION]'
implementation 'com.google.protobuf:protobuf-java:3.24.2'
implementation 'io.github.ci-cmg:mapbox-vector-tile:4.0.6'
implementation 'org.locationtech.jts:jts-core:1.20.0'
```

### Mapbox vector tiles

```groovy
implementation '[PACKAGE]:vtm-mvt:[CURRENT-VERSION]'
implementation 'com.google.protobuf:protobuf-java:3.24.2'
implementation 'io.github.ci-cmg:mapbox-vector-tile:4.0.6'
implementation 'org.locationtech.jts:jts-core:1.20.0'
```

### GeoJSON vector tiles

```groovy
implementation '[PACKAGE]:vtm-json:[CURRENT-VERSION]'
implementation 'com.fasterxml.jackson.core:jackson-annotations:2.9.9'
implementation 'com.fasterxml.jackson.core:jackson-core:2.9.9'
implementation 'com.fasterxml.jackson.core:jackson-databind:2.9.9'
```

### jeo (indoor maps)

```groovy
implementation '[PACKAGE]:vtm-jeo:[CURRENT-VERSION]'
implementation 'com.github.jeo.jeo:jeo-carto:master-SNAPSHOT'
```

## Snapshots

We publish SNAPSHOT builds to Sonatype OSS Repository Hosting.

```groovy
repositories {
    maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
}
```

```groovy
implementation 'org.mapsforge:vtm:master-SNAPSHOT'
```

For checking latest snapshot on every build:
```groovy
configurations.all {
    resolutionStrategy.cacheChangingModulesFor 0, 'seconds'
}
```

## Jars

You can find release and snapshot jars on [Maven Central](https://repo1.maven.org/maven2/org/mapsforge/) and [Sonatype OSS Repository Hosting](https://oss.sonatype.org/content/repositories/snapshots/org/mapsforge/).