Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/versatiles-org/versatiles-rs
VersaTiles - A toolbox for converting, checking and serving map tiles in various formats.
https://github.com/versatiles-org/versatiles-rs
map openstreetmap rust tiles vector-tiles
Last synced: 3 days ago
JSON representation
VersaTiles - A toolbox for converting, checking and serving map tiles in various formats.
- Host: GitHub
- URL: https://github.com/versatiles-org/versatiles-rs
- Owner: versatiles-org
- License: mit
- Created: 2023-01-25T17:15:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T09:40:04.000Z (7 months ago)
- Last Synced: 2024-05-22T13:21:55.416Z (7 months ago)
- Topics: map, openstreetmap, rust, tiles, vector-tiles
- Language: Rust
- Homepage: https://versatiles.org
- Size: 26.2 MB
- Stars: 49
- Watchers: 2
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://crates.io/crates/versatiles)
[](https://crates.io/crates/versatiles)
[](https://codecov.io/gh/versatiles-org/versatiles-rs)
[](https://github.com/versatiles-org/versatiles-rs/actions/workflows/ci.yml)
[](LICENSE)
[](https://matrix.to/#/#versatiles:matrix.org)
**Table of contents:**
- [Installation](#installation): [Linux](#linux), [MacOS](#macos), [NixOS](#nixos), [Docker](#docker), [using `cargo install`](#building-locally-using-cargo-install), [from source](#building-from-source)
- [Usage](#usage): [convert tiles](#example-convert-tiles), [serve tiles](#example-serve-tiles)
# VersaTiles
VersaTiles is a Rust-based project designed for processing and serving tile data efficiently. It supports multiple tile formats and offers various functionalities for handling tile data.
# Installation
## Linux
Use the [installation script](https://github.com/versatiles-org/versatiles-rs/blob/main/helpers/install-unix.sh) to download the correct [precompiled binary](https://github.com/versatiles-org/versatiles-rs/releases/latest/) and copy it to `/usr/local/bin/`:
```shell
curl -Ls "https://github.com/versatiles-org/versatiles-rs/raw/main/helpers/install-unix.sh" | bash
```
## MacOS
Install VersaTiles using [Homebrew](https://github.com/versatiles-org/versatiles-documentation/blob/main/guides/install_versatiles.md#homebrew-for-macos):
```shell
brew tap versatiles-org/versatiles
brew install versatiles
```
## NixOS
VersaTiles is available via nixpkgs beginning with 24.05. An up to date version is part of nixpkgs-unstable.
For installation add following snippet into your [configuration.nix](https://nixos.org/manual/nixos/stable/#sec-configuration-file):
```shell
environment.systemPackages = with pkgs; [ versatiles ];
```
You can also use versatiles via [shell environments](https://nixos.wiki/wiki/Development_environment_with_nix-shell):
```shell
{ pkgs ? import {} }:
pkgs.mkShell {
buildInputs = with pkgs; [
versatiles
];
}
```
Additional information can be found at [Nix search](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=versatiles).
## Docker
Pull the prepared [Docker Images](https://github.com/versatiles-org/versatiles-docker) for easy deployment:
```shell
docker pull versatiles-org/versatiles
```
## Building locally using `cargo install`
You need [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Just run:
```shell
cargo install versatiles
```
## Building from source
Ensure you have [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html) installed. Then, run:
```shell
git clone https://github.com/versatiles-org/versatiles-rs.git
cd versatiles-rs
cargo build --bin versatiles --release
cp ./target/release/versatiles /usr/local/bin/
```
# Usage
Running the `versatiles` command will list all available commands:
```
Usage: versatiles [OPTIONS]
Commands:
convert Convert between different tile containers
probe Show information about a tile container
serve Serve tiles via http
help Show detailed help
```
## Example: Convert Tiles
Convert between different tile formats:
```shell
versatiles convert --tile-format webp satellite_tiles.tar satellite_tiles.versatiles
```
## Example: Serve Tiles
Serve tiles via HTTP:
```shell
versatiles serve satellite_tiles.versatiles
```
# Repository Structure
## Code
- **/versatiles/** - Main library and binary.
- **/versatiles_container/** - Reading and writing tile containers like `*.versatiles`, `*.mbtiles`, `*.pmtiles`, etc.
- **/versatiles_core/** - Core data types, utilities, and macros.
- **/versatiles_derive/** - Handles derive macros.
- **/versatiles_geometry/** - Manages geometry data, including OSM data, GeoJSON, vector tiles, etc.
- **/versatiles_image/** - Handles image data (PNG, JPEG, WEBP) and image processing.
- **/versatiles_pipeline/** - Manages "VersaTiles Pipelines" for fast tile processing.
## Helpers
- **/docker/** - Contains a Dockerfile for building Linux binaries.
- **/helpers/** - Shell scripts for checking, building, and releasing.
- **/testdata/** - Files used during testing.
# Additional Information
For more details, guides, and advanced usage, please refer to the [official documentation](https://github.com/versatiles-org/versatiles-documentation).
# Development and Contribution
VersaTiles is under active development, and the documentation may not always be up to date. We appreciate your understanding and patience. If you encounter any issues or have questions, feel free to open an issue or contribute to our [code](https://github.com/versatiles-org/versatiles-rs) or [documentation](https://github.com/versatiles-org/versatiles-documentation).
# License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.