XYZ maps three.js renderer (aka harp.gl)

XYZ maps three.js (previously known as harp.gl) is an experimental open-source 3D map rendering engine built on three.js. This open source version doesn't rely on access to proprietary APIs and services.

Overview

You can use this engine to:

• Develop visually appealing 3D maps
• Create highly animated and dynamic map visualization with WebGL, using the popular three.js library.
• Create themeable maps, with themes that can change on the fly.
• Create a smooth map experience with highly performant map rendering and decoding. Web workers parallelize the CPU intensive tasks, for optimal responsiveness.
• Design your maps modularly, where you can swap out modules and data providers as required.

With that in mind, we have included some modules that let's you get started with some simple web applications that can display a map using our default style. You can get results like the one shown below:

Getting started with harp.gl

(TDB - will be updated to reflect transition to XYZ maps)

If you want to learn more about the applications you can create, please check the Getting Started Guide.

About This Repository

This repository is a monorepo containing the core components of harp.gl, organized in a yarn workspace.

All components can be used stand-alone and are in the @xyzmaps subdirectory.

Installation

In Node.js

All harp.gl modules are installable via yarn (or npm):

yarn add @xyzmaps/harp-mapview
Copy

npm install @xyzmaps/harp-mapview
Copy

In Browser

Since harp.gl consists of a set of modules, there are no ready-made bundles available. Take a look at the examples on information on how to use tools like webpack to create a bundle for the browser.

Development

Prerequisites

• Node.js - Please see nodejs.org for installation instructions
• Yarn - Please see yarnpkg.com for installation instructions.

Download dependencies

Run:

yarn install
Copy

to download and install all required packages and set up the yarn workspace.

Launch development server for harp.gl examples

Run:

yarn start
Copy

To launch webpack-dev-server. Open http://localhost:8080/ in your favorite browser.

Generate documentation

Run:

yarn run typedoc
Copy

It will output all documentation under /dist/doc.

License

Copyright (C) 2023- XYZ maps contributors

Copyright (C) 2017-2021 HERE Europe B.V.

See the LICENSE file in the root of this project for license details about using harp.gl.

In addition, please note that the fonts are under a different set of licenses.