Brouter Save

configurable OSM offline router with elevation awareness, Java + Android

Project README


BRouter is a configurable OSM offline router with elevation awareness, Java + Android. Designed to be multi-modal with a particular emphasis on bicycle and energy-based car routing.

For more infos see

BRouter on Android

You can install the BRouter app on your Android device from F-Droid or Google Play Store. You can also build BRouter yourself. You can find detailed documentation of the BRouter Android app in docs/users/

Get it on F-Droid Get it on Google Play

Android with Locus

You can use BRouter as the offline routing engine for Locus Map on your Android device. This is currently the most featureful and maintained solutions for using BRouter on your Android device.

A full documentation on how to set this up is available at

Android with OSMAnd

Alternatively, you can also use BRouter as the offline routing engine for OSMAnd on your Android device.

A full documentation on how to set this up is available at docs/users/

BRouter on Windows/Linux/Mac OS

Build and Install

To compile the BRouter Android app, the Android SDK path must first be set in a file called in the main folder:


Build BRouter with the Android app (if Android SDK path is set):

./gradlew clean build

Build BRouter without the Android app:

./gradlew clean build -x :brouter-routing-app:build

Build JAR file for server and map creator with all dependent classes:

./gradlew clean build fatJar # places JAR file in brouter-server/build/libs/

Build ZIP file for distribution with readmes, profiles, APK and JAR:

./gradlew distZip # places ZIP file in brouter-server/build/distributions/

Get the required segments (data) files

Routing data files are organised as 5*5 degree files, with the filename containing the south-west corner of the square, which means:

  • You want to route near West48/North37 -> you need W50_N35.rd5
  • You want to route near East7/North47 -> you need E5_N45.rd5

These data files, called "segments" across BRouter, are generated from OpenStreetMap data and stored in a custom binary format (rd5) for improved efficiency of BRouter routing.

Download them from

Segments files from the whole planet are generated weekly at

You can download one or more segments files, covering the area of the planet you want to route, into the misc/segments4 directory.

Generate your own segments files

You can also generate the segments files you need directly from a planet dump of OpenStreetMap data (or a GeoFabrik extract).

More documentation of this is available in the docs/developers/ file.

(Optional) Generate profile variants

This repository holds examples of BRouter profiles for many different transportation modes. Most of these can be easily customized by setting variables in the first global context of the profiles files.

An helper script is available in misc/scripts/ to help you quickly generate variants based on the default profiles, to create a default set of profiles covering most of the basic use cases.

Have a look at the docs/developers/ for an in-depth guide on profiles edition and customization.

Run the BRouter HTTP server

Helpers scripts are provided in misc/scripts/standalone to quickly spawn a BRouter HTTP server for various platforms.

  • Linux/Mac OS: ./misc/scripts/standalone/
  • Windows (using Bash): ./misc/scripts/standalone/
  • Windows (using CMD): misc\scripts\standalone\server.cmd

The API endpoints exposed by this HTTP server are documented in the brouter-server/src/main/java/btools/server/request/ file.


More documentation is available in the docs folder.


BRouter is released under an MIT License.

Open Source Agenda is not affiliated with "Brouter" Project. README Source: abrensch/brouter
Open Issues
Last Commit
1 month ago

Open Source Agenda Badge

Open Source Agenda Rating