versatiles

Crates.ioversatiles
lib.rsversatiles
version0.11.5
sourcesrc
created_at2023-01-25 17:33:22.639653
updated_at2024-06-01 22:47:02.790032
descriptionA toolbox for converting, checking and serving map tiles in various formats.
homepagehttps://versatiles.org
repositoryhttps://github.com/versatiles-org/versatiles-rs
max_upload_size
id767659
size398,698
Michael Kreil (MichaelKreil)

documentation

README

Crates.io Crates.io Code Coverage GitHub Workflow Status (with event) License Matrix Chat

Versatiles

Versatiles is a Rust-based project for processing and serving tile data.

Install

Linux

The installation script will download the correct precompiled binary and copy it to /usr/local/bin/:

curl -Ls "https://github.com/versatiles-org/versatiles-rs/raw/main/helpers/install-linux.sh" | bash

Mac

You can install Versatiles using Homebrew:

brew tap versatiles-org/versatiles
brew install versatiles

Docker

We have prepared Docker Images for easy deployment:

docker pull versatiles-org/versatiles

Build from Source

To build Versatiles from source, you need Rust installed. Then, run the following command:

cargo install versatiles

Run

Running the versatiles command will list all available commands:

Usage: versatiles <COMMAND>

Commands:
  convert  Convert between different tile containers
  probe    Show information about a tile container
  serve    Serve tiles via http

Examples

Convert Tiles

Convert between different tile formats:

versatiles convert --tile-format webp satellite_tiles.tar satellite_tiles.versatiles

Serve Tiles

Serve tiles via HTTP:

versatiles serve satellite_tiles.versatiles

Additional Information

For more details, guides, and advanced usage, please refer to the official documentation.

Note on Development and Documentation

Please note that this project is under heavy development, and the documentation may not always be up to date. We appreciate your understanding and patience as we work to improve Versatiles. If you encounter any issues or have questions, feel free to open an issue or contribute improvements to our code or documentation.

Commit count: 1187

cargo fmt