versatiles 3.0.2

A toolbox for converting, checking and serving map tiles in various formats.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

# versatiles

A Rust library and CLI for reading, writing, and converting map tiles.

[![Crates.io](https://img.shields.io/crates/v/versatiles)](https://crates.io/crates/versatiles)
[![Documentation](https://docs.rs/versatiles/badge.svg)](https://docs.rs/versatiles)

## Overview

VersaTiles provides both a command-line interface and a Rust library for working with map tile containers in various formats including MBTiles, PMTiles, VersaTiles, TAR, and directory structures.

## As a CLI Tool

For CLI usage, installation instructions, command documentation, and production deployment guides, see the main [VersaTiles README](https://github.com/versatiles-org/versatiles-rs).

The CLI provides commands for:
- **`convert`**: Convert between tile formats
- **`probe`**: Inspect tile containers
- **`serve`**: Run an HTTP tile server
- **`dev`**: Development server with hot reload

## As a Library

The `versatiles` crate can be used as a library to integrate tile processing into your Rust applications.

### Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
versatiles = "2.3"
```

### Example

```rust
use versatiles::{
    container::*,
    core::*,
};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let runtime = TilesRuntime::default();
    let reader = runtime.get_reader_from_str("input.pmtiles").await?;

    // Define the output filename
    let output_path = std::env::temp_dir().join("output.versatiles");

    // Write the tiles to the output file
    runtime.write_to_path(reader, &output_path).await?;

    println!("Tiles converted successfully!");
    Ok(())
}
```

## Features

- **`cli`** (default): Command-line interface
- **`server`** (default): HTTP tile server
- **`gdal`** (optional): GDAL raster support for reading GeoTIFF and other raster formats

## Component Crates

VersaTiles is built from several focused crates that can be used independently:

- [`versatiles_core`](https://crates.io/crates/versatiles_core): Core types and utilities (coordinates, formats, traversal)
- [`versatiles_container`](https://crates.io/crates/versatiles_container): Tile container I/O (read, write, convert)
- [`versatiles_geometry`](https://crates.io/crates/versatiles_geometry): Geometric data structures (GeoJSON, MVT)
- [`versatiles_image`](https://crates.io/crates/versatiles_image): Image processing (PNG, JPEG, WEBP, AVIF)
- [`versatiles_pipeline`](https://crates.io/crates/versatiles_pipeline): Tile processing pipelines (VPL language)
- [`versatiles_derive`](https://crates.io/crates/versatiles_derive): Procedural macros (internal use)

## Documentation

- **Library API**: [docs.rs/versatiles](https://docs.rs/versatiles)
- **CLI Documentation**: [GitHub README](https://github.com/versatiles-org/versatiles-rs)
- **Full Documentation**: [docs.versatiles.org](https://docs.versatiles.org/)

## Supported Formats

- `.versatiles` - Native VersaTiles container format
- `.mbtiles` - MBTiles (SQLite-based)
- `.pmtiles` - PMTiles (cloud-optimized)
- `.tar` - TAR archives
- Tile directories

## License

MIT License - see [LICENSE](https://github.com/versatiles-org/versatiles-rs/blob/main/LICENSE) for details.