Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coin-mirror/maplibre-gl-renderer
Rendering MapLibre maps on server-side into pictures with full maplibre style spec support.
https://github.com/coin-mirror/maplibre-gl-renderer
maplibre maplibre-gl puppeteer static-image
Last synced: 5 days ago
JSON representation
Rendering MapLibre maps on server-side into pictures with full maplibre style spec support.
- Host: GitHub
- URL: https://github.com/coin-mirror/maplibre-gl-renderer
- Owner: coin-mirror
- License: other
- Created: 2024-11-08T13:59:34.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-05T22:43:08.000Z (2 months ago)
- Last Synced: 2024-12-05T23:18:28.208Z (2 months ago)
- Topics: maplibre, maplibre-gl, puppeteer, static-image
- Language: TypeScript
- Homepage:
- Size: 57.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# MapLibre Map Renderer
Rendering Maplibre Maps on server-side into pictures (e.g. PNGs) was currently only possible through the [`maplibre-native`](https://github.com/maplibre/maplibre-native) package, with node or c++ bindings. The `maplibre-native` package does NOT support every aspect of the [Maplibre Style Spec](https://maplibre.org/maplibre-style-spec/).
With this standalone application we introduced the possiblity to render the map with the maplibre-gl (JS) package in a simulated browser (with Puppeteer). This enables us to support the complete Maplibre Style Spec with relative good performance.
## Requirements
The app does require a GPU for rendering (Software Rendering is not possible so far). This means, mounting a GPU `/dev/dri` device onto the Docker Container when running on Linux is required. (Better GPU Performance does also result in faster response times.)
On Mac, running in Docker Container is currently not possible, but you can run it in development.
Internally, we use some rendering workers and a queueing system. Each worker can only render one map at the time. The amount of workers depend on the available CPU count, but can be overwritten by setting env-variable `WORKER_COUNT` to the amount of workers.
## Usage
You can run the container with (Supported Platforms are x64 and ARM64):
```bash
docker run --rm ghcr.io/coin-mirror/maplibre-gl-renderer:v0.1.5
```
> Please note, that it may be required to mount a GPU to the container.
Please read the License.
## API
### POST /render
Renders a map view according to the provided style and viewport settings.
**Request Body in JSON format:**
- `width`: Width (10-6000px, default: 1920)
- `height`: Height (10-4000px, default: 1080)
- `ratio`: Device scale factor (0-8, default: 1, zero will fallback to 1!)
- `center`: [longitude, latitude] (-180/180, -90/90)
- `zoom`: Zoom level (0-22)
- `pitch`: Tilt angle (0-85°, default: 0)
- `bearing`: Normalized Rotation (-180-180°, default: 0)
- `format`: "png", "jpeg" or "webp" (default: "webp")
- `quality`: Quality of picture, ignored for "png" format (0-100, default: 100)
- `optimize`: Optimizes processing for speed, quality-loss (!) (default: false)
- `style`: MapLibre Style Spec object
**Example:**
```json
{
"height": 512,
"width": 1024,
"center": [7.65, 45.02],
"zoom": 5.0613,
"bearing": 0,
"pitch": 0,
"ratio": 1.7,
"style": {
// Maplibre Style Spec
}
}
```
**Explaination for `ratio` property:**
The `ratio` refers always to the pixel-density ratio using to render the image. Internally, we are using the [window.devicePixelRatio](https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio) for scaling along.
Unlike changing the `height` and `width` values (which always results in a different viewport of the map), the `ratio` keeps the viewport but scales the image.
For example, using a `ratio` of `2` would double a requested picture size from 512x512 to 1024x1024 (or 4-times the pixels). You can also downscale by using a value between `0` and `1`. That would mean, a `ratio` of `0.5` would halfen a requested picture size from 512x512 to 256x256.
## Development
The project requires [Bun](https://bun.sh) for dependency management and runtime.
To install dependencies:
```bash
bun install
```
To run:
```bash
bun dev
```
Beyond that, we are packaging up the application as an Docker-Container, running on exposed port `3000`.