Skip to main content

Tile converter

From-v3.0npm versionDockerhub

The tile-converter is a command line utility (CLI) for two-way batch conversion between I3S and 3D Tiles, both an OGC community standard. It can load tilesets to be converted directly from an URL or file based formats. I3S and 3DTiles are large formats that include different layer types and data formats. See "Supported features" page that describes what the tile-converter supports.


The tile-converter is published as an npm module and as a docker image.

Installing from npm makes the tile-converter command line tool available. It can be run using npx.

$ npm i
$ npx tile-converter --install-dependencies
$ npx tile-converter --input-type \<I3S\|3DTILES\> --tileset \<tileset\> --name <tileset name> [--output <output folder>] [--draco] [--max-depth 4] [--slpk] [--7zExe <path/to/7z.exe>] [--token <ION token>] [--egm <pat/to/*.pgm>]

Alternatively, you can use syntax with the equal sign:

$ npx tile-converter --input-type=\<I3S\|3DTILES\> --tileset=<tileset> --splk=true|false
$ npx tile-converter --help

Alternatively, to download the tile-converter docker image, run:

$ docker pull visgl/tile-converter

Supported Platforms

Works only on NodeJS.


Option3DTiles to I3S conversionI3S to 3DTiles conversionDescription
install-dependenciesRun the script for installing dependencies. Run this options separate from others. Now "*.pgm" file installation is implemented
input-type**"I3S" - for I3S to 3DTiles conversion, "3DTILES" for 3DTiles to I3S conversion
tileset**"tileset.json" file (3DTiles) / "http://..../SceneServer/layers/0" resource (I3S)
output**Output folder. This folder will be created by converter if doesn't exist. It is relative to the converter path. Default: "data" folder
name**Tileset name. This option is used for naming in resulting json resouces and for resulting path/*.slpk file naming
max-depth**Maximal depth of the hierarchical tiles tree traversal, default: infinite
slpk*Whether the converter generates *.slpk (Scene Layer Package) I3S output file
7zExe*location of 7z.exe archiver to create slpk on Windows OS, default: "C:\Program Files\7-Zip\7z.exe"
egm**location of the Earth Gravity Model (*.pgm) file to convert heights from ellipsoidal to gravity-related format, default: "./deps/egm2008-5.pgm". A model file can be loaded from GeographicLib
token*Token for Cesium ION tileset authentication.
no-draco*Disable draco compression for geometry. Default: not set
instant-node-writing*Whether the converter should keep JSON resources (3DNodeIndexDocuments and nodePages) on disk during conversion. The default behavior is the converter keeps JSON resources in memory till the end of conversion. Those resources need to be updated during conversion (adding child nodes and neighbor nodes). If this option is set true the converter will keep JSON resources on disk all the time. Use this option for large datasets when the nodes tree is large and "memory overflow" error occurs. Instant node writing saves memory usage in cost of conversion speed (>2 times slower).
split-nodes*Prevent to merge similar materials that could lead to incorrect visualization. By default, the converter tries to merge PBR materials to create one node for all primitives in a glTF file. Using this option the converter will generate new node for every PBR material in the glTF file. With this option the resulting layer usually has refinement issues because "leaf" nodes are generated in the middle of the nodes tree]
generate-textures*Enable KTX2 textures generation if only one of (JPG, PNG) texture is provided or generate JPG texture if only KTX2 is provided
generate-bounding-volumes*Will generate obb and mbs bounding volumes from geometry
help**Show the converter tool options list
validate*Perform counting of all tiles and tiles with "ADD" type of refinement. Check whether a particular child node fits into the parent one or not. If not, warn about it.

Running local server to handle i3s layer.

After conversion there are new i3s layers in output ("data" in example) directory.

Run it with the local web server from project directory:

$ I3sLayerPath="./data/CairoLayer" DEBUG=i3s-server:* npx i3s-server

Docker image

The tile converter is available as a docker image in the visgl/tile-converter dockerhub repo.

To download the tile-converter docker image, run:

$ docker pull visgl/tile-converter

To use converter run:

$ docker run
-v /path/to/output_folder:/loaders-bundle/data \
--rm \
visgl/tile-converter \
--input-type ... \
--token ... \
--tileset ... \
--name ... \
--output ... \
--max-depth ...

Docker run arguments:

-v - Create docker volume, linked to internal data folder

--rm - Remove container after conversion

visgl/tile-converter - Image name

To build your own tile-converter docker image:

  • Clone project.
  • In root folder of the project run:
  $ yarn bootstrap
$ docker build -t [docker_image_name] -f modules/tile-converter/Dockerfile .
  • Push docker image to your docker hub

Show converted layer on a map.

$ open