Chevron DownCommand-Line Reference
Chevron DownAPI Reference

Build Instructions


Following steps are for running converter right on a repository branch. It might be helpful if latest changes from any repository branch are needed. E.g. if latest master branch has some important updates in tile-converter module or other module that tile converter module depends on, a user can run it. It doesn't need to wait for new release.

  1. Using yarn instead of npm is recommended because it is general practice in repos;

  2. Clone the repository

git clone
  1. Build modules
yarn bootstrap
  1. Install default Earth Gravity Model dependency:
npx tile-converter --install-dependencies

You can use custom Earth Gravity Model using --egm option.

  1. Convert some tileset Examples:
npx tile-converter --input-type 3dtiles --tileset ./modules/3d-tiles/test/data/Batched/BatchedTextured/tileset.json --name BatchedTextured
npx tile-converter --input-type 3dtiles --tileset --name CairoLayer --max-depth 10

Notice "--max-depth" option. It means that the converter will load and convert only first 'n' (10 in example) levels of tiles. Use it for big tilesets when full conversion could take a lot of time. If you want to convert all the tileset, omit this option.

  1. I3S layers can be used only as http service. There is local server to handle i3s layer

After conversion there are new i3s layers in output (default: "data") directory. Run it with the local web server:

I3sLayerPath="./data/CairoLayer" DEBUG=i3s-server:* npx i3s-server
  1. Show converted layer on a map.


A. To show converted layer in a locally built example.

Run the front-end application from examples

cd examples/website/i3s
MapboxAccessToken=<TOKEN> yarn start-local

B. To run a custom layer in a web-browser manually