Skip to content

slippy map (openstreetmap) widget for egui

License

Notifications You must be signed in to change notification settings

podusowski/walkers

Repository files navigation

Walkers, a map widget for Rust

made in Europe crates.io docs.rs

Walkers is a slippy maps widget for egui, similar to very popular Leaflet, but written in Rust. It compiles to native applications as well as WASM. See the online demo here.

Screenshot

It supports OpenStreetMap, mapbox, and compatible tile servers as well as off-line tiles using the PMTiles format.

Before deploying your application, please get yourself familiar with the OpenStreetMap usage policy, and consider donating to the OpenStreetMap Foundation.

Quick start

Walkers has three main objects. Tiles downloads images from a tile map provider such as OpenStreetMap and stores them in a cache, MapMemory keeps track of the widget's state and Map is the widget itself.

use walkers::{HttpTiles, Map, MapMemory, Position, sources::OpenStreetMap, lon_lat};
use egui::{Context, CentralPanel};
use eframe::{App, Frame};

struct MyApp {
    tiles: HttpTiles,
    map_memory: MapMemory,
}

impl MyApp {
    fn new(egui_ctx: Context) -> Self {
        Self {
            tiles: HttpTiles::new(OpenStreetMap, egui_ctx),
            map_memory: MapMemory::default(),
        }
    }
}

impl App for MyApp {
    fn update(&mut self, ctx: &Context, _frame: &mut Frame) {
        CentralPanel::default().show(ctx, |ui| {
            ui.add(Map::new(
                Some(&mut self.tiles),
                &mut self.map_memory,
                lon_lat(17.03664, 51.09916)
            ));
        });
    }
}

You can see a more complete example here.

Running the demo

Native

To run demo application locally, use a default cargo run target.

cargo run

Web / WASM

cd demo_web
trunk serve --release

Android

You need to have Android SDK and cargo-ndk installed.

cd demo_android
make run-on-device

Vector and offline maps

To see experimental vector maps support in action, you need to obtain some .pmtiles files and put them into the directory from where you run the native demo. One way of doing that is to download an extract from Protomaps.

pmtiles extract https://build.protomaps.com/20250928.pmtiles --bbox 16.802768,51.036355,17.209205,51.180686 wroclaw.pmtiles

Mapbox support

To enable mapbox layers, you need to define MAPBOX_ACCESS_TOKEN environment variable before building. You can get one by creating a mapbox account.

About

slippy map (openstreetmap) widget for egui

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors 23

Languages