msdf-gl

About

Render MSDF bitmaps with vector like quality

Getting started

Create font set:

const { buildFont } = require('msdf-gl')

buildFont({
  name: 'RobotoRegular',
  outPath: './buildTestOut/Roboto',
  fontPaths: ['./openFonts/Roboto/Roboto-Regular.ttf'],
  extent: 8_192, // must be power of 2, 8192 is a good default, but 4096 is a good compromise
  size: 22, // standard vertical size of font in pixels
  range: 6 // SDF range in pixels, larger = more detailed but more blurry
})

Create icon set

const { buildIcons } = require('msdf-gl')

buildIcons({
  inputFolder: './icons/streets', // folder with icons made up of SVGs (ONLY 'fill' paths, no strokes or shapes)
  outPath: './buildTestOut/Streets',
  outName: 'streets',
  extent: 8_192, // must be power of 2, 8192 is a good default, but 4096 is a good compromise
  size: 42, // standard vertical size of font in pixels. Larger size is better for icons.
  range: 6 // SDF range in pixels, larger = more detailed but more blurry
})

Copyright 2021 - S2MAPS INC

All rights reserved.

msdf-gl must be used according to the S2 Maps Terms of Service. This license allows developers with a current active S2 Maps account to use and modify the S2 Maps Web SDK. Developers may modify the S2 Maps Web SDK code so long as the modifications do not change or interfere with marked portions of the code related to billing, accounting, and anonymized data collection. The S2 Maps Web SDK only sends anonymized usage data, which S2 Maps uses for fixing bugs and errors, accounting, and generating aggregated anonymized statistics. This license terminates automatically if a user no longer has an active S2 Maps account.

For the full license terms, please see the S2 Maps Terms of Service at https://www.s2maps.io/tos/.