Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 5.84 KB

README.md

File metadata and controls

77 lines (51 loc) · 5.84 KB
Raw

cityscape banner

Streets GL

Discord GitHub commit activity License

Streets GL is a real-time 3D map renderer built for visualizing OpenStreetMap data with a heavy focus on eye-candy features.

The whole project is written in Typescript. For rendering it uses a custom low-level library that wraps WebGL2 API, and for managing the rendering pipeline it uses a simple render graph (or frame graph) implementation. Geometry generation is done on the fly; supported map features include but are not limited to complex building shapes (according to the de-facto standard Simple 3D Buildings schema), roads and paths, trees, etc.

The goals of this project include providing a way to explore the feature-rich OSM database in 3D, promoting open data, and offering a way for the mapping community to easily validate the map by visual means.

Warning: This project is still in early development, expect bugs and missing features.

⭐ Features

  • Support for the most common OpenStreetMap features
  • Configurable time of day
  • Global map search powered by Nominatim
  • Real-time air traffic
  • Terrain with LODs
  • Deferred shading with PBR
  • Rich postprocessing: TAA, SSAO, depth of field, screen-space reflections, bloom
  • Realistic atmosphere and aerial perspective rendering

🖼️ Screenshots

💻 Minimum requirements

To run this application, you need a machine that supports WebGL2. It's recommended to use an up-to-date version of Google Chrome. Additionally, for a smooth experience, you will likely need a modern discrete GPU.

🗂️ Data sources

Currently, Streets GL uses three sources of data to render the map:

  • Public Overpass API instances to query small portions of the OpenStreetMap database (specific endpoints can be configured in the settings).
  • Terrain 3D tileset by Esri to visualize terrain elevation.
  • Mapbox API vector tiles to access pre-sliced polygons for big features that can't be reliably queried using Overpass API (such as water bodies).

Some small areas of the map are occasionally fetched and cached by the server for a faster and more reliable access. These areas include several major well-mapped cities (NYC, Berlin, Paris, etc). This feature can be turned off in the settings in case you want to see the most recent OSM data directly from Overpass API instances.

Read more about issues regarding the data on this wikipage.

📦 Modules

This repository includes several separable modules without any external dependencies that can be used in other projects with minimal modifications.

  • renderer — a simple WebGL2 renderer built from scratch (WebGPU support is also planned but hasn't been implemented yet).
  • render-graph — a minimal render graph (a.k.a. frame graph) implementation for easier rendering pipeline management. It automatically reorders render passes each frame, taking into account their dependencies, and culls out render passes that don't contribute to the final image. It also does basic memory management for framebuffers.
  • math — math utilities.
  • core — includes scene graph and some basic classes that describe a 3D scene. Depends on math.
  • bmfont — a bitmap text geometry generator optimized for large bitmaps and real-time use.

💡 Contributing

Please report any bugs you find by opening a new issue (but first make sure it hasn't been reported yet). Suggestions and pull requests are also welcome.

If you want to make a significant change, please open an issue first to discuss it.

More information about contributing can be found in CONTRIBUTING.md.

Development

  1. Clone this repository
  2. Install dependencies with npm i
  3. Run npm run dev to start a local development server