Skip to content
OpenGISPublic

About

A map style for the great outdoors.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

Outdoors

A Free and Open-Source 3D rendering of your surroundings.

🌎🌍🌏 [DEMO] 🌎🌍🌏

Warning

This project is a work in progress, expect changes!


Screenshots

Helvellyn Dolomites 3D Sunshine Coast Cape Scott Hawes, England Long Trail


Dependencies

Sources

  • © OpenStreetMap Contributors
  • OpenFreeMap — OSM vector tiles of the entire planet.
  • © Mapterhorn — DEM source for 3D terrain and hillshading.
  • © Esri World Imagery — Satellite ground raster blended over the natural-earth vectors (used when the SATELLITE_GROUND feature is enabled).
  • Open GIS Tile Server — core outdoor data dependency: the outdoor POI, waymarked-route, low-zoom path and contour vector tiles that the style layers over the basemap. Its source code and operations documentation live in the public OpenGIS/tiles repository, and the live source inventory publishes each source's name, zoom range, build id and TileJSON link.

Core

Run

Node.js 22 or newer is required.

Build

npm install                           # Install dependencies
npm run build                         # Build `style.json` from `scripts/build.mjs` (also validates)

Map and icon colours live in palette.json, which also registers the icon set. After editing the palette or the authored icon sources in icons/, regenerate the derived files in order: npm run palette:build (optional; npm run sprite:build renders first) → npm run sprite:build → npm run build → npm run demo:build. npm run sprite:build also rewrites the committed sprite.lock.json, which records sha256 digests of the sources and sheets so CI can verify sprite freshness without spreet. style.json, the sprite sheets in dev/public/ and the lock are committed; the rendered icons in build/icons/ and the app bundle in dist/ are generated.

Other

# Validate
npm run validate:style                # Validate `style.json` (MapLibre style spec)

# Palette & sprites
npm run palette:build                 # Render `icons/` through `palette.json` into gitignored `build/icons/`
npm run palette:check                 # Validate `palette.json` + `icons/` and verify `sprite.lock.json` (no render)
npm run sprite:build                  # Render icons, build the sprite sheets and rewrite `sprite.lock.json`

# POIs
npm run check:pois                    # Sprite icons, orphan icons, token templates, kind coverage and sort priorities

# Demo
npm run demo:build                    # Build the compare app to `dist/`
npm run demo:preview                  # Preview the `dist/` build

# Screenshots
npx playwright install chromium
npm run screenshots                   # Regenerate every shot in shots.json
npm run screenshots -- --name <id>    # Regenerate a single shot by id
npm run screenshots:check             # Check shots, JPEGs and docs references
npm run screenshots:check -- --stale  # Also fail on images older than their inputs

# Benchmark
npm run bench                         # Draw-performance benchmark of the compare app
npm run bench -- --shot bolzano-3d --variants full   # Focus a shot / variant
npm run bench -- --mode load --serve demo            # Load-benchmark the `dist/` build

Screenshot runs exit non-zero on a capture failure, including a filtered --name run.

Development

Compare app with HMR support.

npm install                           # Install dependencies
npm run dev                           # Start Vite dev server + auto-build watcher

CI & releases

  • Deploy — .github/workflows/deploy.yml runs on pushes to master: it installs dependencies, rebuilds the style and app, and fails if style.json differs from the committed output (the app bundle in dist/ is generated, not committed). It then validates the style, runs npm run palette:check (which verifies the committed sprite.lock.json because CI has no spreet), checks POI coverage and screenshots, and uploads the generated dist/ build to GitHub Pages.
  • Release — .github/workflows/release.yml runs when package.json changes on master, or on manual dispatch. If the matching v<version> release does not exist, it runs the same build and checks (including the style.json freshness check and the sprite lock) and creates the GitHub Release and tag with generated notes; if the release already exists it skips, so reruns are safe.

Read the Docs →

About

A map style for the great outdoors.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Contributors

Languages